The readme.txt, should you decide to include it with your map should contain useful information about your map as well as information about essential files needed to play the map. The format of the readme.txt can also be used as the format for announcing maps on message boards since it helps to give the players an overview of what the map is about and if it suits his/her playing style.
Below I wish to present a basic and (hopefully) informative enough readme.txt format.
Map Name: [The full name of the map)]
Map Maker(s): [your name(s)]
E-Mail Address: [your e-mail address]
(Note: it is useful to include e-mail addresses because some people prefer to give private feedback rather than posting them up)
Map Type: [Multiplayer/Single player/PBEM]
Map Size: [Small, Medium, Large, Extra-Large; underground levels]
Map Level of Difficulty: [Easy--Impossible]
Map Version: [1.0]
Language: [English or other languages]
Storyline/Background: [What you wrote in the Introduction of the map.]
No of playable races: [how many?]
Playable races: [what are they?]
Non-playable races: [what are they?]
Important Special Notes: (Note: do not include if not required)
Flies required to play this map: [Mod rules required? If so, what is the name of the mod.]
Other winning conditions: [such as Capture location and accumilate gold/mana conditions.]
Other files required: [what they are.]
(Note: It may also help to include links or e-mail so that the player knows where to get them. Do not forget to include a little bit on how to install the special files if they are needed.)
Additional (or other optional) information:
- Type of map (RPG? Single player? Slugfest? Multiplayer? PBEM?)
- Best played at which difficulty settings.
- Hints (leave a couple of empty lines, include a warning that a possible spoiler is included at the last section of your readme.txt.
(Note: This is where you may include other stuff which you want the player to know. Add your boasts here: anything special to highlight, how many items you created, how many heros and other innovations.