Map filename convention

Skunk Monkey · August 21, 2002

B - no space in the tag.

tags: co, ctf, c&h, a&d,...

Looking like the A's have it so far ...

terox · July 4, 2002

I will leave it running till the weekend, then this particular part of the discussion (spaces) will be closed thank god!

terox · July 4, 2002

The spaces argument is finally ended

System A is to be used

ctf@ 34 mymapname

Now just 1 other little problem

co

or

coop Â

makes no difference to me

I think coop is a bit more obvious and self explanatory

I go with coop

Lets vote and get this sorted then i can post a beta convention template post

wow we are nearly there

benu · October 13, 2001

co

Goeth · February 28, 2002

co

-TNF-Steiner · January 15, 2003

co

joltan · February 23, 2002

co - as most already expressed when they were voting on the space...

Goeth · February 28, 2002

Maybe itÂ´s time to end this so people could start working.

joltan · February 23, 2002

<table border="0" align="center" width="95%" cellpadding="3" cellspacing="1"><tr><td>Quote (Goeth[kyllikki] @ Jan. 21 2003,17:03)</td></tr><tr><td id="QUOTE">Maybe itÂ´s time to end this so people could start working.

Yes, I think it's clear from the votes so far: 'co' is it, and the space before the number of players. I think we're finished. The '&' was to be used, right? Or do we need a seperate vote on that, too?

Goeth · February 28, 2002

I also though the "&" was agreed. At least i agree on that.

Skunk Monkey · August 21, 2002

Looks all done to me ...

Terox - time for your final summing up and hopefully a mod will close the thread - anyone not stated there opinion in last 3 months can keep it to themselves.

terox · July 4, 2002

Great

The co's have it

I will post the full convention this weekend for checking

As we mentioned earlier, have a look through it, make sure there is nothing open for misinterpretation, its nice and compact etc, then when its all nice and tidy etc, we will open a new thread, post the convention as the start post and any post that follows it is simply to state

X server is using the convention

X league is using the convention

I will also try to get OFPEC to post the convention somewhere suitable, and Avonlady and any other community site etc etc

terox · July 4, 2002

By the way has anyone got any experience with a cti (Capture the Island) type map

Does it need its own tag or is it a ctf or some other map type.

I have never played a cti, so i dont know anything about them

joltan · February 23, 2002

<table border="0" align="center" width="95%" cellpadding="3" cellspacing="1"><tr><td>Quote (Terox @ Jan. 23 2003,00:52)</td></tr><tr><td id="QUOTE">By the way has anyone got any experience with a cti (Capture the Island) type map

Does it need its own tag or is it a ctf or some other map type.

Its basically an RTS map, isn't it? You build units and bases, you have to destroy the other teams base and construction vehicle, etc. Not CTF or C&H, but real RTS. As there are other RTS maps (by Karillion), we should just put them all together and use the RTS tag.

terox · July 4, 2002

Ok here goes.

The following posts will be restarted in a new thread and they are for information purposes only, with any replys merely being to say XXX of YYY server supports and uses the convention

##########################################################

Multiplayer Map Filename Convention (Thread Title)

##########################################################

Post 1

Introduction and aims

INFORMATION ONLY THREAD

Please dont start a discussion

The following filename convention is intended for global use Â within the OFP Community

Its aims are

1) To create an easily navigable and organised map listing system

2) To be simple and informative

3) To reduce multiple downloads of the same map from various server due to a small filename difference

4) To set a standard map filename for future mappers to use

(Thanks must go to)

Itchy, Kegetys, whisperFFW06, Â Lt_Damage, nierop, Â benu, zinco, JRMZ, Â oo7vet, Â KaRRiLLioN, eisa01, Goeth[kyllikki], Shrike, Â HellToupee, Â MadDogX, Â peanuckle_00, morteni55, [TNF]Steiner.

Special thanks goes too Skunk Monkey and joltan for their unrelenting vigilence throughout the 3 month discussion)

Important

Please only reply to the thread to state

1)Your name

2) Who you represent

and a basic statement eg "We support and use the convention"

