Versions and changelogs

Put out a new version of your mod, label it, say what changed, and hide or delete old versions.

Applies to
  • The site
Last checked

Every mod has versions, and every version has one main file plus up to 9 extras. A new version goes through review before it replaces the one people download. Until then the old version stays up.

Version labels

A label is 1 to 32 characters: letters, numbers, dots, hyphens and underscores. Each label can be used once on a mod, and V1.0 and v1.0 count as the same label. The upload starts you at 1.0.0.

Pick a scheme and keep to it. Three numbers work well: raise the last for a fix, the middle for something new, and the first when people have to reinstall from scratch.

Putting out a new version

  1. Open the mod from your dashboard and choose Edit, then Versions.
  2. Name the version and say what changed, then start it.
  3. Upload its files. The first file is the main one. Give each extra a label.
  4. Wait for every file to finish checking.
  5. Choose Submit. The version shows as "Waiting for review", and you get a notification when it's decided.

One version is worked on at a time. While one is waiting for review, you can't start another.

Discard throws away a version you haven't submitted yet.

Writing the changelog

The first version doesn't need a changelog. Every version after the mod is published does, and it can't be submitted without one.

A changelog can be up to 5,000 characters and takes bold, italic, links, bulleted and numbered lists, inline code and code blocks. It doesn't take headings, images or tables.

Write it for someone deciding whether to update:

  • Lead with anything that changes how the mod installs.
  • List fixes and additions as short bullet points.
  • Say plainly if an old save, config or another mod's version stops working.

"Bug fixes" on its own tells nobody anything. "Fixed the rear lightbar not showing in stage 2" does.

When a version is sent back

A version that staff reject shows as "Sent back" with the reason. Fix what the reason names, on the same version, and submit it again. You can change its label, changelog and files while it's sent back.

If the mod's very first version is sent back, the whole mod returns to being a draft until you submit again.

If you think the decision was wrong, you can appeal it once, within 30 days, from Appeals. See Why uploads are refused most often.

Old versions

Approved versions stay listed on the mod's Versions tab, each with its changelog and files.

  • Hide takes a version off the page. If you hide the latest one, the mod falls back to the version approved before it. Show again puts it back.
  • Delete hides the version at once, and its files are removed after 30 days.

A version that's waiting for review can't be deleted until it's decided.