Skip to main content

RPG Companion App – TTRPG Systems

Contribute on GitHub License: CC BY-NC-SA 4.0

Introduction​

The RPG Companion App is built so that anybody (really, anybody) can create TTRPG systems that are compatible with the app. This documentation aims to give you the tool to help you be able to design a system that can run in the app, host it and share it so that your players (and the rest of the world) can enjoy the system you created!

Discover & share community content

Browse systems and resource packs made by the community directly in the app, or at: ➡️ repositories.rpg-companion.app

To contribute systems: ➡️ github.com/blastervla/rpg-companion-app-systems

  • Fork the repo to start from a working example.
  • Submit pull requests to improve existing systems.
  • Licensed CC BY-NC-SA 4.0 (content) and MIT (tools).

What is a system?​

Throughout this documentation, the word system will be used to refer to an *.rpg.json file that can be interpreted by the app as a valid TTRPG system that it can run and work with.

Is it hard to create a system for the app?​

Not at all! You can make systems as simple or complicated as you want. Just give it a try, and feel free to contact Vlad (the app developer) if you need any help or run into issues. He's always happy to help. You can reach him at feedback@blastervla.com.

What if I don't want to create a system, but host resources for an existing system instead?​

This is a perfectly valid use case! You will still need to host a system, because this is a requirement. But, because the system you want to extend already exists, all you need to do is host a copy of that preexisting system, and you can add your resources under it. As long as the system you are hosting has the same id as the original one, these resources will be added to that system in the app! Just make sure not to play with the system version. You should keep the system file exactly how you downloaded it. In order to see how to host resources, take a peek at the Creating a system page.

Publishing your content​

Once your system or resource pack is ready, you can share it in a few ways:

  • In-app Publish wizard (resource packs) — tap the cloud upload icon on the Resources screen, sign in with GitHub, and the wizard will compile your resources, create a repository, and enable GitHub Pages automatically.
  • Manual hosting (systems + resource packs) — use the dev tool to generate the release package and upload it to any CDN. See Hosting a Resource Pack for the full guide.
  • Community registry — once hosted, submit a pull request to the community registry and your pack will appear in the app’s discovery browser at repositories.rpg-companion.app.

What’s next?​

Head to Creating a system to get started.