Sound Effects Replacement

From OpenTTD
Revision as of 07:54, 14 February 2011 by gomoko (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search


OpenSFX is a free replacement of the base sounds for OpenTTD, so that OpenTTD can be played without requiring the (copyrighted) files from the TTD CD. This potentially increases the OpenTTD fanbase and makes it a true free game.


Contents

Downloading OpenSFX

OpenSFX 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 OpenSFX.

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 OpenSFX available as well. Every evening around 18:18 CEST a new build of OpenSFX 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 OpenSFX working again.


Installing OpenSFX Manually

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

2. Next, download the latest OpenSFX 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 XP: C:\Documents and Settings\<username>\My Documents\OpenTTD
    • Windows Vista: C:\Users\<username>\Documents\OpenTTD\data
    • Mac OSX: ~/Documents/OpenTTD
    • Linux: ~/.openttd
  • The OpenTTD installation directory.

4. Run OpenTTD.

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

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

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


Installing or Updating OpenSFX using the Online Content service

This method uses the Online content service (BaNaNaS) to download OpenSFX. In order to use this, you need a working OpenTTD and again at least OpenTTD version 0.8.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 OpenSFX 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 OpenSFX 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 OpenSFX from the drop-down list below Base Sounds 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 sound sets.


Technical and licensing details

Sounds should be uploaded as 44,100Hz, 16-bit mono WAV or FLAC files. There will be a new sound file format developed for OpenTTD, likely using .tar files in a manner similar to that of the new sounds. Until then, tools will be made available to enable work to go on using the existing sample.cat format.

For ensuring that resulting sample.cat (or tar) file may be distributed freely with OpenTTD code all sound files must have some of free license. Appropriate are Public domain or the Sampling Plus license. Other licenses (like for example Creative Commons -sa -nd -nc or its combinations) are more problematic. If sourcing sound effects from free libraries online, please ensure they are licenced under Public domain or the Sampling Plus 1.0 license.

External links

Personal tools