Difference between revisions of "GRFPack Dev Guide"
From #openttdcoop wiki
| Line 1: | Line 1: | ||
| + | ==General Things about NewGRFs== | ||
| + | * 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== | ==Updating existing NewGRF== | ||
| Line 5: | Line 12: | ||
# Update [[GRF Table (Trunk)]] | # Update [[GRF Table (Trunk)]] | ||
## edit title with revision number | ## edit title with revision number | ||
| − | ## check link, if its still direct to the current revision | + | ## check link, if its still direct to the current revision |
| − | + | ||
## after update, the credits might also change... | ## after update, the credits might also change... | ||
## write the svn revision to status | ## write the svn revision to status | ||
| Line 16: | Line 22: | ||
# Update [[GRF Table (Trunk)]] | # Update [[GRF Table (Trunk)]] | ||
## title with revision number | ## title with revision 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 to status | ||
Revision as of 09:08, 20 February 2008
Contents
General Things about NewGRFs
- 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
- be sure, if its really a update (md5sum)
- commit to SVN with a proper message
- Update GRF Table (Trunk)
- edit title with revision number
- check link, if its still direct to the current revision
- after update, the credits might also change...
- write the svn revision to status
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>)
- Update GRF Table (Trunk)
- title with revision number
- link to grf
- don't forget the credits (you see them in the GRF itself...)
- write the svn revision to status
Preambles for SVN commits
Update: updating existing GRF
New: adding new GRF
Orders: moving existing GRF to better place to fix order dependencies
Fix: fixing some other bugs ;-)
Release: new tag etc.
