Skip to content
DreamWeave Mod Template

Guide

Make a mod page, publish releases, and put a mod on the DreamWeave network.

The DreamWeave Mod Template turns a repository into three things at once: a mod page people can read, archives people can install, and a set of static files that tools can read without scraping either. You write two files per mod. Everything else is generated, checked, and published by the workflow.

One repository, three audiences

What you write, what the tooling checks and generates, and who reads the result.

  1. source

    You write

    content/<mod>/index.md for people, content/<mod>/mod.toml for facts, and the mod's files beside them.

  2. tool

    CI checks and packages

    Validates every push, packages byte-reproducible archives with offline docs, records each tagged release in mod.lock, writes the manifests.

  3. result

    Zola renders

    The mod page, its docs, its changelog and the network page, from the same mod.toml and mod.lock. zola serve shows it locally.

result

Players

Read the page, download the archive, follow the install section.

service

Clients and indexes

CHIMERA, St4sh and anything else read dreamweave.json and the manifests. No HTML scraping.

cache

Mirrors

Serve the same bytes under the same SHA-256. They never become the authority.

How the pieces relate
  • You write CI checks and packages
  • CI checks and packages Zola renders
  • Zola renders Players
  • Zola renders Clients and indexes
  • Clients and indexes verify by hash Mirrors

If this is your first mod on the template, read Start here and stop when your page is up. Come back for Releases when you have something to release. The protocol pages are for people writing tools that read what the template publishes; you do not need them to publish a mod.

Start here From Use this template to a published mod page in about fifteen minutes. Project pages Which file owns which fact, and every section a project page can show. mod.toml reference Every key, its type, its default, and what it means. Releases Versions, channels, tagging, yanking, and what CI does with a tag. Packages Flat, BAIN and FOMOD archives, programs built per platform, Rust libraries on crates.io, components, what ships, and why archives are not compressed. Dependencies Requirements, integrations, conflicts, capabilities, and the constraint grammar. Distribution Artifacts, digests, sources, mirrors, and where Nexus and GitHub fit. Discovery How a tool starting from your page's address finds everything else. Provenance What hashes and signatures prove, what they do not, and how keys are meant to work. The network How clients, indexes and mirrors use what this site publishes, and how to check you are ready. Customizing Palettes, brand tokens, fonts, the logo and hero art, templates, comments and analytics. Migrating from V4 Move a V4 or V3 site, St4sh-sized or not, onto mod.toml without losing its history. Architecture What each part owns, what gets generated, how the protocol evolves, and the designs we rejected. Protocol The DreamWeave mod distribution protocol, schema_version 2, for people implementing clients, indexes and mirrors.