Skip to content

README.md

Latest commit

 

History

History
35 lines (22 loc) · 2.82 KB

README.md

File metadata and controls

35 lines (22 loc) · 2.82 KB
Raw

Moonfin Themes

The community theme catalog for the Moonfin clients.

License

Back to main Moonfin project

This repository holds the themes shown in the in-app Theme Store. Every Moonfin client reads index.json from here at runtime, lists what it finds, and lets you save any theme to your client so it behaves exactly like a server provided one.

Themes are plain JSON files built with the Moonfin theme editor, so you don't need to write any code to contribute one.

What is this?

The Theme Store is a browser built into each Moonfin client. It fetches the catalog manifest, shows you the available themes, and when one is chosen, it downloads the theme, validates it, and registers it locally. Saved store themes are kept separate from server pushed themes, so syncing with your server never removes them.

The catalog manifest ships with the theme. index.json is generated from the files in themes/, and every pull request carries the regenerated manifest, so main is always ready to serve.

Contributing a theme

  1. Build your theme in the Moonfin theme editor inside of the Moonfin Web client and use Export JSON.
  2. Add the file as themes/<your-id>.theme.json. The id inside the file must use lowercase letters, numbers, _, or -, and it has to be unique across the catalog.
  3. Regenerate the catalog and include it in the same commit. Run node scripts/generate-index.mjs from the repository root to rewrite index.json. Without Node on hand, skip this and open the pull request anyway, and the check in step 4 prints the file for you to paste in.
  4. Open a pull request. The Validate themes check runs automatically. It confirms every required field is present and well formed (id, displayName, all color tokens as hex, borders, and so on), and that index.json matches themes/. If anything is wrong it names the file and the field to fix, and a stale manifest comes with the expected index.json printed in the job summary.

Repository layout

  • themes/*.theme.json are the individual themes in the editor's export format.
  • index.json is the generated catalog: { schemaVersion, themes: [{ id, displayName, description, file }] }.
  • scripts/validate-themes.mjs is the required-field validator, kept in step with the clients' own parsers.
  • scripts/generate-index.mjs rebuilds index.json from the contents of themes/.
  • .github/workflows/validate.yml is the gate. It runs on pull requests and on pushes to main, and it fails if a theme is malformed or index.json no longer matches themes/.

Clients fetch the raw files directly from https://raw.githubusercontent.com/Moonfin-Client/Themes/main/.