This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
Welcome to virtualtabletop.io (VTT)!
VTT is an open-source, free to use platform for creating and playing games.
We have about 215 games in our public library that are ready to play right now and more are being added all the time. That includes classic games like Chinese checkers, backgammon, mancala, Nine Men’s Morris, Reversi, tangrams, and hangman. It includes modern games that are similar to many popular card and board games available around the world today. Most of the games are in English, but quite a few are “universal” and require no ability to read or understand English. And a handful are offered in German and Portuguese and a few more in Spanish and French. See Games for more detail.
New games may be created in VTT using a combination of drag-and-drop and writing JSON text. Capabilities added in JSON include iterating, conditional evaluations, calculations, and other things you might expect to find in a programming system. (See Functions for more detail.) The game designer can include player seats, action buttons, sound, scoreboards, and drawing canvases, in addition to many other tools. (See Widgets for more detail.)
To understand how to use VTT for playing or creating games, you should start by reading Playing Games. This will give you an overview of how VTT works as a game-playing platform, including information about loading and storing games. If playing games is the only way in which you want to utilize VTT, this should be all you need to read. But in any case we recommend joining our Discord server. There you will be able to ask questions about how VTT works.
If you want to modify an existing game, or do game development, after reading about Playing Games, you should next read Creating Games. This section will give you an overview of how to create a game, and will point you to the other sections in this Wiki that provide more detailed information. In particular, you will want to use the pages in section 2, Developer Documentation, as a reference, and we encourage you to at least read the introductory section to each of those pages.
If you want to contribute to VTT development, please read Helping Out.
Finally, we appreciate donations that go towards paying for the domain name, the servers, and additional software supporting game development. You can donate at https://www.patreon.com/virtualtabletop/about.
Enjoy! And don't be shy about asking questions in Discord; you will find a helpful and responsive audience.
Quick Links
Home
1. Basics
2. Developer Documentation
- Widgets
- Functions, automation, and routines
- Dynamic Expressions and using variables
- Math, string, array, color, JSON functions
- Cards and Decks
- Editing JSON
- Using CSS
- Fonts and Symbols
3. Available Resources
- Publicly available games
- Tutorials
- Available icons, card backs, button styles, and other images
- Demonstration Features
- Useful Code Snippets
4. Usage Guidelines and Copyrights
5. Other Technical Information
- Download Repository
- Using GitHub and creating Pull Requests
- Internals Overview
- Testing with TestCafé
- URL-addressing rooms
- Using Docker containers
- Config.json file