Difference between revisions of "GRFPack Dev Guide"
From #openttdcoop wiki
m (→Release) |
(→Deleting a GRF: z_obsolte) |
||
Line 43: | Line 43: | ||
== Deleting a GRF == | == Deleting a GRF == | ||
move it to [[GRF Table Removed]] and give a reason... | move it to [[GRF Table Removed]] and give a reason... | ||
+ | The GRF itself needs to be moved to z_obsolete. (save compatibility) | ||
==Preambles for SVN commits== | ==Preambles for SVN commits== |
Revision as of 16:23, 31 March 2008
Quick Howto:
- Checkout or Update trunk: svn co https://svn.openttdcoop.org/grfpack/trunk ottdc_grfpack_trunk or cd ottdc_grfpack_trunk && svn up
- Download the GRF to the right place
- Open the GRF in OpenTTD
- Commit the GRF to REPO: svn ci -m "New/Update: ...."
- Edit the GRF_Table_(Trunk)
- 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
- Double check if it is really an update (md5sum)
- Commit to SVN with a proper message (svn commit)
- Update GRF Table (Trunk)
- Edit title and version number.
- Check the link to the grf authors page (still correct after version update, avoid 404!)
- After updates, the credits might also change...
- Write the svn revision (of our grfpack) into the status column
Adding new GRF
- Create a directory in the category, the NewGrf belongs to. Eventually 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 mkdir; svn add <grf>)
- Update GRF Table (Trunk)
- Title with version number
- Link to grf
- Don't forget the credits (you see them in the GRF itself...)
- 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)
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
- Download GRF Table to trunk
- Updating Readme
- Updating ottdc_grfpack.cfg
- Tagging
- ./exportpacks (editing config first ;-)