##########################################################

Post 2

Filename Template

Example of some filenames

ctf 24 riverdance v1

ctf@ 32 armourgheddon beta 1.1

c&h 30 one road v2

tdm 12 deathvalley beta 1.6

c&h@ 24 deliverence v1

c&h 24 efl_malden v1

Â Â Â Â Â Â Â Â Â Â ******** Â Subgroups Â ********

The filename has been split up into the following subgroups

MAP TYPE Â Player Limit Â MAPNAME Â VERSION

Â Â ctf Â Â Â Â 10 Â Â Â Â Â tigerland Â Â v1

= ctf 10 tigerland v1

Â Â Â Â Â Â Â Â Â Â ******** Â MAP TYPE Â ********

The following abbreviations are to be used

a&d Â - Â (Attack & defend)

co Â Â - Â (Cooperative)

ctf Â Â Â - Â (Capture the Flag)

c&h Â Â - Â (Capture and hold)

rc Â Â Â - Â (Race)

tdm Â - Â (Team Deathmatch)

dm Â Â - Â (Death Match)

ff Â Â Â - Â (Flagfight)

tff Â Â Â - Â (Team Flag Fight)

e&e Â Â - Â (Escape & Evasion)

rts Â Â Â - Â (Real Time Strategy)

misc Â - Â (Miscellaneous) not belonging to a map type)

@ Â Â Â - Â DENOTES ADDON USED

If the map uses any addons at all, in addition to the BIS standard addons that came with the various patches, the Tag "@" is to be attached to the end of the maptype abbreviation

eg Â ctf@

eg Â c&h@

eg Â co@

I will try to keep this updated as further map types evolve

Â Â Â Â Â Â Â Â Â Â ******** Â PLAYER LIMIT Â ********

This should simply be the maximum player limit only

not 2_22, just simply 22

Â Â Â Â Â Â Â Â Â Â ******** Â MAP NAME Â ********

LEAGUE MAPS

If the map is an official league map, then the name itself should be preceded by the league tag

Example of a Euroleague tag

efl

and incorporated into the name

c&h 24 efl nogova v1

(DO NOT Â alter the filename of official league maps, Â approach the league, explain about this convention, and if they are willing to support the convention, they will release new maps with the altered names)

Map name in general

Ideally the name should not include the creators tag, a server tag or anything else that would clutter it up.

This type of information can and should be added to the briefing html file by the mapmaker

Â Â Â Â Â Â Â Â Â Â ******** Â Version Â ********

Existing Maps

Any mapnames that already have existing version numbers, should be left in their original state, no modifications should be made to them or a version number added to them, if none exist. The only exception is of moving them to the correct location, eg the last subgroup location)

New Maps

The following system is recommended not compulsory

Lets look at the development of a map from beta to finished version

1) Map released onto a server for first time to beta test

ctf@ 32 swampland beta 1.00

2) A few bugs removed and map uploaded again

ctf@ 32 swampland beta 1.01

3) A few more improvements

ctf@ 32 swampland beta 1.02

4) A few more improvements

ctf@ 32 swampland beta 1.03

5) Beta 1.3 is bug free and finished

so its renamed and becomes

ctf@ 32 swampland v1.0

6) A new game patch is released, with some extra weapons

the map maker upgrades his map

ctf@ 32 swampland beta 2.00

7) No bugs are evident, and it becomes a finished version

Its renamed

ctf@ 32 swampland v2.0

8) Somebody decides to hack the map and change some things

(simply add a letter or tag to the end of the version number so we know its is not of original origins)

ctf@ 32 swampland beta 1.0 zeus

or

ctf@ 32 swampland beta 1.0(z)

something to non conform to the recommended version number, to indicate it is not an original mapmaker release

In General

1) Leave exisiting version numbers intact

2) Use beta 1.0 (To maximum of 2 decimal place) for beta maps

3) Use v1 (to 2 decimal places maximum) for a finished map version

4) For a major map version jump, increase the number before the decimal

_

Â Â Â Â Â Â Â Â Â Â ******** Â General Guidelines Â ********

General set up

