OFPEC Forum

Editors Depot - Mission Editing and Scripting => OFP - Editing/Scripting General => Topic started by: NightJay0044 on 24 Sep 2005, 17:04:46

Title: ReadMe's?
Post by: NightJay0044 on 24 Sep 2005, 17:04:46

Hi, I was wondering, what all does a Readme File need? Like all it's possible table of contents. For example for a mission?
I've writen them before but I would like to know what properly needs to go in them. Thanks..

Title: Re:ReadMe's?
Post by: macguba on 24 Sep 2005, 17:23:16

The readme should be named after the mission

myMission_readme.txt

A copy of the readme should also be placed inside the mission folder so that it is bundled up inside the .pbo file.  It doesn't do any harm there, and can be retrieved if the original readme is lost.


You MUST include:

• Mission Name
• Mission version number
• SP or MP
• Suitable for Cadet mode, Veteran mode or both
• Date
• Author name
• Author email
• OFP version required
• Precise and accurate details of any addons required

 - Addon name
 - Version of addon
 - Author's name
 - What it is
 - File size
 - Correct link to the addon page (the exact page - not the website: not the file)
 - Mirrors if they exist in case original link goes down

• Any other special requirements e.g. minimum spec PC
• Installation instructions
• Any known bugs or problems
• Acknowledgements
• Statement that mission is Unofficial
• Disclaimer
• Anything else that the player might need to know.  If in doubt, include it

You MAY include:

• Version history details
• Mission Features/Outline
• Details of language support
• Designer's Notes
• Walkthrough
• Beta testers' comments
• Anything else you like

Title: Re:ReadMe's?
Post by: NightJay0044 on 24 Sep 2005, 18:03:02

MacGuba~
Thanks that clears that matter up. Also what dont you know about OFP? h ;D

Just want to say great job on bieng the admin of this site.

 :thumbsup:

 :cheers:

Title: Re:ReadMe's?
Post by: 456820 on 24 Sep 2005, 19:00:58

oh that is very usefull how about a submittion in the ed depot or a sticky somewhere with that info on

Title: Re:ReadMe's?
Post by: Triggerhappy on 24 Sep 2005, 20:31:59

i believe there is...

nightjay maccy isn't the site admin...he a moderator, and editors depot admin
sui is the bug guy  ;D
but we all love mac anyway :P

Title: Re:ReadMe's?
Post by: El Fisho on 24 Sep 2005, 22:16:54

Or is this some mega plot by mac to overthrough sui and rule the realm of OFPEC,  :P

Title: Re:ReadMe's?
Post by: macguba on 24 Sep 2005, 22:43:32

Thanks for the kind words chaps.   Much of this information is already included in the sticky on the missions beta testing board, albeit in a slightly different form.   It will also be included in the new version of the submission guidelines that Artak is working on.

Quote

Or is this some mega plot by mac to overthrough sui and rule the realm of OFPEC,

No fear ... I know what the initiation ritual involves .... :beat:

Title: Re:ReadMe's?
Post by: Triggerhappy on 24 Sep 2005, 22:54:25

Quote

No fear ... I know what the initiation ritual involves .... :beat:

poor sui... :'(