Home Explore Help
Sign In
SuperTux
/
wiki
mirror of https://github.com/SuperTux/wiki
Watch 2
Star 0
Fork 0
Files Issues 0 Wiki
Branch: master
Branches Tags
wiki
/
Home.md

Home.md 3.8 KB
Permalink History Raw

Note: This Wiki is converted from the previous Mediawiki format, this conversion is not complete, but progressed far enough that this Wiki is ready to be used again, a lot of outdated information does however remain. If you find some, don't delete it, update it and/or move it to an appropriatly titled archive page.

This Wiki is used to document the current state of SuperTux as well as keep track of proposed additions and changes.

This Wiki is targeted towards developers of the game, users are however free to check out what is going on behind the scenes.

The now unavailable old Mediawiki based Wiki has been merged into this Wiki.

Guidelines and tips for using this Wiki

  • [[News]] is for keeping track of what is going on in SuperTux development. Every substantial addition or change to the game should be documented there.

  • Do not delete information from this Wiki, prefer moving it over to [[Ideas]], [[Rejected Ideas]] or another appropriate place instead.

  • Use Markdown (.md) for the Wikipages.

  • Use line-breaks at around 80 characters, the .md files are meant to be viewed and edited in a text editor.

  • Run the validator.py in the Wiki repository to check for broken links.

  • New pages should go to the [[_Sidebar]] for easy access.

  • Prefer big pages, don't fracture content over too many small pages.

Making changes to the wiki

  • Users without write access: Directly editing this Wiki is restricted to developers, you have to submit a pull request. Go to the wiki repository and try to edit; GitHub will automatically make a fork for you. Then submit a pull request to the wiki repository through the Github UI. Or you can check it out locally and edit, it's just a git repo.

  • Developers with commit access: You can edit the wiki directly through the edit interface in the top right corner; a hook will push changes to the wiki repository. To make local changes, clone the wiki repository linked above and push as normal; a hook will push the changes to the supertux.wiki repository. Pull requests can be merged as normal, since they will also be synced via the hook. If the hook screws up, clone the wiki repo and add a wiki remote: git remote add wiki https://github.com/SuperTux/supertux.wiki.git or git remote add wiki git@github.com:SuperTux/supertux.wiki.git. Then merge the origin and wiki remotes and push to both, git pull origin; git pull wiki; git push origin master; git push wiki master. You may need to force push if you rebased instead of merged.

General Links

For Players

To learn how to play, check out the [[User Manual]].

Chat on the SuperTux Forum or our Discord.

For Level Designer

Share your levels on the SuperTux Forum with the "Add-on/Levels" tag, or our Discord and if we like the look of them, you may be able to submit levels to the official game.

Submit your own level packs or worlds to the Add-on Repository so more players can see and play your levels. More info

For Coders

Build the game, and get started.

Fix some easy bugs.