Tags

You can attach tags to various entities in order to modify their behavior. Tags have three main uses:

  • For snap points, tags can define what objects can snap to a particular snap point.
  • For containers, tags can define what objects can be inserted into the container.
  • In the container explorer, stack explorer, and object library, the search will find objects where a tag matches the search term in addition to objects where the name matches.
Editing tags

There are a couple of places where you can edit tags:

  • In the in-game object properties, you can set which tags an object has.
  • In the in-game object properties for a container, you can also set the container tags: they determine what objects can be inserted into the container. If the container tags are not empty, only object that have at least one matching tag can be inserted.
  • In the editor object properties pane, you can set the default tags for objects of this type. A newly created object will have these tags, but they can be modified in the in-game object properties.
  • In the editor snap points pane, you can set tags for each snap point. If tags for a snap point are not empty, only objects that have at least one matching tag can snap to the snap point.
  • In the editor for card objects and similar types like tiles or tokens, you can set tags for each image index in the deck. Card tags are used in the card stack explorer window to quickly find cards with a tag that matches the search term. If an object is a single card (and not a stack of cards), the tags used for snapping and containers will be combined from both the object tags and the card tags for this card.
    When you use tags from scripting, myCard.getTags() returns only the object tags, and the card tags are accessible using CardDetails.tags, for example myCard.getCardDetails().tags for a single card.

The tag editor always shows all tags that are in use for the current game (when used in-game or in preview mode) or the current package (when used in the editor). This allows you to quickly find and activate tags that are already used elsewhere. To create a new tag, enter the name in the search field and press enter or the “Plus” button.

Playtesting and playing with private packages

Not all games you create should be accessible for everyone, or you may have a prototype that you want to test that isn’t ready to go public yet. You can make your package private by checking the “Private” checkbox when you upload you package in the editor. If you want to make it public later, uncheck the checkbox when uploading a new version or change the visibility in the Edit section of the mod.io page of your mod.

If you want to play with others while your package is still private, you can use preview feature of mod.io. It allows you to add other users who will have access to your package directly, or generate a preview link that others can use to subscribe. To add other users to for your mod, open the mod.io page, go to “Package Admin”, then “Preview”, and change the “Enable preview link” option to “Users with access only” and press Update. You can then add users by their mod.io username (identical to their Steam or Epic username if they haven’t changed it). They can then subscribe to the package through the mod.io page when they are logged in with their Steam/Epic account, or in-game when they try to join a game that uses your private package.

Instead of adding users manually, you can also use preview links: Change the “Enable preview link” option to “Anyone with preview URL” and press Update. You’ll see a link below that you can share with your players. If they are logged in using their Steam account (or Epic if they own Tabletop Playground on Epic Games Store or Microsoft store), they can subscribe and the package will be downloaded in-game. Since the preview links work through the regular browser, make sure that your players are logged in to mod.io with their Steam/Epic account! If they have already created an account using their mail address, they can link it with their Steam/Epic account by clicking on their user name in the upper right and selecting “My Account”. At the bottom of the page there’s a “Connected Accounts” section, switching on the Steam or Epic icon will open a prompt asking them to log in with their account.

You can find more information about previews in the mod.io blog post: https://blog.mod.io/insider-invite-now-live-on-mod-io-c3c2d6568d3f

Community Resources

The most important place to find creations by the community is the game’s mod.io page, where you’ll find all games, expansions, and object libraries: https://tabletopplayground.mod.io. You can find guides and useful hints created by the community in two places:

On mod.io: https://tabletopplayground.mod.io/guides
And on Steam: https://steamcommunity.com/app/838410/guides/

If you want to add your own guides, mod.io is the better place: future players who might not use Steam will be able to find your content there, too.

If you’re looking into scripting, there’s a big tutorial series on YouTube by a community member available: https://www.youtube.com/playlist?list=PLAKrIav6IfnGWY-pERe1B9q55vRvznSQe

