Revision as of 17:35, 3 June 2008

Quick Howto:

1. Checkout or Update trunk: svn co https://svn.openttdcoop.org/grfpack/trunk ottdc_grfpack_trunk or cd ottdc_grfpack_trunk && svn up
2. Download the GRF to the right place
3. Open the GRF in OpenTTD
4. Commit the GRF to REPO: svn ci -m "New/Update: ...."
5. Edit the GRF_Table_(Trunk)
6. done

This is a guide to update our #openttdcoop NewGrf Package with Subversion and documenting the changes in GRF Table (Trunk).

• GRFs in alpha/beta state does change many times and should be checked before releasing new pack.
• The data from a GRF could be differ then the data from the webpage or forum or whatever, I would suggest to take the data from the GRF.
• GRFCrawler isn't always "right", TT-Forums should work if no official link available, links mostly change after update there...
• loading the GRF in OpenTTD might be a good idea for checking title, credits etc. (Title in GRF Table should be the same...)
• if there is a readme available, a link from column Details would be nice (link to www.openttdcoop.org/newgrfs/...)

Updating existing NewGRF

1. Double check if it is really an update (md5sum)
2. Commit to SVN with a proper message (svn commit)
3. Update GRF Table (Trunk)
   1. Edit title and version number.
   2. Check the link to the grf authors page (still correct after version update, avoid 404!)
   3. After updates, the credits might also change...
   4. Write the svn revision (of our grfpack) into the status column

Adding new GRF

1. Create a directory in the category, the NewGrf belongs to. Possibly the NewGrf needs another location because of a special dependency. Then you create a folder with a prefix (i.e. "a_") or you move it to the top directory (1_others) or to bottom (9_last). EVERY GRF has its own directory. (svn add <grffolder>)
2. Update GRF Table (Trunk)
   1. Title with version number
   2. Link to grf
   3. Don't forget the credits (you see them in the GRF itself...)
   4. Write the svn revision (of our grfpack) into the status column

Deleting a GRF

move it to GRF Table Removed and give a reason... The GRF itself needs to be moved to z_obsolete. (save compatibility)

Revert a commit

change to the directory where the GRF is, then

svn export -r <revision to revert -1> ./ ./ --force

commit the change...

Preambles for SVN commits

• Update: Updating an existing NewGrf
• New: Adding a new NewGrf
• Orders: Moving an existing NewGrf to another location to fix order dependencies
• Fix: Fixing some other bugs ;-)
• Remove: Deleting an existing NewGRF (with reason)
• Release: Creating a new tag in /grfpack/tags

Release

1. Creating wiki branch (copy GRF Table (Trunk) to GRF Table $VERSION) Download GRF Table to trunk with httrack i.e.
2. Updating Readme
3. Updating ottdc_grfpack.cfg (Script makenewgrfcfg)
4. Tagging
5. Generate the release packages.(Script eportpacks (editing config first ;-)
6. Generating md4sum list: http://www.openttdcoop.org/newgrfs/ottdc_grfpack.md5sum