*.map & *.pk3 naming standard?

Post by **Bjarne BZR** » Tue Apr 01, 2003 10:50 pm

Is there a standard on how to name *.map and *.pk3 files?
A quick net search gave nothing... I've noticed a few things about naming:

1) Once you release a file on the Internet, you'r screwed. You are too late to change the name after that. So select the name VERY carefully.
2) New versions may cause you trouble, if your map is not named properly.

So I thought we'd cook up a standard here and now. This is not to be a control freak, its to avoid as much unessesary problems as possible.

My start suggestion for *.bsp files:

Mr BZR wrote:<GAMETYPE>_<MAPNAME>_<VERSION>.bsp

Example: obj_beach_battery_1.2.bsp

<GAMETYPE> = obj, dm, tow, ctf or any other kind of ctazy game type.
<MAPNAME> = Shortest possible name.
<VERSION> = Major and minor version ( 1.0 -> 1.1 for small change, 1.1 -> 2.0 for big change )

My start suggestion for *.pk3:s:

Mr BZR wrote:user-<GAMETYPE>_<MAPNAME>_<VERSION>.pk3

Example: user-obj_beach_battery_1.2.pk3

<GAMETYPE> = obj, dm, tow, ctf or any other kind of ctazy game type.
<MAPNAME> = Shortest possible name.
<VERSION> = Major and minor version ( 1.0 -> 1.1 for small change, 1.1 -> 2.0 for big change )

... so why?
<GAMETYPE> because soon you will realize how easy it is to make a map of another type once you made a map of another type... BUT you must change the maps mame for stuff like loadscreens to work.
<MAPNAME> because... I don't have to explain that one do I?
<VERSION> because when you release a new version, there is no way to separate the versions... you can enter a server using the wrong map version, and usually get VERY wierd things happening ( Doors replaced by spinning barres, and stuff like that ).

I also suggest a naming standard for readme files:

Mr BZR wrote:user-<GAMETYPE>_<MAPNAME>_<VERSION>_readme.txt

Example: user-obj_beach_battery_1.2_readme.txt

<GAMETYPE> = obj, dm, tow, ctf or any other kind of ctazy game type.
<MAPNAME> = Shortest possible name.
<VERSION> = Major and minor version ( 1.0 -> 1.1 for small change, 1.1 -> 2.0 for big change )

...this way you can easily find the readme to tell someone an error or send them love letters, because the readme will be located next to the *pk3 in main, because it has an almost identical name ( and wont be overwritten by the next map you install's readme file ).

So? What do you guys think? You must have run into problems with naming... at least you experienced mappers...

ZeroSkaten · Post by **ZeroSkaten** » Tue Apr 01, 2003 10:54 pm

lol

it hasn't happened to me... yet.

Post by **Surgeon** » Tue Apr 01, 2003 11:34 pm

There was a move by aa.com and TMT to standardize mods/maps and skins naming standards. I don't know how successful it was but it runs along the same lines as you have suggested. Personally I'm all for it so long as everyone remembers to do it and spreads the word also.....

I'm also thinking of writing a small tut on the conventions of writing a readme.txt file to go with your maps....mainly because these things should be fairly standard to...

ZeroSkaten · Post by **ZeroSkaten** » Tue Apr 01, 2003 11:37 pm

ooo i agree with you, i just got cunfused at first

Post by **Bjarne BZR** » Wed Apr 02, 2003 12:13 am

Surgeon wrote:I'm also thinking of writing a small tut on the conventions of writing a readme.txt file to go with your maps....mainly because these things should be fairly standard to...

You are thinking tha same way as I! That was ny next thing after the map names

The way I thought the map/pk3 naming standard is that I dont give a rats ass if mappers follow it, but if they DO follow it, they'll get out of a lot of trouble that other mappers have gone through before them... and following a standard is easy for you and easy for your users...

I'll put together a tutorial on the subject; so all of you: tell me what you think!

nuggets · Post by **nuggets** » Wed Apr 02, 2003 12:18 am

good plan batman!!!

can i also suggest using the mod in the title name as well... although i haven't mentioned it b4 i'm actually part of a modding team, and would hate to see this recognition unrecognised...

good work to all the people who have worked, and keep working to all the people who are working... to the people who are doing nothing however... ermmm... just... well... ermmm... well done

Post by **Bjarne BZR** » Wed Apr 02, 2003 12:35 am

Yes, the mod name ( if any ) could be part of the *.pk3 name... but not, in my opinion, a part of the map name...
Or maby the readme and the loadscreen is enough to inform of the mod team?

Post by **Bjarne BZR** » Wed Apr 02, 2003 1:59 am

I made a tutorial on a file naming standard:

http://www.planetmedalofhonor.com/rjuka ... orial.html

Read it and see what you think...

ZeroSkaten · Post by **ZeroSkaten** » Wed Apr 02, 2003 2:03 am

nice

mohaa_rox · Post by **mohaa_rox** » Wed Apr 02, 2003 5:17 am

Anyone believes that i can make a map with notepad? Basic one maybe.

Post by **Surgeon** » Wed Apr 02, 2003 10:28 am

ahh the old notepad mapping...its a pain in the ass though trying to figure out brush coordinates.........

Post by **Bjarne BZR** » Wed Apr 02, 2003 11:08 am

mohaa_rox wrote:Anyone believes that i can make a map with notepad?

You did not bother reading the subject line, did you? What were you thinking rox?

Post by **jv_map** » Wed Apr 02, 2003 3:27 pm

Not sure if I'm in favour of a dot in the filename

Post by **Bjarne BZR** » Sat Apr 05, 2003 12:25 am

jv_map wrote:Not sure if I'm in favour of a dot in the filename

Why?

Post by **jv_map** » Sat Apr 05, 2003 6:38 am

Not sure if all browsers and filesystems (e.g. mac) understand it

.

Sorry if this is a stupid doubt

.Map :: MoHAA Mapping

.map & .pk3 naming standard?

.map & .pk3 naming standard?