Skip to content

Commit

Permalink
format changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Metious authored Jun 24, 2022
1 parent 7279585 commit 82ff737
Showing 1 changed file with 11 additions and 13 deletions.
24 changes: 11 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# QModManager

The [Subnautica modding discord](https://discord.gg/UpWuWwq) has the most up-to-date information and is the best place to ask for help.
The [Subnautica Modding Discord](https://discord.gg/UpWuWwq) has the most up-to-date information and is the best place to ask for help.

### What is this?

Config based patch management for Subnautica and Subnautica: Below Zero

## How do I install it?

### Mod Manager
### Manual - Mod-Hosting Websites

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

Subnautica

Expand All @@ -22,15 +22,15 @@ Below Zero
* [Thunderstore](https://belowzero.thunderstore.io/package/Subnautica_Modding/QModManager_BZ/)
* [Nexus](https://www.nexusmods.com/subnauticabelowzero/mods/1)

### Manual
### 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/
Expand All @@ -44,16 +44,16 @@ 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
{
"name": "example_mod",
"nitroxcompat": true
"Id": "MyMod",
"NitroxCompat": true
}
```

## How do I create a mod?

mroshaw created an [excellent guide](https://mroshaw.github.io/Subnautica) to get started.
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.

Expand All @@ -63,8 +63,6 @@ There are a few places to publish mods.

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

Note: Many mods (such as Nitrox) have decided not to publish on Nexus Mods due to their [Terms Of Service](https://help.nexusmods.com/article/18-terms-of-service#RightsYouAre), which state they "may retain your content indefinitely and are not obliged to delete your content if you so request".
* [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).
For more questions, please [consult the wiki](https://github.com/SubnauticaModding/QModManager/wiki) or ask a question on [the Discord](https://discord.gg/UpWuWwq).

0 comments on commit 82ff737

Please sign in to comment.