Beginner’s Guide

Looking to get started with Tabletop Playground as a player? Read on for a how-to on accessing the powerful community creations at your fingertips!

When you start up Tabletop Playground, you’ll be greeted with a few options for starting, joining, and browsing games, as well as a tutorial. We absolutely recommend you complete the tutorial before beginning your own game as it’ll teach you the basics of how to interact with the objects within TTPG’s gametypes. After that, you’re ready to dive in.

Starting a Game

When you select the “start game” prompt, you’ll be greeted with a window covering various tabs, gametypes, and also any custom game types you have downloaded. For now, let’s take a look at the “classic” tab.

This tab features fully-functional gametypes of some classic board games. If you like to kick it old-school, you’ll find all the usual options presented here, ready to pick up with some friends and play! 

However, chances are, if you’re reading this guide, you’re looking for something more, and that’s where TTPG’s great partnership with mod.io comes in! Select the “Find more games…” option to open a Steam browser that’ll take you right to TTPG’s mod.io hub! Just click on the button to link your Steam account to mod.io and you’re all set. If the Steam browser is not available (for example on Mac), your regular browser will open instead. Click on Login and then select “Sign in with Steam”.

On this hub, you can choose from the hundreds of community creations for gametypes, widgets for existing games, and assets for use in your own creations! Subscribing to an option by pressing the red subscribe button in this browser will automatically download the content in-game, so once you’ve subscribed to your chosen game, you will see it downloading in the upper left corner of the screen and then you’re all set!

Going back to “Start Game”, you can now select your new content from mod.io. Games started from this menu can be set-up with passwords, maximum player counts, and other options, so you’re covered whether you’re looking for a private match amongst friends or an opportunity to meet new people over the medium of board games.

Joining Games

When pressing the Join Game option, you’ll be presented with a server browser window.

On this window, you’ll have various options for filters that will narrow down your search terms. Most of TTPG’s community create private games for use amongst friends, but don’t worry! Community sources often host public games, and you can organise these events yourself on our Discord server: https://discord.com/invite/tabletop-playground 

When joining someone else’s game, please be respectful! If you’re unfamiliar with the game, be polite in asking how to play, and allow everyone to take part in the fun. Meanwhile, chat and voice chat are available within games, so when using this feature, please bear in mind the same kind of common sense rules you’d find within any other chatroom, as well as the rules we have over on our Discord server.

If you want to play with your friends, make sure that everyone has activated mod.io and then start your game with a password. Your friends can join you by finding your game in the server browser, or directly through the Steam friends list.

We hope this guide has been helpful and if you have any further questions, don’t hesitate to ask over on our official Discord server: https://discord.com/invite/tabletop-playground 

Working on packages together

If you want to work on a package with multiple people, there are a few things that you need to take care of:

  • Make sure that everyone who should edit the profile on mod.io or upload new vesions is a manager or administrator for the mod. On the mod.io page for your package, go to “Edit”, then “Team” to add team members and assign roles.
  • Packages that you subscribe to through mod.io are not directly editable, and automatic updates would overwrite changes of the other when mod.io updates the package. No team member who edits the package should subscribe to it. Instead, you’ll need to share the files in another manner, for example by downloading the zip files from the mod.io page. Unzip the file into a new folder your package directory (configurable in the game settings). It will appear in the editor and you will be able to upload new versions if you are part of the team as described above.
  • Coordination can become difficult when multiple people are working on the same files. Consider using Git to help (together with GitHub, for example). It works well for scripts and template files, but for save states and resource files like textures and models, you’ll still need to make sure that only one team member works on the same file at the same time. You can also consider using a service like DropBox to keep the package folder in sync for multiple users – Git offers more flexibility, but is also more complex to use.

Playtesting

You may also want to do playtesting sessions without making the package publicly available. You can upload your package to mod.io privately – no one else will be able too see it. In order to play with others, you have different options to allow them to subscribe to your game, see the article on Playtesting.