Structure

Repo File Tree

📂 <repo-name>
    ├ 📂 actors
    │   └ 📂 <actor-name>
    │       ├ 📂 multisided (token image is only in folder if multi-sided)
    │       |   └ 🎨 <##>.webp
    │       ├ 🎨 token.webp
    │       └ 🎨 avatar.webp    
    ├ 📂 audio
    │   └ 📂 <playlist-name>
    │       └ 🎼  <track-name>.mp3/ogg
    ├ 📂 data (.db files)
    ├ 📂 journals (images for journal entries)
    │   └ 📂 <folder-name> (usually a chapter name)
    │       └ 🎨 <descriptive-name>.webp
    ├ 📂 scripts
    │   ├ 📜 module.js
    |   └ 📜 world.js    
    ├ 📂 styles
    │   ├ ✨ ws.css
    │   └ 🎨 ws.svg
    ├ 📂 packs (.db files)
    ├ 📂 scenes
    │   ├ 📂 backgrounds
    │   ├ 📂 thumbs
    │   └ 📂 tiles
    ├ 🎨 cover.webp 
    ├ 📄 module.json
    ├ 📄 world.json
    ├ ⚙️ .editorconfig
    ├ ⚙️ .gitattributes
    ├ ⚙️ .gitignore
    ├ 📄 CHANGELOG.md
    ├ 📄 README.md
    ├ 📄 LICENSE
    └ 📂 .git
        └ (git's metadata; DON'T TOUCH)

File Description

Check out our template for a full example which you can copy to get started quickly!

Folder/File	Description
actors/	A folder with actor tokens and avatars
audio/	A folder with audio tracks
data/	A folder with database files for the world
journals/	A folder with images for the the journal entries
packs/	A folder with database files for the module
scenes/	A folder with images for the scenes
scripts/	A folder with JavaScript world scripts and macros
styles/	A folder with CSS stylesheets and SVG icons
.editorconfig	Configures your editing environnement (example)
.gitattributes	Instructs git on how to manage specific files (example)
.gitignore	A list of file types that will be ignored in commits (example)
CHANGELOG.md	Includes a full changelog (example)
cover.webp	A static cover image for the package
LICENSE	A license file for the package
module.json	Manifest file which defines the module (example)
README.md	A description of the package (example)
world.json	Manifest file which defines the world (example)