Discord

Publish your mod

openmods lists mods that live in a public GitHub repository. Your AI agent prepares the repository in a few minutes. At the end, you add the mod on openmods.

  1. Create a GitHub account

    GitHub is a free website that stores projects and every version of their files. Open github.com/signup and create an account.

    Your user name becomes part of the link to your mod, for example github.com/your-name/your-mod.

  2. Let your AI agent prepare the repository

    Open the folder of your mod in your AI agent, for example Claude Code, GitHub Copilot or Cursor. Give it this prompt:

    Make this repository ready for openmods. Follow https://github.com/KintaroModding/openmods-example-mod/blob/main/AGENTS.md

    The agent follows AGENTS.md, the guide in our example repository. It:

    • puts your mod into a public GitHub repository,
    • adds an open-source license and asks you which one (see Choose a license),
    • writes openmods.json: the name, a one-line summary, the game, tags and a cover image,
    • writes openmods.md: the page that players read, with your screenshots and how to build the mod,
    • checks everything against the rules of openmods.

    Read what the agent wrote before you publish. You decide what your mod page says.

  3. Publish a release

    A release is the download package of your mod. The download button on openmods always opens your latest release.

    Your agent can create the release for you. Or do it on GitHub:

    1. On the page of your repository, click Releases, then Draft a new release.
    2. Under Choose a tag, type a version, for example v1.0.0, and create the tag.
    3. Drag the zip file of your mod into the box for files.
    4. Click Publish release.

    Each release file can be up to 2 GiB, and a release can have up to 1,000 files. A mod without a release can be listed too: its page then says "No release yet".

  4. Add your mod to openmods

    1. Sign in on openmods with your GitHub account.
    2. Open the page of your game and click Add mod.
    3. Paste the link to your repository and click Check.
    4. If all checks pass, you see a preview. Click the add button, for example Add to Stardew Valley.
    Find your game

Choose a license

The license says what other people may do with your mod. openmods lists only mods with an open-source license that GitHub can detect. These three are common:

MIT

Anyone can use and change your mod. Short and simple.

GPL-3.0

Anyone can use and change your mod, but changed versions must stay open source too.

CC-BY-4.0

For mods that are only art, such as textures or sounds. Others must name you.

To add a license on GitHub, click Add file, then Create new file. Type LICENSE as the file name, click Choose a license template, and pick a license.

Without an agent

The guide for agents is plain text, so people can follow it too: AGENTS.md lists every rule. The example repository shows the finished result.

  1. Create a public repository on GitHub: click +, then New repository.
  2. Upload your mod: click Add file, then Upload files. In the browser, each file can be up to 25 MiB.
  3. Copy openmods.json and openmods.md from the example repository, and change them to fit your mod.
  4. Add a license, then go on with steps 3 and 4.

Done! Your mod can never die

If you stop working on your mod, anyone can fork it (make their own copy) and keep it working.

To update your mod, change the files in your repository or publish a new release. openmods shows the change within minutes.