Packages
A package is a set of files picked out of a project, with the file types they need, versioned and shared so other creators can install it into their own projects. Where publishing a world shares the whole thing, a package shares one reusable piece: a spell list, a bestiary, a combat system with its sheets. Installed files work like files you made.
Packages are made, installed and managed in Packages in the workspace's left rail.
What a package carries
Files and the file types they need, nothing else. GM instructions, player options, tracker templates and project settings belong to the world and aren't packaged. To share how a system plays, write its rules as files the GM can look up, and publish the GM instructions with a world or system.
Creating a package
Only the project's owner can create and edit its packages; editors can install, update and uninstall them. A new package starts as an empty draft with a name, a description and a cover image. Add files by dragging them in, or by picking whole folders or single files. Remove a file from the package without touching it in the project.
Doing it well: pick a slice that stands alone. Include what its files point at (a spell list needs the classes it names), and leave out what only makes sense inside your world.
Publishing a package version
Freezes the package's files and details as v1, then v2, v3 …, with optional release notes. Edits after that stay in the draft until the next version. Installers always get a version, never the draft, and someone on v2 keeps exactly v2 until they update.
Package visibility
Each package has its own visibility, apart from its project's: Private (only you), Unlisted (anyone with the link) or Public (listed with the community's packages). Your own packages, from every project, are listed together, so you can reuse one in a new project without making it public. Its link works once it has a version and isn't private. A public package's versions get the same content review and rating as a public world.
Installing a package
Copies a package's latest version into your project. Before you confirm, you see the version, the number of files, and any file type that will be added under a new slug. A package with no version can't be installed.
- Folders keep the shape they had. A folder you already have with the same name is reused.
- File types come along: see File type matches.
- A file you already have with the same name and type is skipped, not doubled, and the summary lists it.
- Installed files are ordinary files. Edit them, link to them, and the GM uses them in play.
File type matches
Each file type in the package is matched to yours by its identifier (slug) before anything is written:
| Match | When | What install does |
|---|---|---|
| New | You have no type with that slug | Adds the package's type |
| Compatible | You have one with the same stored fields | Uses yours |
| Renamed | You have one with the same slug but different stored fields | Adds the package's under a numbered slug (character-1) and leaves yours alone |
The name, the layout, computed fields and the other display settings never force a rename, since they don't change what a file stores. Installing never changes a file type you already have.
Updating an installed package
Replaces the files of your installed version with the latest version's. If you edited any of them, you are shown which ones first, so you can copy your changes somewhere safe. Files you made yourself are never touched.
Uninstalling a package
Deletes every file the install brought in, permanently, edited ones included (they are flagged in the list first). Folders it made that are now empty go too, and file types it added that no file uses any more go to the trash. To keep an installed file, copy its content into a file of your own first.
When the author deletes a package
Nothing leaves your project. Its files stay and keep working, but it can't be updated any more. Uninstall it to clear them out.
Reporting a package
A public package that breaks the content policy can be reported from its page. The Craft team reviews every report.