Skip to content

Repository files navigation

content-index

The authored half of the Kitten Space Agency content index.

One TOML document per listing, written by the person who publishes the content.

The stamped release files live in the other half, content-index-releases.

The index is defined by RFC 0031 (the metadata format) and RFC 0033 (the index itself), in content-manager-design. Design discussion belongs there, not here.

Clients do not read this repository

A client fetches one snapshot artifact, which merges both halves of the index plus the game release list into a single document:

https://ksamodding.github.io/content-index-releases/v1/index.json

Layout

Path Contents
listings/<id>.toml One authored document per mod or mod loader.
packs/<id>/<version>.toml One authored document per mod pack version.
packs/<id>/owner.json The steward-approved GitHub account that owns a pack id.
index-status.toml The index's own voice about a listing. Stewards only.
tags.toml The curated tag vocabulary that clients use for filters. Stewards only.
POLICY.md How a takedown or an id dispute is filed, and what a steward does with it.
schemas/ What a document may contain, as JSON Schema. See its README.
tools/ The checks that run on every pull request.
schemas/vectors.json Test documents with the result the checks give, which tools/test_vectors.py and the tests of the listing page both run, so the page and the checks keep one rule set.
site/ The listing page, which writes a listing or a pack version, or changes a listing, and checks it in the browser before the pull request. It also says whether a pack id is free and writes the owner record of a first pack claim. It uses the schema and tags.toml of the commit it was deployed from.

Getting listed

Write your authored document per RFC 0031, or let the listing page write it, and open a pull request that adds it. One pull request can carry several documents.

Checks validate it, a further check verifies that you control the release host the listing points at, and when everything is green the pull request merges itself.

See CONTRIBUTING.md.

Security problems in this repository, its tools, or its workflows use SECURITY.md. Problems with a listing or archive use the takedown and dispute policy.

A new release of an already listed mod needs nothing from you at all: a watcher picks it up and stamps it.

Two different things are called a license here

The license of this repository, below, covers the metadata documents.

The license field inside a listing is something else entirely: it is the license of the content that listing describes, chosen by its author. Nothing here changes it.

License

Metadata is dedicated to the public domain under CC0 1.0. That means listings/, packs/, index-status.toml, tags.toml, and the published snapshot.

A mirror, a client, or a website can therefore copy and re-serve the whole index with no conditions attached, which is the point.

Code and configuration is licensed under MIT. That means .github/ and any tooling.

About

The authored half of the KSA content index: one TOML document per listing, per RFC 0033.

Topics

Resources

Contributing

Security policy

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages