SteonMod
Sign in
Modder2 min read

Publishing your project

A checklist for releasing a passthrough mod, rewrite or recomp so people can actually install it, and so it gets listed here.

You got it working. Here's how to ship it so players can use it and other modders can build on it.

The README checklist

Put these near the top, in this order:

  1. One sentence: what it does. ("Play Valheim as a Minecraft player.")
  2. A screenshot or short video. The first image in your README becomes the cover on this site.
  3. Status: experimental / playable / work in progress, and what's known to be broken.
  4. Exact requirements: game versions (and which store), loader versions, libraries, RAM.
  5. Install steps a non-programmer can follow. If they must build from source, say so clearly.
  6. Controls and how to turn it off.
  7. Where logs go and how to report a bug.
  8. Credits and licence, including what you based it on.

Releases

  • Use GitHub Releases with a zip, not "download the repo". The site picks up new releases automatically, notifies everyone following your project and can post them to Discord.
  • Tag versions (v0.2.0), and write short release notes saying what changed.
  • If a release only works with one game version, say it in the notes.

GitHub settings that help discovery

  • Write a clear description (the one-liner on your repo page). The crawler reads it to decide what your project is and which games it uses. "Minecraft inside Fallout 4 (F4SE plugin + Fabric mod, passthrough)" gets classified perfectly.
  • Add topics such as passthrough-mod, minecraft, skyrim, fabric, skse.
  • If you forked SkyCraft or another project, keep the fork link: the site scans forks of tracked projects for new ports.

Getting listed here

The crawler finds most GitHub projects within a day, and a moderator approves them. To be sure (or if you're not on GitHub), submit it. Mention it's yours, and you can ask a moderator for the Verified badge.

Staying online

  • Never include game files, extracted assets, executables or ROMs. Download at runtime from official sources, or read the player's own install.
  • Respect licences: keep upstream notices and attribution.
  • Don't use the publisher's logo as your project's logo, and say clearly that you're not affiliated with them.
  • If you get a takedown notice, the project page here will show it; tell your followers what happened in the forum.