Generic Readme-template

readme for mods

from GalCiv2 Forums
Hi all,
I just bought GC2. So far the un mod game is great. Still learnig the game. I see a lot of mods in the libray. In the future I will like to add the mods. What I think is missing is a generic readme-template. I have used mods before in Rome: Total War. Most of the mods are easy to install if there is a understand able read me for installation.
Take it from a newbie like my self, a good read me which gives:
1. title
2. version
3. which version used in; example GC2 1.4
3. description
4. install instructions
5. credit using art, modles, parts of mods, from other creators
6. contact e-mail for any problems with mod

My experience with mods from Rome:TotalWar has been that a generic-readme-template was made for those points 1 thru 6. Here is what the Rome:totalwar comunity uses:
----------------------------------------------
Rome Total War [Name Here] by [Your Name]
Copyright (C) 2004 [Your Name]

v1.0 - [Release Date Here]

http://www.twcenter.net
email: [Your email]

This software was developed for the Total War Center's community in an effort to enhance its game play experience.

Using Rome Total War [Name Here]
----------------------------------------------
The detailed guide is still under development. Visit the Total War Center's workshop section for updates or questions.
If you are not sure that you fully understand principles on which "Rome Total War [Name Here] " operates I recommend you not to use it at this stage.

----------------------------------------------
Licence Agreement:
----------------------------------------------
Terms of Use
This software is FREEWARE. This software is provided "as is", without any guarantee made as to its suitability or fitness for any particular use.
It may contain bugs, so use of this tool is at your own risk. I take no responsibility for any damage that may unintentionally be caused through its use.
I have verified it on a local system and on a number of other users computers, but there is no way for me to be able to guarantee that it will work on each and every system configuration out there.

Cooperation
You may not use Rome Total War [Name Here] in a product, either free or commercial, without the express permission of [Your Name].
If you are interested in redistributing Rome Total War [Name Here] , either in original or modified form, or wish to use Rome Total War [Name Here] source code in a product,
or have any other idea of cooperation, including a job offer or a donation, please send e-mail to [Your email] with details.

Copyright Notice
[Your Name] holds valid copyright on the Software. Nothing in this agreement constitutes a waiver of any rights under U.S. Copyright law or any other federal or state law.

----------------------------------------------
Installation Instructions:
----------------------------------------------
1. DIRECTIONS HERE

----------------------------------------------
Latest Changes\ Update Log:
----------------------------------------------
10/14/2004 - [Details Here]


----------------------------------------------
Known limitations:
----------------------------------------------
[Details Here]


----------------------------------------------
If you encounter problems, please visit http://www.twcenter.net and download the latest version to see if the issue has been resolved.
If not, please send a bug report to: [Your email]

If you feel you have any suggestions that could make this software better please feel free to contact me with your suggestion.

----------------------------------------------
The Rome Total War software is property of:
Total War Software © 2002 - 2004 The Creative Assembly Limited. Total War, Rome:Total War and the Total War logo are trademarks or registered trademarks of The Creative Assembly Limited in the United Kingdom and/or other countries.
Published by Activision Publishing, Inc. Activision is a registered trademark of Activision, Inc. All rights reserved.
----------------------------------------------
All trademarked names mentioned in this document and SOFTWARE are used for editorial purposes only, with no intention of infringing upon the trademarks.
____________________________________________________________________________________

I just posted this as an example. Maybe someone can modify this for the GC2 community and make available.

newbie: mudmarine

modding
4,499 views 4 replies
Reply #1 from GalCiv2 Forums Top
Kyro,
A standard Readme-template would be use full with all the modding going on. I only submitted Rome Total War as an example that this comunity uses. Maybe some one at Star Dock could come up with something simular or a modder out thier? A standardized Readme template would be a benefit to the users help in some of the the confussion. Would also give credit to the hard work of modders out there when thier mod is used as part of anothers mod creation. It would also help other users in installation and a contact if problems. Also explain limitations such as metaverse compatable or compatability with other mods or versions of GC2.

I have noticed in the download library a Star Dock certification. That could also be part of the template.

I have found in the past such a document was greatly appreciated and help resolve many questions for me as a user.

I would like anyone elses comments out there and thier experinces in the modding community.

I might suggest that maybe a contest be proposed for the best readme template submitted by a certain date and voted by a poll of the community at another date. The prize of such a competition would be at Star Docks discretion.
Reply #2 from GalCiv2 Forums Top
There's no reason modders can't voluntarily use something like that, but I'm not going to force it on anyone.
Ashes of the Singularity II
Reply #3 from GalCiv2 Forums Top
Kyro,
I do not wish to force anyone to use. I just wish there was some standardization of readme files. Maybe I am asking the wrong question.

What the question I should be asking: Does anyone want a standardize readme template they can use for mods?

If so, what info should it contain?
Reply #4 from GalCiv2 Forums Top
Mudmarine,
I like what you got now. Here is the one I used (using your template) on the last mod I submitted to the library. Let me know if this is more to your liking. BTW were you a 0311?

PubMaster’s Metaverse Ship Pack
Version 1.0
Rev GC2 1.5 (Should work on lower revs too).

All of these ships are hulls built under the human race with just extras. No engines, weapons etc. attached. All
ship hulls begin with a letter 'z', so unless you name your designs start with the letter 'z', the hull designs will be listed at the bottom of your design list in the shipyard.

I stole the naming method from Croc411/Rabid_Monkey/the US Navy.

z[designation] Pub-xx

Designations are:
CRG (Cargo) - Cargo (Freighter, Sensor, Trade)
FTS (Scout) - Tiny
FTR (Fighter) - Tiny
CRV (Corvette) - Small
DD (Destroyer) - Medium
CR (Cruiser) - Large
BB (Battleship) - Huge
CV (Carrier) - Carrier (Huge- Just visual effects.)

Note that you will have to research Advanced Hulls to get access some of the fighters.

All the others you should see in the shipyard right after you research the right path. (I.e. Research Large Hulls)

You need GalCiv2 version 1.5 (might work with earlier revs but I'm not sure) and the Collector's Edition add ons.

Please update BEFORE you unzip the files. Some of the larger designs may affect your game play depending on your system.

INSTALLATION:
-These ships were created in DL and per Kryo the prefixes on the .shipcfg files are different in DA, so you may
need to rename those files as well to make them appear under the style you want. To find the prefixes associated
with each style, go look inside the files in Program Files\Stardock\GalCiv2\DarkAvatar\Data\English\ShipStyles.

Please use the following guidelines developed by SideMancer when unzipping the .xml and .shipcfg files to your computer.

Please note that:
- Dread Lords and Dark Avatar have their own seperate ship directories.
- Metaverse and regular games have their own seperate ship directories.

To use my ships in a DL regular game:
copy them into your 'My Documents\My Games\GalCiv2\ships' directory.

To use my ships in a DL metaverse game:
My Documents\My Games\GalCiv2\Metaverse\ships.

To use my ships in a DA regular game:
My Documents\My Games\GC2DarkAvatar\ships.

To use my ships in a DA metaverse game:
My Documents\My Games\GC2DarkAvatar\Metaverse\ships.

To check out the designs you can start a DL or DA regular game and
set the game mode to 'Battle of the Gods', this way you immediately get the
required hull techs for the designs.
In a metaverse game you have to research the required hull techs first.

In DA there are now templates, but to use previously created designs as templates, you have to use them as ships
and then resave them within the game with the 'use as template' option turned on.

I hope you like them,
Enjoy!

Contact me @ [email protected] for any problems with this mod. Please include the mod’s name, rev, and the specific problem you are having.