NewGRF

From OpenTTD
Jump to: navigation, search


NewGRF stands for New Graphics Resource File which provide a general interface to mod(ify) the game. As of OpenTTD 1.2.0, 32 bit graphics are also supplied via NewGRFs.

NewGRF is the way to add new or modify existing graphics, vehicles, buildings, cargos, railtypes, objects and industries within OpenTTD. NewGRF files may be downloaded and selected for activation prior to creation of a new game in order to introduce these features. Unlike Advanced Settings which may be changed part way through a game, NewGRF should be installed prior to starting a new game in order to ensure correct operation. The name "NewGRF" refers to the new features added to GRF files (Transport Tycoon graphics resource files) which can be exploited to change graphics and the behaviour of the game. NewGRF is a shared format between OpenTTD and TTDPatch, and is almost fully compatible with both.

For common issues with GRF files in OpenTTD, visit the NewGRF FAQ.

Contents

Getting NewGRFs

Online content

The most common and convenient way to obtain NewGRFs is by using the ingame online content download feature. Most NewGRF can be found there. There exists also a NewGRF development forum where you may find development versions of some NewGRFs, as well as a wiki NewGRF List which links to both many of the NewGRFs and other repositories.

Manual install

If you want to use NewGRFs obtained from other locations, which are not available from the online content download, you need to manually install them into the correct place. A NewGRF is a single file (with the extension .grf) for example: "grvts.grf". To install a NewGRF:

  1. Download the NewGRF (.grf) file.
  2. Move (and uncompress) the NewGRF file to the newgrf directory of your OpenTTD installation.
  • This will often be:
C:\My Documents\newgrf (Windows 95, 98, ME)
C:\Documents and Settings\<username>\My Documents\OpenTTD\newgrf (Windows 2000, XP)
C:\Users\<username>\Documents\OpenTTD\newgrf (Windows Vista, 7)
~/.openttd/newgrf (Linux, BSD)
~/Documents/OpenTTD/newgrf (OSX)

Activating NewGRFs

1. In the main menu, click "NewGRF Settings".

Main window (NewGRF Settings)

The interface changed between OpenTTD 1.0 and 1.1, thus both will be presented here after one another:

Version 1.1 and later

2. Select a NewGRF from the 'inactive NewGRFs files' and press "Add" or simply double click on it. On small screens it looks like

NewGRF settings window (small)

and on big screens it more conveniently expands to:

NewGRF settings window (big)

3. Configure an active newgrf's parameter, if needed: Select it from the 'active newgrf files' list and choose the 'parameter' button. The result may look similar to

NewGRF parameter window

4. Optionally you may choose to save the selection of newgrfs (along with their configuration parameters) or load such list by making use of the NewGRF presets:

Saving a NewGRF preset

Version 1.0 and earlier

2. Click "Add".

NewGRF settings window (Add)

3. Select the NewGRF file you want to use, then click "Add To Selection".

Available NewGRF files window

4. Click "Add" to add more NewGRFs, then "Apply Changes" when you are done.

NewGRF settings window (Apply)

To Combine or Not To Combine

OpenTTD allows you to select up to 59 different NewGRFs for each new game you start. However, you can't just make a random selection of what to add; a bit of planning is required. Not all NewGRFs are compatible with each other and sometimes you need multiple NewGRFs that complement each other. Below is an overview of different types of NewGRFs together with some comments on what you should and should not combine.

Vehicles
  • One of each (train set, road vehicle set, ship set, aircraft set) gives the best results.
  • More than one of the same type is possible, but may result in significant cost differences between vehicles of different sets.
  • The upper limit is 65535 different vehicles for each type.
Stations
  • As much as you want until you reach the upper limit of 255 different stations.
Canals/rivers
  • Only one at a time.
Bridges
  • In case of more than one, some sets will end up overwriting each other. This gives no technical problems, so feel free to experiment.
  • Bridge sets will always modify both road and rail bridges, due to the way they're implemented.
Houses
  • Only one at a time for the best results.
  • Combining more than one is possible, up to the upper limit of 512 different houses.
Industries
  • Only one at a time. Exception: one or more of ECS Vectors.
  • Some industry sets are designed to modify the default industries. The one at a time rule applies here as well: do not combine with other industry sets.
  • Most industry sets add new cargo types, which are unsupported by the default vehicles. If you use such an industry set, also always load one vehicle set for each vehicle type.
Airports
  • As much as you want until you reach the upper limit of 128 different airports.
Objects
  • As much as you want until you reach the upper limit of 255 different objects.
Railtypes (track sets)
  • As much as you want until you reach the upper limit of 16 different railtypes. This includes the four default railtypes which cannot be undefined.
  • Some track sets are specifically designed for specific train sets.

Many NewGRFs will warn if you make invalid combinations and will possibly disable themselves. It is recommended to check the NewGRF configuration after starting a new game (via Tools menu). If there are problems, it is recommended to abandon the game, fix the problems, and start a new game. For random games you can regenerate the same map when using the same random seed and keeping the other settings identical in the map generator. After starting a game you can obtain its random seed by typing getseed in the console.

8 bit vs 32 bit graphics

Feature availability

<1.0

1.0-1.2

1.3

1.4

Nightly

As of OpenTTD 1.2.0, NewGRFs can contain not only the usual 8 bit graphics, but also 32 bit graphics. With this change, NewGRFs are in fact the only way to supply 32 bit graphics to OpenTTD 1.2.0 or newer. From this point forward, NewGRFs are also able to supply different graphics for the different zoom levels.

See the List of 32bpp NewGRFs for a list of 32 bit graphics available to OpenTTD 1.2.0 and newer.

Closing remarks

Now, whenever you start a new game, the choice of NewGRFs will become active, and whatever changes they make to the game will become effective. However changing these settings will have no effect on existing savegames as newgrfs are an integral part of a savegame and the list of used newgrfs is stored within it.

A screenshot showing use of newgrf files including UKRS and Newstations

The order of (active) NewGRFs is important in determining how different NewGRFs interact. A NewGRF lower in the list overrides the effects of a NewGRF further up in the list.

External links


Personal tools