Getting started
BTC Studio builds extensions for TypeWriter, the quest and storytelling engine for Paper servers. This documentation describes every extension: what it does, how to install it, and every entry it adds, field by field.
TypeWriter in five minutes
TypeWriter replaces configuration files with a web panel. You open the panel from the server (/typewriter connect), build pages made of entries, link them together, and publish: the server applies the changes without a restart.
| Concept | What it is |
|---|---|
| Page | A container of entries. Sequence pages hold dialogues and actions, static pages hold definitions (artifacts, speakers, NPC definitions), manifest pages hold things that are always active (audiences, displays), cinematic pages hold timelines. |
| Entry | One building block, identified by its type (for example schematic_block). Each entry has fields you fill in the inspector. |
| Trigger | A link from one entry to the next: an event triggers an action, which triggers a dialogue… |
| Fact | A value stored or computed per player, used in criteria to decide whether an entry runs, and changed by modifiers. |
| Audience | A filter on players (in a region, holding an item, at a quest step). Displays such as nameplates, fake blocks or HUDs are shown to an audience. |
| Artifact | Persistent data owned by an extension (placed schematics, shop stock, statistics). |
Extensions add new entry types to this toolbox. Once an extension is installed, its entries appear in the panel search bar and behind the + button of the matching page type.
Install an extension
- Install TypeWriter on a Paper server and make sure the panel opens.
- Download the extension: from its GitHub releases for free extensions, from Voxel or BuiltByBit for paid ones. The buttons are at the top of each extension page.
- Install the plugins listed under Requires on the extension page.
- Put the JAR in
plugins/Typewriter/extensions/and restart the server. - Open the panel: the new entries are available in the search bar.
Each extension page shows the version it documents and the TypeWriter version it needs. When you update TypeWriter, update its extensions to a matching release at the same time.
Find your way in this documentation
- The extension catalogue lists every extension, with filters by availability and theme.
- Each extension page follows the same structure: overview, features, installation, getting started, commands, permissions, placeholders, entries, troubleshooting.
- Each entry page shows the entry as it appears in the panel (identifier, kind, icon) and the table of its fields with their type, default value and description. These tables are generated from the extension source, so they match the released code.
| Availability | Meaning |
|---|---|
| Free | Open source, downloadable from GitHub. |
| Paid | Premium integrations, sold on Voxel and BuiltByBit. |
| Private | Runs on the BornToCraft network on the BTC build of TypeWriter; documented for reference, not distributed. |
| Soon | In development; entries can still change. |
Get help
Ask your questions on the BTC Studio Discord. For a bug in a free extension, open an issue on its GitHub repository with the extension version, the TypeWriter version and the first error of the server log.