Snarkpit Forum Index » Articles & Downloads » [article] Basic Map Readme File
[article] Basic Map Readme File
1
Post Reply
Quote
 Re: [article] Basic Map Readme File
Posted by Gwil on Mon Nov 1st at 2:08am 2004


This is a discussion topic for the article "Basic Map Readme File" by Gwil which can be found here

Article description:

Often overlooked, but essential, and nice "polish"






Quote
 Re: [article] Basic Map Readme File
Posted by Orpheus on Mon Nov 1st at 2:10am 2004

I have read some pretty lame "readme txt" included with a map before.. almost makes you wonder, if they put as much effort into the map itself..

we needed one of these, for the new mappers.. but i prefer my old "radium" version, ALL of my maps have one. smiley



Quote
 Re: [article] Basic Map Readme File
Posted by Crono on Mon Nov 1st at 7:46am 2004

The order is a little odd ...

It should be something like:

File Info
Level Description
Installation
Bugs
Secrets
Acknowledgment (includes textures, models, and music)
Copyrights

Maybe, bugs and secrets can be swapped, but overall, this is a more organize (easier to follow) order.

It goes:

Properties > Technical > Credit > Copyright

As opposed to:

Properties > Credits > Properties > Credits > Technical > Copyright.

Seem reasonable? smiley



Quote
 Re: [article] Basic Map Readme File
Posted by Hugh on Mon Nov 1st at 9:59am 2004

I agree, the order is a little funky, plus I don't see how compile time becomes something that the player of the map really needs to know about, especially if the specs of the compiling machine isn't listed in the template.

Anyway, it's good to have for people who don't already have one of the many billions of map templates.



Quote
 Re: [article] Basic Map Readme File
Posted by Gwil on Mon Nov 1st at 2:14pm 2004

Fair enough either way - like I say, it's not so much a tutorial, more a means for those who don't know how to do Readmes, and to emphasise their importance with releasing a map smiley

I'll have a dabble with it



Quote
 Re: [article] Basic Map Readme File
Posted by Orpheus on Mon Nov 1st at 2:25pm 2004

If its any help, use one of mine as a base of comparison gwil.. but i would like to point out to everyone.. a readme txt is not set in stone, they are fully editable to ones own taste.. gwil offers a template.. make it suit yourself and leave his version alone smiley



Quote
 Re: [article] Basic Map Readme File
Posted by pepper on Tue Nov 2nd at 11:41am 2004

Ah, very helpfull, its always one of the things that go wrong wiht me:)



Quote
 Re: [article] Basic Map Readme File
Posted by fishy on Tue Nov 2nd at 4:58am 2004

Maybe stick in an 'Other maps by author' field.
If someone likes the map that the readme is for, they might like to check out more from the same source.



Quote
 Re: [article] Basic Map Readme File
Posted by Foxpup on Mon Nov 29th at 3:01am 2004

Pretty good, but you shouldn't put easter eggs/secrets/spoilers in the readme: finding them for yourself adds to the fun of the map.



Quote
 Re: [article] Basic Map Readme File
Posted by Jozodezokokotar on Wed Jun 30th at 7:59am 2010

I can't get the textfile, download link seems broken.



Quote
 Re: [article] Basic Map Readme File
Posted by Riven on Thu Jul 1st at 5:21pm 2010

I just got through checking our archives, and I couldn't locate the file anywhere. It was posted back when SnarkPit was still a .com address, and all content from that site was transferred manually by owner, so he may have left some things out.

However, the member who posted this article may have this file, and he tends to be a regular lurker (when not posting), so I'll see if he still has it.


Blog: www.playingarchitecture.net
LinkedIn: Eric Lancon
Twitter:@Riven202




1
Post Reply