RSDK Modding Wiki

Website with documentation, resources, and guides for Retro Engine modding, powered by Material for MkDocs and inspired by HedgeDocs.

Warning

This site is a heavy work-in-progress. Expect missing information and empty/placeholder pages. Everything is subject to change.

Contributing

This wiki is written in Markdown, just like GitHub's own Markdown files! One of the best ways to write Markdown text files is to use Visual Studio Code, which allows you to preview the page you are currently typing by pressing CTRL+Shift+V, making it easy to see how your page might look like on the website. For a more accurate look, you absolutely should setup the website locally by following the instructions in the Testing section.

We appreciate every contribution that's made to the wiki, as every single one helps the modding community to grow and make better mods.

Adding New Pages

Adding a new page to the wiki is easy! After creating a fork of this repository, edit it by following these steps:

1. Add your page in the appropriate place by editing the mkdocs.yml file. You can even create new sections if you don't see one that fits your needs!
2. Create a Markdown file in the location you specified in the previous step, and that's it!

After you added your contributions, open a pull request, and if approved, your page will be shown in the wiki for the whole world to see.

Material for MkDocs features

Since this wiki uses Material for MkDocs, you might want to check its references to better understand its features. You can use plain Markdown, but you can also use admonitions, buttons, and even icons from Font Awesome.

Testing

You can test your changes locally before committing. To do so:

• Install Python
• Install Material For MkDocs and the necessary plug-ins: pip install mkdocs-material mkdocs-glightbox --upgrade
• Serve webpage locally: mkdocs serve
  • You can also build a static site instead, using mkdocs build

The served webpage will auto refresh whenever you make changes to the files.