Content indexList your mod

List your mod

Write a listing for the KSA content index, or change one that is listed. The page checks the file with the rules of the index while you type.

1Id and type

The folder name your mod installs as, which the game sees. 1 to 64 letters, digits, ., _ and -, starting and ending with a letter or digit. It cannot change later.

2Where releases come from

The index picks up each new release from this host by itself. You need to control the host, see step 13.

The number in the address of your mod on SpaceDock. SpaceDock does not let a web page read its data, so the page fills nothing from it.

3Name and description

Display names. Separate several with commas.

One or two sentences for list and search views, at most 280 characters.

Markdown. Show a description image from step 10 with ![alt text](ksa-image:<id>). Clients show no other image, and no HTML.

Preview

4License

An identifier from the SPDX license list, such as MIT or CC-BY-SA-4.0. Join several with AND, or with OR when the user may choose. A license that is not on the list is LicenseRef- followed by a name.

Required. The thread of your mod on forums.ahwoo.com. It ties the listing to your forum account and settles a dispute about the id.

6Game compatibility

A game version as the game shows it, such as 2026.9.10.5438, or a whole month, such as 2026.9.

Required. The oldest version you know your mod works on.

Leave it empty unless the mod stops working on newer game builds. Players on a newer build then get a warning before they install. Every release stamped while this is set keeps the limit, because a release can only get stricter later.

Platforms known to work (optional)

Leave all off when you know of no platform where the mod fails.

7Mod loader

Code mods need a loader. The oldest version defaults to the newest stable release of that loader.

Leave it empty unless the mod stops working with newer loader versions. Every release stamped while this is set keeps the limit, because a release can only get stricter later.

8Dependencies

Other listed mods yours works with. Code dependencies come from the mod.toml in your release by themselves, so add here only bounds or kinds the release cannot say.

9Tags

Pick at least one tag from the list. Clients filter by these. Other tags are allowed, lowercase words joined by -, but no client shows them as a filter.

10Images

Images stay on your own host. Select the file so the page can measure it, and give the https address where it is or will be. PNG, JPEG or WebP, not animated.

Icon

256 to 1024 pixels on the shorter side, the longer side at most twice the shorter, at most 256 KiB. A square icon of 512 pixels or more is best, because clients show only the square in its center.

Description images

At most 16, each at most 2048 pixels per side and 1 MiB. The description shows each with ![alt text](ksa-image:<id>).

11Check your release archive (optional)

Select the zip of your latest release. The page reads the file names in it and shows the install root the index derives. It does not download your release, the check on the pull request does that.

12Your listing file

13Open the pull request

  1. GitHub asks you to sign in, makes a copy of the index in your account (a fork) and opens the pull request form. Keep one listing per pull request, so it can merge by itself.
  2. A bot checks the file, downloads your latest release and fetches your images, then comments with its verdict.
  3. It verifies that your GitHub account controls the release host, by one of these:
    • the repository in step 2 is in your own account and is not a fork,
    • the repository carries the topic ksa-index-<your-github-username> in lowercase, which is the easy way for an organization repository,
    • the repository has a file .github/ksa-content-index.toml that names the listing id and your username.
    A SpaceDock mod proves it through the source code link on its SpaceDock page.
  4. When everything is green, the pull request merges by itself. Otherwise a steward looks at it.

Details are in CONTRIBUTING.md.