1)A space must exist between each subgroup

2) lower case must be used for linux compatibility

3) It is the admins responsibility to modify map names on his server

4) No deviation from the convention sub groups "maptype or player limit" should be allowed under any circumstances

5) BIS maps that are installed during game installation are required in their original format when upgrading with new patches (Deal with these how you see fit)

If you are going to rename them, then keep a backup copy in a folder for easy re-installation

6) Under no circumstances are underscores to be used

ADDONS

As previously stated, the "@" tag is to be added to the end of the maptype subgroup to indicate that the map uses an additional addon to that of the standard BIS addons that come with the various patches.

Any addon that a server supports and is included in their server maps, should be available in a server "Map Pack" and should not have a tag added to the filename by the server admin.

If the mapmaker has added something to the "MAPNAME" subgroup, then it should be left there

LINUX

1) lower case has been used as standard, for linux compatibility

2) Spaces If spaces in the filename are causing a problem for your md5 scripts their is a workaround for it

(Need a link placing here)

"The md5 thing": Unix uses spaces as separators for lists. Using spaces in filenames breaks many scripting possibilities as space separated lists don't work anymore.

There is a way of getting around some of those limitations by using xargs. Printing ONE script that does something with md5sum would not help much. People have to take care and not use space separated lists in their scripting and use filename globbing and find -print0 and xargs whenever possible/needed.

Here is one example :

<table border="0" align="center" width="95%" cellpadding="3" cellspacing="1"><tr><td>Code Sample </td></tr><tr><td id="CODE">

md5sum *.pbo | sort | uniq -d --check-chars=33 | cut -f 3- -d " " | xargs -i mv \{\} dup/\{\}

which moves duplicate maps to a folder called dup.

_

Below is a screenshot of the finished system as seen in the map selection screen

************image here************

(Need to ask the admins on this server to upload a jpeg of the screenshot, so that it is always available for view)

The discussion (19 pages of it) which is now closed can be found at the following link

Filename discussion

terox · July 4, 2002

I need somebody to post an explanation, in its own thread about the linux md5 workaround, so that i can link to it from the above pre release post when it is posted into its own thread

I need input for the "wording" and set out of the post

There should be no disagreements about the content

hope thgis does it

Thanks for all the effort, help and advice that has brought us to this point

joltan · February 23, 2002

Sounds good - the only things I see a bit problematic is dictating the map makers to use integers for finished map versions and limiting the decimals for beta maps to one. Often a small change/update does not justify raising the version number for a whole number, while a major rework of a map might do. I think most mission makers use up to 2 decimals - regardless of the map being beta or not. The 'beta' already makes it very clear that a mission is still not considered finished by its creator.

Therefore I'd change this:

<table border="0" align="center" width="95%" cellpadding="3" cellspacing="1"><tr><td>Quote </td></tr><tr><td id="QUOTE">1) Leave exisiting version numbers intact

2) Use beta 1.0 (To 1 decimal place) for beta maps

3) Use v1 (An integer) for a finished map version

to

<table border="0" align="center" width="95%" cellpadding="3" cellspacing="1"><tr><td>Quote </td></tr><tr><td id="QUOTE">1) Leave exisiting version numbers intact

2) Use the 'beta' prefix for the version number for beta maps

3) Do not use more than two decimals (like 'v1.25') in your version number

4) Indicate major update by raising the version number to the next FULL number (i.e. V1.53 -> V2.0)

benu · October 13, 2001

Terox: There is an underscore in your posting again (efl_). Afaik we decided against mixing of spaces and underscores. "ctf@ 32 efl_name of map" just looks plain silly with one underscore and the rest spaces.

"The md5 thing": As i pointed out unix uses spaces as separators for lists. Using spaces in filenames breaks many scripting possibilities as space separated lists don't work anymore. As Kegetys said there is a possibility getting around some of those limitations by using xargs. Printing ONE script that does something with md5sum would not help much. People have to take care and not use space separated lists anymore in their scripting and use filename globbing and find -print0 and xargs whenever possible/needed. If you want only one example take the one Kegetys provided somewhere earlier in this thread:

