Difference between revisions of "GRFPack Dev Guide"

Revision as of 23:16, 24 February 2008

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/...)

Double check if it is really an update (md5sum)
Commit to SVN with a proper message
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

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)
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

move it to GRF Table Removed and give a reason...

Update: updating existing GRF

New: adding new GRF

Orders: moving existing GRF to better place to fix order dependencies

Fix: fixing some other bugs ;-)

Remove: deleting a existing NewGRF (with reason)

Release: new tag etc.

@@ Line 18: / Line 18: @@
 == Adding new GRF ==
-# create a directory in the category, it belongs to. Also possible it needs an other location, because of a special dependency. Then you create a folder "a" or something like that for it, or you move it to top (1_others) or to bottom (9_last). EVERY GRF has its own directory. (svn mkdir; svn add <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 revision number
+## Title with version number
-## link to grf
+## Link to grf
-## don't forget the credits (you see them in the GRF itself...)
+## Don't forget the credits (you see them in the GRF itself...)
-## write the svn revision to status
+## Write the '''svn revision''' (of our grfpack) into the status column
 == Deleting a GRF ==