Publishing
When your mod works in game, tell your agent Prepare this mod for publishing. It fills in the manifest, builds the release packages and shows you exactly what would ship. Nothing is published until you say so.
Your Mod's Own Identity
Your mod is not KAGRENAC. It has its own public GitHub repository, id, name, named server and database, set when your agent created it. Server and game mod live in that one repository and are released as separate packages.
One Manifest
dwemer-mod.json in the repository root describes the whole mod. Releases use version 2, which adds the game and what goes into each package. The launcher's mod card shows:
- Title from
name, with the game fromgame.namebelow it. - "By ..." from
author, or the repository owner if it is missing. - Icon and banner from
assets.
Older version 1 manifests still install as branch installs, through their own route. Do not mix version 2 fields into them. The full format is in docs/PUBLISHING.md.
Server And Game Packages
- Server package comes from committed source, never from uncommitted changes.
- Game package comes from the game-side build, which stays outside the source folder.
- Include and exclude lists choose the files for each package. Exclusions win.
Leaving a file out of a package does not make it private: anything in a public repository stays public.
Package, Review, Publish
- Package. The agent builds both ZIPs and a release record with the source commit and file hashes.
- Review. Check both ZIPs' file lists for anything private, and test the packaged server and game mod.
- Publish. Only with your explicit go-ahead, the agent publishes a GitHub release and adds the
kagrenac-modtopic, which lists the mod in the launcher's Browse mods.
Being listed is not a review or an endorsement. Never republish a version with different files. The commands are in docs/PUBLISHING.md.
What Players Do
Players install your server from the launcher, then download your game mod; see Install a published mod. The launcher does not add or enable the game mod, so your release page must say how to install it, including any loader, load order or in-game enable step, and which API keys to enter on the dashboard.
Icon And Banner
- Use a square icon and a wide banner of about 2:1, each a committed PNG or JPEG under 4 MB.
- Replace the KAGRENAC icon with your own.
Private Data
Never commit, package or publish the server's private config, the game mod's connection file, backups, database dumps or logs. They hold your token and keys. Keep public docs free of personal names, local paths and private addresses.
Licence
KAGRENAC is licensed GPL-3.0-only. A mod built from it must follow those terms, including offering source with any binaries you share. Keep the existing licence files and notices, and add your own copyright.
Your Own Branding
Give your mod its own name, icon, banner and dashboard look. The full list of what to change is in MAKE_IT_YOURS.md.
Back to: KAGRENAC guide overview.
KAGRENAC
Get started