<table border="0" align="center" width="95%" cellpadding="3" cellspacing="1"><tr><td>Code Sample </td></tr><tr><td id="CODE">

md5sum *.pbo | sort | uniq -d --check-chars=33 | cut -f 3- -d " " | xargs -i mv \{\} dup/\{\}

which moves duplicate maps to a folder called dup.

eisa01 · February 25, 2002

why am i in thanks to section Â i just posted something about addons which noone replied to and i get in the thanks to section??? im not running a server either, i just play. Why me in there??

terox · July 4, 2002

Convention amended

1) Removed underscore and added Underscore should not be used under any circumstances

2) Amended Version section to recommend up to 2 decimal places

Anybody who has voiced an opinion on the thread has been thanked, thats why your name has been added to the list

What i asked, was for somebody to post an explanation of what to do with MD5 scripting, in its own thread on the flashpoint 1985 forums, so that I could place a link to it in the linux section of the convention. Which would also allow a full discussion in its own thread on that one issue

(Although i admin a linux server, i dont know diddly about md5 scripting and didnt want to put something in the convention thread that may not have been accurate

joltan · February 23, 2002

Thanks for your efforts, Terox!

Just finished renaming our 260 missions... The SES server will switch soon to the new filename convention.

benu · October 13, 2001

Terox: I still did not understand what explanation/description exactly you need regarding md5. md5sum generates a checksum for a given file, which should be equal for equal files and different for different files. So you can eg check downloaded files if they are correct by comparing your checksum with the one the author gave on his site. Or if files have been modified during a patch. Or if any 2 (or more) maps with different names are actually the same map with different names or different maps. HTH. As soon as all things are settled i will rename all my maps too.

terox · July 4, 2002

Ok as for md5 scripting.

I dont know anything about this at all

I dont understand it, so i am not able to explain it, all i need is somebody say to post the explanation for me and a work around solution of the problems that spaces can cause in MD5 scripting

like the following

<table border="0" align="center" width="95%" cellpadding="3" cellspacing="1"><tr><td>Quote </td></tr><tr><td id="QUOTE">

cut n paste following

-------------------------------

blah blah blah blah

end of explanation

-------------------------

then i can simply insert it into the "Linux" section of the convention post

terox · July 4, 2002

Ok I have updated the convention with an explanation that hopefully makes sense for the spaces argument in linux

The only thing that has changed is a small paragraph in the Linux section.

Trusting this is now totally agreeable, i will create a new thread over the weekend in its own right, post something on OFPEC linking too it and mail some other sites, i would greatly appreciate it if everybody who has helped with this can spread the word to the various dedicated servers league sites etc

Thanks a lot guys and well done!!!!!

Skunk Monkey · August 21, 2002

Well I think its you who deserver the thanks Terox .. and now we just got to hope that most of the OFP community will adopt this univerally agreed system.

Map filename convention

Recommended Posts

Skunk Monkey 0

Share this post

Link to post

Share on other sites

terox 316

Share this post

Link to post

Share on other sites

terox 316

Share this post

Link to post

Share on other sites

benu 1

Share this post

Link to post

Share on other sites

Goeth 0

Share this post

Link to post

Share on other sites

-TNF-Steiner 0

Share this post

Link to post

Share on other sites

joltan 0

Share this post

Link to post

Share on other sites

Goeth 0

Share this post

Link to post

Share on other sites

joltan 0

Share this post

Link to post

Share on other sites

Goeth 0

Share this post

Link to post

Share on other sites

Skunk Monkey 0

Share this post

Link to post

Share on other sites

terox 316

Share this post

Link to post

Share on other sites

terox 316

Share this post

Link to post

Share on other sites

joltan 0

Share this post

Link to post

Share on other sites

terox 316

Share this post

Link to post

Share on other sites

terox 316

Share this post

Link to post

Share on other sites

joltan 0

Share this post

Link to post

Share on other sites

benu 1

Share this post

Link to post

Share on other sites

eisa01 0

Share this post

Link to post

Share on other sites

terox 316

Share this post