Join the Mod Showcase

To list your mod on the Mod Showcase page, open a pull request on the Gears GitHub repository. A pull request is a proposed change that the Gears maintainer reviews before merging it into the site.

The page lists mods that use Gears for their settings. Each card shows the mod's name, a short description, and an image, and links to the mod's page. A card also shows whether the mod has global settings, which players can change from the main menu or in game, and world settings, which are set for each world and can't change while the world runs. For more on both, see Choose Global or World Settings.

Before you start

You need:

• A GitHub account.
• Git installed.
• An image of your mod, such as its settings page in the Mods menu, at a 16:9 ratio. The card shows any other shape whole but smaller, with empty space at the sides or at the top and bottom.
• The URL the card should open, such as your mod's Nexus Mods or GitHub page.

To preview the page on your own computer before you submit it, you also need Node.js. Previewing is optional.

Add your mod

git clone https://github.com/<your-username>/Gears.git
cd Gears
git checkout -b mod-showcase/my-mod

export const showcaseMods: ShowcaseMod[] = [
  // ...existing entries
  {
    name: 'My Mod',
    description: 'Adds a configurable loot multiplier, set from the Mods menu.',
    image: 'My-Mod.png',
    imageAlt: "My Mod's settings page in the Mods menu",
    url: 'https://www.nexusmods.com/7daystodie/mods/0000',
    globalSettings: true,
    worldSettings: false,
  },
];

npm install
npm run dev

git add docs-site/public/images/showcase/My-Mod.png docs-site/content/mod-showcase.ts
git commit -m "Add My Mod to the Mod Showcase"
git push -u origin mod-showcase/my-mod

https://github.com/s7092910/Gears/compare/main...<your-username>:Gears:mod-showcase/my-mod?quick_pull=1&template=mod-showcase.md

Pull request template

The URL in the last step fills this in for you. If you opened the pull request another way, such as with Compare & pull request on your fork, the description starts empty. Copy this into it and replace each placeholder:

## Mod Showcase request

**Mod name:** <Mod Name>

**Does it use Gears?** <Yes or No. If yes, say which features it uses, such as global settings,
world settings, or settings read from C#.>

**Description:** <One or two sentences on what the mod does.>

**Download page:** <URL of the mod's download page, such as its Nexus Mods page>

### Checklist

- [ ] The image is in `docs-site/public/images/showcase/`, named `<Mod-Name>.png`, at a 16:9 ratio.
- [ ] The entry is added to the end of `showcaseMods` in `docs-site/content/mod-showcase.ts`.
- [ ] `globalSettings` and `worldSettings` in the entry match the settings the mod has.

• <Mod Name> is the same value as name in your entry.
• Tick each checklist item once it is true, by changing [ ] to [x].
• The description can be longer than the one on the card. Use it to give the reviewer context.
• The download page is usually the same as url in your entry.

After you submit

The maintainer reviews the pull request and may ask for changes in its comments. To make a change, edit the files on the same branch, then commit and push again. The pull request updates on its own.

Your card appears on the Mod Showcase page once the pull request is merged and the site is published.