Tabletop Club Documentation

Welcome to the documentation for Tabletop Club, a free and open source tabletop board game simulator! If you’re new to the project, feel free to check out the About page. Otherwise, you can use either the table of contents, the sidebar, or the search bar to find what you need!

Note

The documentation, as well as the project in general, is open to suggestions and contributions! If you feel that something is not explained well, or you think that information is missing, then please don’t hesitate to open an issue or a pull request on the project’s GitHub repository!

General

• About
  • What is Tabletop Club?
  • Frequently Asked Questions
• Download
  • Downloading the official binaries
  • Compiling from the source code
• Contributing
  • Ways to contribute
  • Pull request workflow
  • Coding guidelines

Custom Assets

• Asset packs
  • Asset pack structure
  • File types
  • Asset types
• Tutorials
  • Creating your own asset pack
  • Adding images as cards and tokens
  • Adding 3D models as objects
  • Adding audio tracks
  • Adding skyboxes
  • Adding saved games
  • Adding notebook templates

Indices and tables

• Index

• Module Index

• Search Page