Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add more beginner info to the README #276

Merged
merged 3 commits into from
Jun 24, 2022
Merged

Add more beginner info to the README #276

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f097b9d
Add more beginner info to the README
celvro May 13, 2022
7279585
Add below zero to the mod managers
celvro May 13, 2022
82ff737
format changes
Metious Jun 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
70 changes: 66 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,68 @@
## QModManager
# QModManager

### Config based patch management for Subnautica and Subnautica: Below Zero
___
The [Subnautica Modding Discord](https://discord.gg/UpWuWwq) has the most up-to-date information and is the best place to ask for help.

**For instructions on how to create a mod, see the [wiki](https://github.com/SubnauticaModding/QModManager/wiki)**.
### What is this?

Config based patch management for Subnautica and Subnautica: Below Zero

## How do I install it?

### Manual - Mod-Hosting Websites

QMods is available for several mod-hosting websites. Typically they will install QMods for you as a dependency of whichever mod you download.

Subnautica

* [Thunderstore](https://subnautica.thunderstore.io/package/Subnautica_Modding/QModManager/)
* [Nexus](https://www.nexusmods.com/subnautica/mods/201)

Below Zero

* [Thunderstore](https://belowzero.thunderstore.io/package/Subnautica_Modding/QModManager_BZ/)
* [Nexus](https://www.nexusmods.com/subnauticabelowzero/mods/1)

### Manual - GitHub

Extract the relevant [zip file](https://github.com/SubnauticaModding/QModManager/releases) into the `Subnautica` directory. There are several zip files, one for each version of the game.

* Subnautica - SN.STABLE
* Below Zero - BZ.STABLE

You will end up with a folder like this:
```markdown
Subnautica
- QMods/
- BepinEx/
- doorstop_config.ini
- winhttp.dll
- Subnautica.exe
```

Each mod should have one folder in the `QMods` directory.

## Does it work with Nitrox?

Each mod needs to specify that it's compatible with Nitrox in their "mod.json" file.
```json
{
"Id": "MyMod",
"NitroxCompat": true
}
```

## How do I create a mod?

Mroshaw created an [excellent guide](https://mroshaw.github.io/Subnautica) to get started.

For more links check the [#modding-resources](https://discord.com/channels/324207629784186882/664594296778915850) channel on discord.

## Where should I publish my mod?

There are a few places to publish mods.

* [Thunderstore](https://subnautica.thunderstore.io/)
* [Nexus](https://www.nexusmods.com/)
* [GitHub](https://www.github.com/)

For more questions, please [consult the wiki](https://github.com/SubnauticaModding/QModManager/wiki) or ask a question on [the Discord](https://discord.gg/UpWuWwq).