List your mod

What you list

Releases

Where the index picks up each new release of your mod. It follows the host by itself, and you have to control that host, which the last section explains.

About

Pack

A pack version goes at packs/<id>/<version>.toml and cannot change after it is merged. A change is a new version.

Members

The listed mods in the pack, each at one release. The page offers the mods of the index and their releases that are not yanked and still download, newest first. A note marks a member with a newer release that is at least as stable as its pin. The pin stays until you move it, and the page offers to move it only when the other pins accept the newer release.

The pack pins every required dependency of its members inside their bounds, and no member conflicts with another. A release that needs a mod that is not listed is marked, because no pack can pin it.

Add a member

"Add the missing dependencies" pins each required dependency that no member pins, at its newest stable release inside the bounds. When a member needs one of several mods, you choose it.

Copy the member list for your forum thread

The forum rules ask a pack thread to list each mod with its version, authors, license, download and thread. The list has one line per member.

Links

Add a link

Compatibility

Install and launch

Where a manager puts your loader, and what the player starts. Paths are relative to the install location, with / separators.

Dependencies

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.

The mods your mod needs, and only mods. A client that shares it fills this list from the mods of its instance, with min at the version it installed. The page does not read the part ids in vehicle.xml or universe.xml, so check that every mod is here, and add a mod that only changes how parts behave as recommends.

No listed mod matches.

Add a dependency

Tags

Pick at least one tag from the list. Clients filter by these. Other tags are allowed, but no client shows them as a filter. A tag is stored as lowercase words joined by -, so Space Station becomes space-station.

Images

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.

Add the icon

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>).

Add a description image

Your listing file

Copy Save

How the pull request is checked

1. GitHub asks you to sign in, makes a copy of the index in your account (a fork) and opens its editor. The button copies your file first. GitHub fills in a short new file. For a long one, paste the copy into the empty file. For a change, replace the whole old file with the copy. Several listings can go into one pull request, and it merges by itself once ownership verifies for each of them.
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 under Releases is in your own account,
   • 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. A fork proves it through its owner or the topic only, because it inherits the files of the repository it was forked from. A listing from a fork needs an id of its own.
4. When everything is green, the pull request merges by itself. Otherwise a steward looks at it.

1. GitHub asks you to sign in, makes a copy of the index in your account (a fork) and opens its editor at the path of the new version. The button copies your file first. A pack is almost always too long for the link, so paste the copy into the empty file.
2. The first version of a pack id that main does not have yet is its first claim, which also adds packs/<id>/owner.json with your GitHub login and numeric account id to the same pull request. Open the pull request with the version. The bot answers with a link that adds owner.json to it, and the checks stay red until that file is there. "Check the id" in the Pack section also gives the file. packs/README.md shows it.
3. A bot checks the files and comments with its verdict, and the checks decide what happens next. The checks of a new GitHub account can wait until a steward starts them. For a later version, choose "Change a listed one" and load the pack. Only the first version adds owner.json.

Your listing stays in this browser until you open the pull request. Details are in CONTRIBUTING.md.