SuperTux Addons

Packaging your add-on

To package your add-on, you can use the "Package Add-on" option in the main level editor menu.

Additional information for add-on .nfo files

Add-on .nfo files look like this:

(supertux-addoninfo
  (id "octo-levels")
  (version 1)
  (type "worldmap")
  (title "Octo's Levels")
  (author "Octo")
  (license "GPL 2+ / CC-by-sa 3.0")
)

The id is a identifier for this add-on, it has to be unique across all addons, as it is used to compare the addons with new ones from other sources to find updates. It is recomment to use something like "{author}-{title}". The id must be all lowercase and only contain characters of the set "[a-z][0-9]-", underscore is not allowed as it is used for the version number.

The version number is a simple integer, it should be increased each time the add-on is changed.

The type gives an indication of what is contained within the add-on, valid values are "worldmap", "world", "levelset". At the moment this is only a description for the user and doesn't have any impact on how the add-on is handled.

The .nfo file itself needs to be stored in the top-level directory of the add-on and should be named by the unique id of the add-on, i.e. /octo-levels.nfo in this example.

Adding/Updating an add-on

To update an add-on in the repository, you would need to submit a pull request. The pull request should contain two commits:

1. Adds/replaces the archive of your add-on, contained in the repository/ directory with a new one, which contains your changes. Optionally, also adds any screenshots to represent the add-on under a directory in screenshots/, where the directory name is the add-on ID.
2. Edits the index.nfo for the latest SuperTux version, by adding/modifying the entry for your add-on. This will allow it to be downloaded from the in-game add-on manager.

An add-on data entry looks like this:

(supertux-addoninfo
    (id "addon-id")
    (version addon-version)
    (type addon-type)
    (title "addon-title")
    (description "addon-description")
    (author "addon-author")
    (license "addon-license")
    (screenshots
        (screenshot (url "https://raw.githubusercontent.com/SuperTux/addons/addon-commit-hash/screenshots/addon-id/addon-screenshot-file-name"))
        ...
    )
    (dependencies
        (dependency (id "addon-dependency-id"))
        ...
    )
    (url "https://raw.githubusercontent.com/SuperTux/addons/addon-commit-hash/repository/addon-file-name")
    (md5 "addon-md5-checksum")
)

• addon-commit-hash represents the full commit hash of your first commit, which adds/replaces your add-on in the repository/ directory. This is important to include, because it allows the current SuperTux release to always get its versions of all addons for backwards compatibility.
• addon-md5-checksum represents your new, modified add-on archive's MD5 checksum hash. This needs to be updated every time the add-on is updated, because the game will not be able to download your add-on otherwise. The MD5 checksum is being used for checking the integrity of the add-on.
• For the rest of the entries, the rules listed above for add-on .nfo files also apply here.