Module:Tileset/doc

From NetHackWiki
Jump to navigation Jump to search

This is the documentation page for Module:Tileset

This module aims to produce an image map for a tileset hosted on NetHackWiki. Parameters are provided for the dimensions of the tiles.

Parameters are:

  • The image used for the tileset. This is required, and should link to an image.
  • A description. This can be blank.
  • The version or variant of NetHack that the tileset supports. This is required. Currently valid strings are:
    • NetHack 5.0.0
    • NetHack 3.6
    • NetHack 3.4
  • The width in pixels of each tile. This is required, and must be a positive integer.
  • The height in pixels of each tile. This is optional. If provided, it must be a positive integer. If omitted, it is equal to the width.
  • The number of tiles in each row. This is optional. If provided, it must be a positive integer. If omitted, it defaults to a value dependent on the version parameter. For all currently supported versions, the default number of tiles per row is 40.

Usage

Source Description
{{#invoke:Tileset|tileset|Image:nhtiles-500-16x16.png|Default tileset for 5.0|NetHack 5.0.0|16|16|40}} Produces the image map for the bundled tileset for NetHack 5.0.
{{#invoke:Tileset|tileset|Image:Nevanda 5.0.0 v2 32x32.png|Nevanda tileset for 5.0, version 2|NetHack 5.0.0|32}} Produces the image map for the Nevanda tileset for NetHack 5.0.