Skip to content

An open-source platform for playing tabletop games in a physics-based 3D environment for Windows, macOS, and Linux! Made with the Godot Engine.

License

Notifications You must be signed in to change notification settings

FionaFR/open-tabletop

 
 

Repository files navigation

OpenTabletop

An open-source platform for playing tabletop games in a physics-based 3D environment for Windows, macOS and Linux! Made with the Godot Engine.

Screenshot of gameplay

Custom Assets

While the game has some of the most common tabletop pieces included, this game allows you to create and play with your own custom assets! See the assets guide for more information.

Compiling

To build the game from source, you'll need to download and compile a slightly modified version of the Godot Engine - the reason is because the game needs the ability to import resources like textures at runtime which, firstly, isn't available in GDScript, and secondly, isn't available outside of the editor.

  1. Download the modified version of Godot:
git clone https://github.com/drwhut/godot.git -b tabletop-3.2.3
cd godot
git submodule update --init
  1. Compile Godot for your platform (see the Godot documentation for more information).

  2. Download the game:

cd ..
git clone https://github.com/drwhut/open-tabletop.git
cd open-tabletop
  1. Generate the OpenTabletop assets:
pip install Pillow
cd assets/OpenTabletop/cards
python generate_cards.py
cd ../tokens/cylinder
python generate_chips.py
  1. Open the built editor, and import the project at open-tabletop/game!

Running a dedicated server

For the multiplayer, this game uses a dedicated server/client model, meaning the server isn't displayed as a player in the game, and the first client that connects to the server is set as the host of the game.

If you want to host a dedicated server, and you haven't got a Server build of the game (which is only available on Linux), then you can make your version of the game a dedicated server by copying the game/server.cfg file into the directory where the executable is. Then, if you have a Release build of the game, launching the game will launch a dedicated server automatically, and if you have a Debug build of the game, a button will appear on the main menu allowing you to launch a dedicated server.

Contributing

Want to help contribute to the project? Have a look at the contributing guide!

About

An open-source platform for playing tabletop games in a physics-based 3D environment for Windows, macOS, and Linux! Made with the Godot Engine.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • GDScript 98.2%
  • Python 1.8%