Basic Map Readme File
by Gwil (view all articles)
unrated
Often overlooked, but essential, and nice "polish"
by Gwil (view all articles)
unrated
Often overlooked, but essential, and nice "polish"
This setup applies to HLDM mainly, but can work with other mods/games.
One of my personal pet hates is looking up map info, only to find the author did not include a readme. These are good ways to affiliate your name, and more importantly I find, spread the knowledge of good media resources (eg textures)
This is not so much a tutorial, more a template for people to use
Include readme's with all your maps!
Download the template >> http://www.snarkpit.com/pits/gwil/maptemplate.txt
File Info
---------------------------------------
Game : Game Name
Mod : Mod Name (if applicable)
Map Name : bsp name / official title (only necessary if youre being artsy fartsy to include the "official title"
Version : Final Version Number (if you logged version numbers)
Filename : filename.xxx
Author : Your Name Here
Email : Your Email Here
Website : Your Website URL(if applicable)
Build Time* : Hours spent creating the level
Compile Time* : Minutes/Hours/Days/Years (!) spent compiling the level
Level Description
--------------------------------------
Level info here - description of the setting, how it started/progressed as you made it, ideas which were scrapped, and failed. Try and make it short and succinct, but still worthy of a quick glance
Credits/Acknowledgements/Thanks
--------------------------------------
Playtesters, texture/sound/model creators, beta feedback, inspirations
Easter Eggs/Secrets*
--------------------------------------
Reveal easter eggs/secrets here - or, hint at what they are/how many there is in the map.
Known Issues/Bugs*
--------------------------------------
All known bugs (which hopefully have had at least ONE attempt to fix them - eg odd clip issues, dodgy shadows, whatever)
All known issues - more applicable to TFC/CS or other team based mod - Imbalances on the map can be listed here, as a warning (or disclaimer
)
Textures, Sounds and Models
--------------------------------------
Authors Name - filename - source name - availability (freeware/exclusive for example)
Installation Guide
--------------------------------------
Where, and how (eg Winzip) to install the map, and relevant attached files (models, sounds, textures etc)
Copyrights, legal blathering
--------------------------------------
You MUST NOT distribute this level UNLESS you INCLUDE THIS FILE WITH
NO MODIFICATIONS. If you don't co-operate, then DON'T DISTRIBUTE IT
IN ANY FORM.
or
Free to distribute anywhere/on any medium with authors express permission, and for non profit use.
Game name/company name, year of copyright. Also copyrights of your intellectual property if you wish, not sure how legally binding it is though.
N.B.
* = considered optional (in my opinion, at least)
One of my personal pet hates is looking up map info, only to find the author did not include a readme. These are good ways to affiliate your name, and more importantly I find, spread the knowledge of good media resources (eg textures)
This is not so much a tutorial, more a template for people to use
Include readme's with all your maps!
Download the template >> http://www.snarkpit.com/pits/gwil/maptemplate.txt
File Info
---------------------------------------
Game : Game Name
Mod : Mod Name (if applicable)
Map Name : bsp name / official title (only necessary if youre being artsy fartsy to include the "official title"
Version : Final Version Number (if you logged version numbers)
Filename : filename.xxx
Author : Your Name Here
Email : Your Email Here
Website : Your Website URL(if applicable)
Build Time* : Hours spent creating the level
Compile Time* : Minutes/Hours/Days/Years (!) spent compiling the level
Level Description
--------------------------------------
Level info here - description of the setting, how it started/progressed as you made it, ideas which were scrapped, and failed. Try and make it short and succinct, but still worthy of a quick glance
Credits/Acknowledgements/Thanks
--------------------------------------
Playtesters, texture/sound/model creators, beta feedback, inspirations
Easter Eggs/Secrets*
--------------------------------------
Reveal easter eggs/secrets here - or, hint at what they are/how many there is in the map.
Known Issues/Bugs*
--------------------------------------
All known bugs (which hopefully have had at least ONE attempt to fix them - eg odd clip issues, dodgy shadows, whatever)
All known issues - more applicable to TFC/CS or other team based mod - Imbalances on the map can be listed here, as a warning (or disclaimer
)
Textures, Sounds and Models
--------------------------------------
Authors Name - filename - source name - availability (freeware/exclusive for example)
Installation Guide
--------------------------------------
Where, and how (eg Winzip) to install the map, and relevant attached files (models, sounds, textures etc)
Copyrights, legal blathering
--------------------------------------
You MUST NOT distribute this level UNLESS you INCLUDE THIS FILE WITH
NO MODIFICATIONS. If you don't co-operate, then DON'T DISTRIBUTE IT
IN ANY FORM.
or
Free to distribute anywhere/on any medium with authors express permission, and for non profit use.
Game name/company name, year of copyright. Also copyrights of your intellectual property if you wish, not sure how legally binding it is though.
N.B.
* = considered optional (in my opinion, at least)
