# RPG Desk

> RPG Desk is a virtual tabletop for RPGs: rooms with chat, dice, character sheets, a map with fog and vision, music and voice. This is the user documentation and the reference for creating sheets and room tables in HTML, CSS and JavaScript with rpgdesk.js.

- Sheets and room tables are web pages: a single `.html` file (or a `.zip` package), with the manifest in a `<script type="application/rpgdesk+json">` and rpgdesk.js, the library that connects the page to the room.
- To write a sheet, start with the AI guide: it has the rules and a complete example. The details are in the Creating sheets and Reference sections.
- A sheet runs in an isolated frame, with no internet and no outside libraries. The only way out is the webhooks declared in the manifest, to Zapier, Make or IFTTT.
- Button, menu and field names appear in bold, with the exact text of the English interface.

## Complete files

- [RPG Desk: complete documentation](https://docs.rpgdesk.com/en/llms-full.txt): every page, in a single file
- [RPG Desk: creating sheets and reference](https://docs.rpgdesk.com/en/llms-fichas.txt): the Creating sheets and Reference sections, with everything used to write sheets and tables
- [AI guide](https://docs.rpgdesk.com/_sdk/1/ai-guide.md): the rules for an AI to write a RPG Desk sheet, with a complete example

## Getting started

- [Getting started](https://docs.rpgdesk.com/en/comecando.md): What RPG Desk is and the first steps, for players and for game masters.
- [Create an account and sign in](https://docs.rpgdesk.com/en/comecando/conta.md): How to create your RPG Desk account, sign in, stay signed in and change the language.
- [The home screen](https://docs.rpgdesk.com/en/comecando/tela-inicial.md): The navigation bar on the left and Home, with your last room and your rooms.
- [Find a room and join](https://docs.rpgdesk.com/en/comecando/explorar.md): Explore: the room lists, the filters, each room's details and how to join.
- [Create your room](https://docs.rpgdesk.com/en/comecando/primeira-mesa.md): For game masters: create the room, invite the players and get everything ready for the first session.
- [Profile, friends and conversations](https://docs.rpgdesk.com/en/comecando/perfil-e-amigos.md): Your public profile, the Friends & chat panel, friend requests, conversations and table invites.
- [Desk Cloud](https://docs.rpgdesk.com/en/comecando/arquivos.md): Desk Cloud: your maps, tokens, tracks and documents, in folders, with the rooms that can open each one, the trash and right-click menus.
- [Plans and space](https://docs.rpgdesk.com/en/comecando/planos.md): RPG Desk plans: Free and plans 1, 2 and 3, the space and largest file of each one, and what happens when the plan changes or ends.
- [Your preferences](https://docs.rpgdesk.com/en/comecando/configuracoes.md): Settings: profile, account and plan; language, chat, dice, notifications, audio and video; and troubleshooting, with search.
- [On your phone](https://docs.rpgdesk.com/en/comecando/celular.md): RPG Desk on a phone: installing it as an app, the bottom bar, the room tabs and the gestures (tap, hold, pinch).
- [Server administration](https://docs.rpgdesk.com/en/comecando/administracao.md): The area for whoever runs an RPG Desk server: the overview, the accounts, the plans, the rooms, the server's configuration and the log of what was done.

## In the room

- [The room screen](https://docs.rpgdesk.com/en/mesa.md): How a room is laid out: the tabs, which fit into spaces, the room menu with its Tabs, dragging tabs and spaces, and arranging the screen with Ctrl+E.
- [Chat](https://docs.rpgdesk.com/en/mesa/chat.md): Talking in the room: messages, formatting, narrator and NPCs, files, mentions and private conversations.
- [Dice and rolls](https://docs.rpgdesk.com/en/mesa/dados.md): How to roll dice in RPG Desk, how to read the result, the 3D dice and customizing your dice.
- [Library](https://docs.rpgdesk.com/en/mesa/biblioteca.md): The room's library: sheets, folders and scenes, how to open and organize them, and what each person sees.
- [Character sheets](https://docs.rpgdesk.com/en/mesa/fichas.md): Creating a sheet, filling it in, rolling from it and choosing your main character.
- [Participants](https://docs.rpgdesk.com/en/mesa/participantes.md): The list of who is in the room: the cards, the health bars, the lines, your picture in the room and each person's menu.
- [Scene and map](https://docs.rpgdesk.com/en/mesa/cena.md): Using the scene as a player: moving your token, measuring distances, pinging, drawing, opening doors and seeing through the fog.
- [Voice and video](https://docs.rpgdesk.com/en/mesa/voz.md): The room's conference: joining, turning the microphone and camera on, and choosing the devices.
- [Music and sound effects](https://docs.rpgdesk.com/en/mesa/musica.md): The room's soundtrack: what players hear and control, and how the game master builds the playlist and the sound effects board.
- [Windows and several rooms](https://docs.rpgdesk.com/en/mesa/janelas.md): Opening windows that work like the room, taking spaces and tabs to them (another monitor) and being in more than one room at the same time.
- [Macros](https://docs.rpgdesk.com/en/mesa/macros.md): Your own commands, with one word: a macro keeps chat lines and rolls and runs them all with /name.

## For game masters

- [For game masters](https://docs.rpgdesk.com/en/mestres.md): What the game master controls in RPG Desk: the room, roles, the players' sheets, the scene, combat, plugins and integrations.
- [Room settings](https://docs.rpgdesk.com/en/mestres/configurar-mesa.md): The room's settings: profile, cover and status, game rules, plugins, password, chat history, assistant game masters, bans and deleting the room.
- [Roles and moderation](https://docs.rpgdesk.com/en/mestres/papeis.md): Game masters, players and spectators; silencing, hiding the chat, moderating, kicking and banning.
- [Players' sheets](https://docs.rpgdesk.com/en/mestres/fichas-dos-jogadores.md): Creating sheets for players and handing them out, choosing the main character, changing the owner and deciding what each person sees.
- [Game rules](https://docs.rpgdesk.com/en/mestres/regras-de-jogo.md): The bars (health, energy…) and text lines on the players' cards: how many show up, their names, their colors and who sees the numbers. And where the dice numbers come from.
- [Building the scene](https://docs.rpgdesk.com/en/mestres/mapa.md): Creating the scene, setting the map image, lining up the grid, configuring the scale, placing the tokens and giving them auras.
- [Fog, walls and vision](https://docs.rpgdesk.com/en/mestres/nevoa-e-visao.md): Revealing the map bit by bit with fog of war, drawing walls and doors, and making each token see only what light and walls allow.
- [Combat tracker](https://docs.rpgdesk.com/en/mestres/combate.md): The room's initiative table: actors, initiative, turns, rounds, sides, timed effects and what players see.
- [Room plugins and tables](https://docs.rpgdesk.com/en/mestres/plugins.md): Installing, updating and removing the room's sheet and table plugins, and enabling room tables.
- [Integrations](https://docs.rpgdesk.com/en/mestres/integracoes.md): Sending what happens in the room elsewhere (Discord, spreadsheets, lights) through Zapier, Make or IFTTT, with the plugins' webhooks.
- [Session clock](https://docs.rpgdesk.com/en/mestres/relogio-da-sessao.md): Marking the start, the breaks and the end of a game session: the clock everyone sees, the marks in the chat, the automatic break and the Sessions tab, with the record and the notes of each session.

## Creating sheets

- [Creating sheets](https://docs.rpgdesk.com/en/fichas.md): Room sheets and tables made with HTML, CSS and JavaScript, by hand or with help from an AI.
- [Your first sheet](https://docs.rpgdesk.com/en/fichas/primeira-ficha.md): The tutorial: from an empty file to a sheet with fields, rolls, a list and a computed field, tested in the browser and installed in the room.
- [Create with an AI](https://docs.rpgdesk.com/en/fichas/com-ia.md): Making the sheet for your system with help from an AI: RPG Desk's guide, the request, testing and how to fix what comes back wrong.
- [Fields, lists and tabs](https://docs.rpgdesk.com/en/fichas/campos.md): Everything you do with HTML attributes alone: fields of every kind, computed texts, images, lists, tabs and what each role sees.
- [JavaScript on the sheet](https://docs.rpgdesk.com/en/fichas/javascript.md): rpgdesk.js from code: connecting, reading and writing the document, following changes, computed fields and lists.
- [Rolls, chat and card](https://docs.rpgdesk.com/en/fichas/rolagens-e-chat.md): Rolling dice and talking in the chat from the sheet, filling in the player's card bars, and the interface helpers: notices, questions, menus, images and preferences.
- [Private parts](https://docs.rpgdesk.com/en/fichas/partes-privadas.md): Parts of the sheet that only the game master (or only the owner and the game master) receives: a real secret, not just hidden on the screen.
- [Room tables](https://docs.rpgdesk.com/en/fichas/tabelas.md): Pages for the whole room, open as a tab for everyone: an NPC list, initiative, a calendar. How to declare them, who writes and an annotated example.
- [Looks](https://docs.rpgdesk.com/en/fichas/visual.md): rpgdesk.css, the ready-made classes, the room's theme colors, fonts, images and how to make the sheet fit a narrow space.
- [Packages with several files](https://docs.rpgdesk.com/en/fichas/pacotes.md): The plugin as a .zip: manifest.json, several sheets and tables, separate CSS and JavaScript, images, fonts and sounds.
- [Test and develop](https://docs.rpgdesk.com/en/fichas/desenvolvimento.md): Test mode outside RPG Desk, development mode inside the room and page errors.
- [Webhooks on the sheet](https://docs.rpgdesk.com/en/fichas/webhooks.md): The sheet's only way out to the internet: declaring webhooks in the manifest and sending data to Zapier, Make or IFTTT.
- [New versions](https://docs.rpgdesk.com/en/fichas/versoes.md): Updating the sheet in the room without losing the players' data: the version, what must not change and how to migrate a renamed field.
- [Examples](https://docs.rpgdesk.com/en/fichas/exemplos.md): Ready-made, working sheets and a table: use them in your room, study the code or hand them to an AI as a starting point.

## Reference

- [Reference](https://docs.rpgdesk.com/en/referencia.md): For quick lookup: the plugin manifest, the HTML attributes, the rpgdesk.js API, the CSS, the verifier, the limits, the chat commands, rolls, shortcuts and formatting.
- [The manifest](https://docs.rpgdesk.com/en/referencia/manifesto.md): Each field of a RPG Desk plugin's manifest, what it accepts and what the verifier checks.
- [HTML attributes](https://docs.rpgdesk.com/en/referencia/atributos.md): Every data-* attribute rpgdesk.js connects by itself: fields, texts, images, lists, rolls, tabs and roles.
- [The rpgdesk.js API](https://docs.rpgdesk.com/en/referencia/api.md): Every function of the RPG Desk object and the document, with their parameters and what they return.
- [Looks (CSS)](https://docs.rpgdesk.com/en/referencia/css.md): The classes and variables of rpgdesk.css, and the room's theme colors that rpgdesk.js hands to the page.
- [The verifier](https://docs.rpgdesk.com/en/referencia/verificador.md): What RPG Desk checks before installing a plugin: each problem, by code, with what it means and how to fix it.
- [Limits](https://docs.rpgdesk.com/en/referencia/limites.md): The sizes and amounts RPG Desk accepts: packages, documents, rolls, messages, webhooks, files and rooms.
- [Chat commands](https://docs.rpgdesk.com/en/referencia/comandos.md): The commands the chat understands: rolling, narrating, laughing, clearing the chat, changing your name, leaving the room and macros.
- [Rolls](https://docs.rpgdesk.com/en/referencia/rolagens.md): The grammar of RPG Desk's rolls: dice, numbers, Fudge, ordering, successes against a difficulty, the roll's name, the limits and the error messages.
- [Chat formatting](https://docs.rpgdesk.com/en/referencia/formatacao.md): All the chat markup: italic, bold, action, speech, out of character, drop cap, headings, separators, links, mentions, style codes, the color palette and the emoji.
- [Keyboard shortcuts](https://docs.rpgdesk.com/en/referencia/atalhos.md): The keyboard and mouse shortcuts on the scene, for walls, in the chat, on the participants' bars and lines, on the room's tabs and spaces and for arranging the screen.

## Help

- [Frequently asked questions](https://docs.rpgdesk.com/en/ajuda.md): The most common questions about RPG Desk: what you need to use it, roles, dice, maps, sheets, plugins and where your data lives.
- [Common problems](https://docs.rpgdesk.com/en/ajuda/problemas.md): What to do when something does not work: signing in, the chat, tokens, tabs, sound, voice and video, sheets and plugins, files.

## Optional

- [Documentação em português](https://docs.rpgdesk.com/llms.txt): a mesma documentação, em português