OpenGFX Readme

From OpenTTD
(Difference between revisions)
Jump to: navigation, search
m (Credits)
(Credits)
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<div style="float:left; padding-right: 10px;">__TOC__</div>{{Template:8bpp Graphics Replacement}}
+
{{Template:8bpp Graphics Replacement}}
 
+
 
'''OpenGFX''' is a set of [[base graphics]] for [[OpenTTD]] and is the result of the [[Graphics Replacement|8bpp Graphics Replacement Project]].
 
'''OpenGFX''' is a set of [[base graphics]] for [[OpenTTD]] and is the result of the [[Graphics Replacement|8bpp Graphics Replacement Project]].
  
Line 6: Line 5:
  
 
The OpenGFX base graphics set is currently not complete yet, but is already very playable.
 
The OpenGFX base graphics set is currently not complete yet, but is already very playable.
 +
 +
<div style="float:left; padding-right: 10px;">__TOC__</div>
  
 
<div style="clear:left;"></div>
 
<div style="clear:left;"></div>
Line 31: Line 32:
 
'''2.''' Next, download the latest OpenGFX package. ([http://mz.openttdcoop.org/bundles/opengfx/releases/ stable] [http://mz.openttdcoop.org/bundles/opengfx/nightlies/ nightly])
 
'''2.''' Next, download the latest OpenGFX package. ([http://mz.openttdcoop.org/bundles/opengfx/releases/ stable] [http://mz.openttdcoop.org/bundles/opengfx/nightlies/ nightly])
  
'''3.''' Place the [[Wikipedia:Tar (file format)|tar file]] into the OpenTTD /data directory. There's no need to unpack the tar, so just leave it as it is.
+
'''3.''' Unpack the zip into the OpenTTD /data directory. There's no need to unpack the [[Wikipedia:Tar (file format)|tar file]], so just leave it as it is.
 
Your OpenTTD /data directory is either located in:
 
Your OpenTTD /data directory is either located in:
 
* An OpenTTD folder in your user account's home directory:
 
* An OpenTTD folder in your user account's home directory:
Line 60: Line 61:
 
* Alternatively download an empty sample.cat file (http://www.openttdcoop.org/sample.cat) and place it in the OpenTTD /data directory.
 
* Alternatively download an empty sample.cat file (http://www.openttdcoop.org/sample.cat) and place it in the OpenTTD /data directory.
  
'''Note:''' If you have the dummy sample.cat file in place the game still will give you an error about the file being corrupted. The difference this time is that you now ''do'' have an option to start the game: just click OK to continue!
+
'''Note:''' If you have the dummy sample.cat file in place the game still will give you an error about the file being corrupted. The difference this time is that you now ''do'' have an option to start the game: just click OK to continue! (Obviously, you don't have any sound effects with the dummy file.)
  
 
==Installing or Updating OpenGFX using the Online Content service==
 
==Installing or Updating OpenGFX using the Online Content service==
This method uses the [[Online content]] service to download OpenGFX. In order to use this, you need a working OpenTTD and again at least '''OpenTTD version 0.7.0''' or a recent [[nightly]].
+
This method uses the [[Online content]] service (BaNaNaS) to download OpenGFX. In order to use this, you need a working OpenTTD and again at least '''OpenTTD version 0.7.0''' or a recent [[nightly]].
  
 
'''1.''' Start OpenTTD and on the main menu click the ''Check online content'' button. A new window will pop up.
 
'''1.''' Start OpenTTD and on the main menu click the ''Check online content'' button. A new window will pop up.
Line 78: Line 79:
 
'''6.''' Select ''OpenGFX'' from the drop-down list below ''Base graphics set'' if that's not selected already (bottom left of window). Close the window using the &times; in the upper left corner.
 
'''6.''' Select ''OpenGFX'' from the drop-down list below ''Base graphics set'' if that's not selected already (bottom left of window). Close the window using the &times; in the upper left corner.
 
* This is where you can switch base graphic sets.
 
* This is where you can switch base graphic sets.
 
  
 
==Project status==
 
==Project status==
Line 122: Line 122:
  
 
* Zephyris (Richard Wheeler)
 
* Zephyris (Richard Wheeler)
 +
* Varivar
 
* uzurpator
 
* uzurpator
 
* Spaz O Mataz
 
* Spaz O Mataz
Line 135: Line 136:
 
* Mr. X
 
* Mr. X
 
* mph (Matthew Haines)
 
* mph (Matthew Haines)
* michael blunck (Michael Blunck)
+
* mb (Michael Blunck)
 
* LordAzamath (Johannes Madis Aasmäe)
 
* LordAzamath (Johannes Madis Aasmäe)
 
* lead@inbox (Serge Saphronov)
 
* lead@inbox (Serge Saphronov)
 
* Gen.Sniper (Tomas Kurowski)
 
* Gen.Sniper (Tomas Kurowski)
 +
* Irwe
 
* FooBar (Jasper Vries)
 
* FooBar (Jasper Vries)
 
* EdorFaus (Frode Austvik)
 
* EdorFaus (Frode Austvik)
Line 153: Line 155:
  
  
* A detailed list of who worked on what is available in the file [https://dev.openttdcoop.org/projects/opengfx/repository/entry/docs/authoroverview.csv authoroverview.csv] in the source repository.  
+
* A detailed list of who worked on what is available in the file [http://dev.openttdcoop.org/projects/opengfx/repository/entry/docs/authoroverview.csv authoroverview.csv] in the source repository.  
 
* Thanks go out to the guys at [http://www.openttdcoop.org/ #openttdcoop] for providing the source repository and bug tracking services.
 
* Thanks go out to the guys at [http://www.openttdcoop.org/ #openttdcoop] for providing the source repository and bug tracking services.
  

Revision as of 17:57, 11 August 2009

OpenGFX is a set of base graphics for OpenTTD and is the result of the 8bpp Graphics Replacement Project.

OpenGFX is an open source replacement for the original TTD graphics used by OpenTTD. The main goal of OpenGFX therefore is to provide a set of free base graphics which make it possible to play OpenTTD without requiring the (copyrighted) files from the TTD cd. This potentially increases the OpenTTD fanbase and makes it a true free game (with "free" as in both "free beer" and "open source").

The OpenGFX base graphics set is currently not complete yet, but is already very playable.

Downloading OpenGFX

OpenGFX is available from at least three locations. This readme will only cover the official download locations. We cannot support third party download locations and we cannot refund your money if you have paid money for OpenGFX.

Getting a Stable Release

There's two places where you can get the latest stable release:

Getting a Nightly Build

  • Just like OpenTTD, there are nightly builds of OpenGFX available as well. Every evening around 18:18 CEST a new build of OpenGFX is created automatically (if there's something new that is). Unlike stable releases these builds aren't tested to see if they work, but if a nightly doesn't work, it doesn't break anything either. Keep a stable or working nightly sitting in the /data dir and just delete a broken nightly to get OpenGFX working again.


Installing OpenGFX Manually

1. First, make sure that you've downloaded and installed at least OpenTTD version 0.7.0 or a recent nightly.

2. Next, download the latest OpenGFX package. (stable nightly)

3. Unpack the zip into the OpenTTD /data directory. There's no need to unpack the tar file, so just leave it as it is. Your OpenTTD /data directory is either located in:

  • An OpenTTD folder in your user account's home directory:
    • Windows: C:\Documents and Settings\<username>\My Documents\OpenTTD
    • Mac OSX: ~/Documents/OpenTTD
    • Linux: ~/.openttd
  • The OpenTTD installation directory.

4. Run OpenTTD. Chances are that you'll get an error about a missing 'sample.cat' file. If that is the case, follow the steps in the sample.cat error section first before continuing here.

5. In the main menu of the game, click the Game Options button. The Game Options dialog will appear.

6. Select OpenGFX from the drop-down list below Base graphics set if that's not selected already (bottom left of window). Close the window using the × in the upper left corner.

  • If you did not install the original TTD base graphics during the installation of OpenTTD, you can skip this step.
  • If you installed the original TTD base graphics as well, this is where you can switch base graphic sets.

Now that wasn't so hard, was it? Anyways, if you're having trouble getting OpenGFX to work, please file a detailed report on what you did, what error messages you got and where you got stuck in the OpenGFX release topic at TT-forums: http://www.tt-forums.net/viewtopic.php?f=36&t=40162

Sample.cat error

The sample.cat file contains the sound effects from the original TTD. OpenTTD requires that file to be installed correctly, otherwise the game will not start. What to do if you don't have that file? Read on! The solution is to create a dummy sample.cat file.

1. Browse to the OpenTTD /data directory.

2. Create an empty file with sample.cat as file name:

  • Use your operating system's built in graphical tools, or;
  • Use a command like $ touch sample.cat on the command line, or;
  • Alternatively download an empty sample.cat file (http://www.openttdcoop.org/sample.cat) and place it in the OpenTTD /data directory.

Note: If you have the dummy sample.cat file in place the game still will give you an error about the file being corrupted. The difference this time is that you now do have an option to start the game: just click OK to continue! (Obviously, you don't have any sound effects with the dummy file.)

Installing or Updating OpenGFX using the Online Content service

This method uses the Online content service (BaNaNaS) to download OpenGFX. In order to use this, you need a working OpenTTD and again at least OpenTTD version 0.7.0 or a recent nightly.

1. Start OpenTTD and on the main menu click the Check online content button. A new window will pop up.

2. Find the OpenGFX entry from the list at the left. You can use the search box in the upper right corner of the window.

3. Click the little square in front of the OpenGFX entry in order to mark it for download.

4. Click the Download button in the bottom right corner. After download, close the open windows.

5. In the main menu of the game, click the Game Options button. The Game Options dialog will appear.

6. Select OpenGFX from the drop-down list below Base graphics set if that's not selected already (bottom left of window). Close the window using the × in the upper left corner.

  • This is where you can switch base graphic sets.

Project status

OpenGFX is not completely finished yet and some graphics still are missing.

The current status of the project can be found at the Graphics Replacement Tracking Table and/or the Issue Tracker. A graphical list of sprites which need drawing can also be found here. It might not always be 100% up to date - so please check with the tracking tables mentioned above.

Reporting bugs

Notice.png

Note
Missing graphics show up in the game as black rectangles. Please don't report these black rectangles as bugs.

If you do spot any grapical bugs or glitches in the available graphics, please let us know! There are two ways to report bugs:


Either way, make sure the bugreport is useful. Provide as much information you can!

License

OpenGFX Graphics Replacement Set for OpenTTD Copyright (C) 2007-2009 OpenGFX Authors (see below)

OpenGFX is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

OpenGFX is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with OpenGFX; if not, write to the Free Software Foundation, Inc., 1 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.


Obtaining the source

The OpenGFX source is available in a Mercurial repository. You can download the source in bz2, zip or gz format from http://mz.openttdcoop.org/hg/opengfx, or you can use Mercurial to do an anonymous checkout from the same address , e.g. using

   hg clone http://mz.openttdcoop.org/hg/opengfx

Credits

OpenGFX is created by the following people (in reverse alphabetical order):

  • Zephyris (Richard Wheeler)
  • Varivar
  • uzurpator
  • Spaz O Mataz
  • Soeb (Stanislaw Gackowski)
  • skidd13 (Benedikt Brüggemeier)
  • Roujin
  • Red*Star (David Krebs)
  • Raumkraut (Mel Collins)
  • Purno (Mark Leppen)
  • planetmaker
  • PikkaBird (David Dallaston)
  • northstar2
  • Mr. X
  • mph (Matthew Haines)
  • mb (Michael Blunck)
  • LordAzamath (Johannes Madis Aasmäe)
  • lead@inbox (Serge Saphronov)
  • Gen.Sniper (Tomas Kurowski)
  • Irwe
  • FooBar (Jasper Vries)
  • EdorFaus (Frode Austvik)
  • DJ Nekkid (Thomas Mjelva)
  • DanMacK (Dan MacKellar)
  • buttercup
  • bubersson (Petr Mikota)
  • Born Acorn
  • Bilbo
  • Ben_Robbins_ (Ben Robbins)
  • athanasios (Athanasios Arthur Palaiologos)
  • andythenorth (Andrew Parkhouse)
  • Ammler (Marcel Gmür)


  • A detailed list of who worked on what is available in the file authoroverview.csv in the source repository.
  • Thanks go out to the guys at #openttdcoop for providing the source repository and bug tracking services.

See also

Personal tools