README- mapname revM.mm.txt

From Bots-United Wiki

Jump to: navigation, search

Below is the suggested readme file format for inclusion when releasing waypoints. This readme can be of great help to the FritzBot archivists or when more than one waypointer gets involved in a project.

TERMINOLOGY
WIP means Work In Progress.
BETA means not-for-general-release but playable for community testing and feedback
BRANCH means that the work is a variation of an existing work/project (just for evaluation typically)
Snapshot is a grab of all the working files

Text in the form appearing inside angle brackets < > can be replaced with search and replace in a text editor. Text in the form between square brackets [ ] is optional and can be omitted. Text after // are just comments on how to fill in this form.

And here is the form;

FILENAME: 
		<pk3_filename> //your pk3 filename in the fritzbot directory
REVISION:    
		<M.mm> [BETA][BRANCH <B.bb>] //M.mm, M major, m minor <B.bb>=branch rev
RELEASE DATE: 
		[WIP]/<Month XX, Year>
AUTHOR:      
		<your_Name>
MAP SITES:
		//Possible http: or ftp: address for downloading the map
		//Place mapper website first if known
DESCRIPTION: 
		For FritzBot Mod (0.70C) Play in RTCW Enemy Territory 2.60.  
		Bot AI and navs for the map <mapname>.  
		<FILL IN BRIEF MAP DESCRIPTION AND WAYPOINT HIGHLIGHTS...>
		<...(or detail them under [HIGHLIGHTS:]>

USAGE:       
             Find the map on the web and place the mapfile <mapname>.pk3 into 
             the directory \etmain.  Place this file <pk3_filename> into the 
             directory created by FritzBot (\fritzBot) overwriting any older versions.

             Select from the Start menu the map <mapname> [or the campaign <campaign_name>...]

                  -- OR --
             Open the console (`) and type  
                  \map <mapname>
                  -- OR --
             Create a short cut like (adjust path as required)
                 "C:\Program Files\Wolfenstein - Enemy Territory\ET.exe" +set fs_game fritzbot-dev +sv_pure 0 +g_gametype 2 +map <mapname> 
                  -- OR --
                "C:\Program Files\Wolfenstein - Enemy Territory\ET.exe" +set fs_game fritzbot-dev +sv_pure 0 +g_gametype 4 +campaign <campaign_name>

[HIGHLIGHTS:]
             [OPTIONAL-SELL-THE-MAP-TELL-THE-STORY]
             
CONTENTS:                         //edited from piped output of pkunzip -v <mapname>.pk3
 Length      Date     Time    Name
 ------      ----     ----    ----
   XXXX   XX-XX-2006  XX:XX   BOTS/SCRIPTS/<mapname>.aiscript
   XXXX   XX-XX-2006  XX:XX   BOTS/MAPS/<mapname>.nav

   XXXX   XX-XX-2006  XX:XX   CONFIGS/<mapname>.bots
    XXX   XX-XX-2006  XX:XX   CONFIGS/<mapname>.cfg

          XX-XX-2006          README-<mapname>_revM.mm.txt

    XXX   XX-XX-2006  XX:XX   SCRIPTS/<campaign_name>.campaign



CHANGES:
         0.02 - <PLACE ITEM BY ITEM CHANGES AS YOU THINK NEEDED HERE>
              - <TYPICALLY PREVIOUS BUGS AND TO DOS WHEN COMPLETED>  
         0.01 Initial WIP Beta snapshot - by <your_name> <Month XX, year>
         

KNOWN BUGS:
          (Tested on FritzBot rev. 0.70C)
         (1) <BE HONEST IT HELPS, ANYTHING SEEN AND CAPABLE OF BEING REPRODUCED>
         (2) <I SUGGEST NOT REUSING NUMBERS (in parenthesis) JUST ALWAYS COUNT UP>


TO DO:
        (5) <WHAT YOU WANT TO DO AND ARE LIKELY TO ATTEMPT>
        (7) <OR SUGGESTIONS YOU HAVE ACCEPTED TO INCLUDE/DO>

COPYRIGHTS:
NOTE THIS WAYPOINTING IS IN PART DEPENDANT UPON THE WORK OF THE ORIGINAL
MAPPER  <mapper's name>
Accordingly this work and any work derived from these files must include and 
respect the original copyright(s). (where applicable)

Permanent link to this page

Retrieved from "README-_mapname_revM.mm.txt"