Content Service

From OpenTTD
Revision as of 18:01, 1 April 2009 by Roujin (Talk | contribs)

Jump to: navigation, search
Notice.png

Note
You need at least OpenTTD 0.7.0 or r15126 to be able to use the in-game download function.

On January 17th, 2009 a new feature has been added to OpenTTD. This Content Service feature allows downloading content from a central server (content.openttd.org). Authors of NewGRFs, AIs, Scenarios etc. first need to upload their work to the Content Service Website. Once added, OpenTTD players can easily download the NewGRFs, AIs, Scenarios etc. added to the central server using an in-game interface. Users only need to select what they want to download; the game handles installing all files.

Contents

Signing up for an account

Before you can add your work to the service, you need to sign up for an account first. Visit http://content.openttd.org/ and click the Manager button in the menu bar. A new page opens where you can find a link to the signup page.

On the signup page, fill in the requested fields. You can use your tt-forums username, but that's not a requirement. After filling the form, simply click the Sign Up button. After signing up, you'll be pointed towards the login page. Log in with the username and password you just signed up with.

After logging in, click on the link named BaNaNaS.

Adding content to the service

Make sure you are logged in first.

Click the Manager button in the menu bar. If this is the first time you'll be using the service to upload your work, you'll have to accept the terms of service. Read the terms carefully before accepting them.

Notice.png

Note
You are only allowed to upload content of which you are (one of) the original author(s)!

Now you'll be presented with an overview of all content you uploaded earlier. Ofcourse, this overview is empty if you use the service for the first time. To add new content, click the Upload New button at the top of the overview. A form will appear in which you'll have to provide all kinds of information:

  • Name: This will be the name of your NewGRF, AI, Scenario etc. Please provide a useful name and not something like "My Scenario" because this is the name displayed in the in-game download interface. Make sure to get the name right, because it cannot be changed afterwards. Don't include a version number in the name of your content.
  • Type: Whether you'll be uploading a Base Graphic package, a NewGRF, an AI, an AI Library, a Scenario or a Heightmap.
  • Version: The version of the content you'll be uploading. You can type here whatever you like, but make sure to pick something sensible, something which tells users directly what version of your content is newer.
  • License: The license which you like to apply or have applied to your work. You can select either one of the available free licenses or provide a custom license. More on licenses later.
  • File: The file containing your work. More on this also later.
  • Description: A description of your work. This description, like most information you provide, will be displayed in the in-game download interface.
  • URL: An url to the webpage dedicated to the content you're uploading or url to the appropriate topic at tt-forums.
  • Minimal Version: The minimal game version required to use your work. When selecting Nightly or Custom, fill in the nightly revision number or the name and version of the required patchpack in the adjacent field.
  • Maximal Version: Similar to the previous entry, but now to set what version of the game was the last version on which your content worked.
  • Tags: A comma seperated list of words describing your content. If you're adding a train newgrf then for instance add 'train' in the field. See the ingame download interface for more examples.
  • Dependencies: If your content requires other content to work, please select the content here. You can select more entries from the list by holding the control key. If your content doesn't require other content you can ignore this field.

After you've provided all information, just click the Upload button and wait until your content is uploaded.

Licenses

In this field you'll have to select the license that applies to your work. You can select one of the predefined entries: GPL v2, GPL v3, CC BY v3.0, CC BY-SA v3.0, CC BY-NC-SA v3.0 or CC BY-NC-ND v3.0. If none of these licenses fit your work, select the option Custom.

If you've selected the custom option, you'll have to provide the license with your work. The license text needs to be in a file called either 'copying.txt', 'copying', 'license.txt' or 'license'.

If you've selected one of the predifined options, you must not provide a license file or otherwise the upload will fail.

Files to upload

If you don't want to include a readme or custom license, you can just select the plain file (e.g. .grf, .scn, etc.) here. If you want or need to upload more than one file, you need to package the files first. These packages can be either in ZIP or TAR format and possibly some other formats as well. RAR isn't yet supported.
The list below shows what files are required when uploading the different types of content:

  • Base Graphics: one .obg file and exactly six .grf files in Base graphics packages as named in the .obg file and with the same MD5 checksums as defined in the .obg file.
  • NewGRFs: one .grf file.
  • AIs: a main.nut and an info.nut file.
  • AI Libraries: a library.nut and a main.nut file.
  • Scenarios: one .scn file.
  • Heightmap: one .png or .bmp file.


If you want to include a readme file, it needs to be named 'readme', 'readme.txt' or 'readme.pdf'.

Editing existing content

You can edit the properties of the content you uploaded earlier. Make sure you are logged in first. Click the Manager button in the menu bar. Now you'll be presented with an overview of all content you uploaded earlier.

Now click the Edit button in front of the entry you wish to, well, edit. You'll be presented with a form similar to the one for uploading new content with the only difference that not all fields are available. No you can edit the content's Description, URL, Version requirements and Dependency requirements as you see fit. Click the Edit button at the bottom to save the changes you made. If you don't want to save your changes, just navigate away from the page.

Updating existing content

It's not unthinkable that you create a new version of your content at some point in time. Using the update function allows you to replace an old version with a new one. Make sure you are logged in first. Click the Manager button in the menu bar. Now you'll be presented with an overview of all content you uploaded earlier.

Now click the Update button in front of the entry you wish to, well, update. You'll be presented with a form similar to the one for uploading new content with the only difference that the Name and Type field are unavailable. Now select the file to upload and make the necessary changes in the other field. Click the Upload button at the bottom to upload the new version.

Personal tools