Skip to content

Latest commit

 

History

History
428 lines (372 loc) · 16 KB

README.md

File metadata and controls

428 lines (372 loc) · 16 KB
Raw

OpenSFX README

Table of Contents:

1.0 About

OpenSFX is a set of base sounds for OpenTTD and is the result of the "Sound Effects Replacement" project.

The main goal of OpenSFX is to provide a set of free sounds which make it possible to play OpenTTD without requiring the (copyrighted) files from the Transport Tycoon Deluxe CD.

The OpenSFX sounds are free as in 'free beer' and free as in 'freedom'.

1.1 License

OpenSFX is free software, you are allowed to freely use, copy, modify and share this, even commercially, as long you follow the licenses.

The OpenSFX sound collection as a whole is licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported license.

All other files, including text files, scripts, etc. are dual-licensed under: GNU General Public License version 2 (or later) and Common Development and Distribution License 1.1.

You can find the full license texts in license.txt.

Note about individual sound files:

Each individual sound file in OpenSFX is additionally released under another license, which is either the same as the overall license or a more permissive one. See "src/opensfx.psfo" in the source repository to see which license it is. So if you want to use a specific sound file from OpenSFX, you are free to choose whether the overall sound license mentioned above applies to you, or the license of the specific sound file.

2.0 Installing

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.

There are three ways to get the latest stable release:

  • If you are new to OpenTTD, you do not have access to the original Tranport Tycoon Deluxe files and you are using the Windows installer to install OpenTTD you can select OpenSFX to be downloaded during the installation of OpenTTD.

  • If you are new to OpenTTD and do not have access to the original Tranport Tycoon Deluxe files, you will have to download and install OpenSFX manually. This is really not that difficult as it may sound, so do not worry too much about that.

  • If you already have OpenTTD up and running, the in-game Online Content service is the easy way to obtain OpenSFX.

    • Download location: use the in-game Online content service
    • Installation instructions: Installing OpenSFX using the Online Content service.

2.1 Installing Manually

  1. First, make sure that you have downloaded and installed at least OpenTTD version 1.0.0 or a recent nightly.
  2. Next, download the latest OpenSFX package. (stable nightly)
  3. Unpack the zip into the OpenTTD's /baseset directory. There is no need to unpack the tar file, so just leave it as it is. Your OpenTTD /baseset directory is either located in:
    • An OpenTTD folder in your user account's home directory:
      • Windows: C:\Users<username>\Documents\OpenTTD
      • macOS: ~/Documents/OpenTTD
      • GNU/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.
    • If you did not install the original Tranport Tycoon Deluxe base sounds during the installation of OpenTTD, you can skip this step.
    • If you installed the original Tranport Tycoon Deluxe base sounds as well, this is where you can switch base sound sets.

2.2 Installing 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 (at least 1.0.0).

  1. Start OpenTTD and on the main menu click the Check online content button. A new window will pop up.
    • If OpenTTD does not start, follow the manual installation procedure.
  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 sound set if that is 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.

3.0 Obtaining the source

The OpenSFX source is available in a Git repository. You can use Git to do a checkout from this address:

git clone https://github.com/OpenTTD/OpenSFX.git

For releases you can download the (released) tarballs from:

https://www.openttd.org/downloads/opensfx-releases/latest.html

3.1 Compiling the source

For compiling the source you need:

3.2 Contributing

Contributing to OpenSFX can be done in several ways, but they generally end up with providing (improved) samples for the set. If you have got a better sample than we currently have you can make that know via an issue at:

https://github.com/OpenTTD/OpenSFX/issues

Please mention who made the original samples and that the sample has been released under the Creative Commons Attribution-ShareAlike 3.0 Unported license or a license that allows us to release it under that license (for example, Creative Commons Attribution 3.0 Unported or Creative Commons Zero 1.0).

4.0 Credits

Most sounds come from freesound.org and pdsounds.org and were edited by OpenTTD contributors in order to make them suitable for the game. Most source sounds have been released under libre licenses like CC BY 3.0, allowing sharing and remixing.

To see detailed license info about the actual sound files in OpenSFX, see "src/opensfx.psfo" in the source repository.

4.1 Sound credits of source sounds

This section gives credit to the original sound authors, i.e. the sounds before they were edited. All sounds are sorted by their ORIGINAL license or legal status. This does not change the overall OpenSFX license. The name of the author, the origin website, the original file name and the URL (if available) are given, in this order.

4.1.1 Public Domain

  • "Aldor" from "pdsounds.org"
    • Ascenseur / Elevator
  • David R Barnes ("earthcalling") from "pdsounds.org"
    • Corner of a sheep field in summer

4.1.2 CC0 1.0

4.1.2 CC BY 3.0

4.1.3 CC BY-SA 3.0

4.2 Sound editors

Editing/(re)mixing was done by:

  • Janis Lukss ("Pendrokar" at "wiki.openttd.org")
  • "janusz" from "dev.openttdcoop.org"
  • "Jklamo" from "wiki.openttd.org"
  • Remko Bijker ("Rubidium" at "dev.openttdcoop.org")
  • Richard Wheeler ("Zephyris" at "dev.openttdcoop.org")
  • "Wuzzy" from "tt-forums.net"

A detailed list of who has worked on what sample is available in the file "src/opensfx.psfo" in the source repository.

4.3 Other authors

This is a list of sound creators that contributed their work directly to OpenSFX:

  • Remko Bijker ("Rubidium" at "dev.openttdcoop.org")
    • Started the OpenSFX project, author of the initial scripts, text files, chose most of the initial sounds
  • Janis Lukss ("Pendrokar" at "wiki.openttd.org")
    • Own recordings/mixes
  • Timo A. Hummel ("Felicitus" at "dev.openttdcoop.org")
    • Own work

4.4 License reference

You can find the complete license texts here: