<p align="center">
    <img src="https://i.imgur.com/ofnNX5z.gif" alt="Nitrox Subnautica Multiplayer Mod" />
</p>

# Subnautica Nitrox
An open-source, multiplayer modification for the game <a href="https://unknownworlds.com/subnautica/">Subnautica</a>.

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/SubnauticaNitrox/Nitrox)](https://github.com/SubnauticaNitrox/Nitrox/releases)
[![Translation status](https://hosted.weblate.org/widgets/subnauticanitrox/-/svg-badge.svg)](https://hosted.weblate.org/engage/subnauticanitrox/)
[![Discord](https://img.shields.io/discord/525437013403631617?logo=discord&logoColor=white)](https://discord.gg/E8B4X9s)

## FAQ

### What is the current status?
The mod is in the very early stages of development; however, a solid foundation has been laid for the community to iterate on.
The following milestones have been completed:

* Client / Server Communication
* Player movement
* Picking up / Dropping item syncing
* Long-range world syncing
* Base building
* Furniture building
* Most furniture interactions (containers / medkit fabricators / chargers / etc)
* Power management
* Seamoth & Exosuit Syncing
* Cyclops syncing
* Chat system
* New HUD for remote players
* Basic player animations
* Integration with <a href="https://github.com/pardeike/Harmony">Harmony</a>
* Friendly Launcher
* Published on the <a href="https://nitrox.rux.gg">Nitrox website</a>

### How can I play this mod?
Please do keep in mind that this mod is still in progressional development. 

We finally have reached a stage, where we feel comfortable enough to give the public easy access to the mod by providing a launcher to use on each reoccurring update.

If you want to follow the development progress exactly on each pull request. Refer to the <a href="https://subnauticanitrox.github.io/Documentation/">docs</a> to set up a development environment where pushed updates will be synchronized automatically.

You can download the latest release of the mod on the <a href="https://nitrox.rux.gg">Nitrox website</a>.

### Problems/bugs/issues
Due to the huge influx of new players for Subnautica the Issue tracker turned into a forum instead of its actual purpose. Please join the <a href="https://discord.gg/E8B4X9s">Nitrox Discord</a> to discuss any and all issues you have with Nitrox. From there we'll pick up on new issues to track.

Keep in mind that your issue may already exist. Please refer to the existing issues on Discord if you want to add new information about existing issues. You can peruse the existing issues <a href="https://github.com/SubnauticaNitrox/Nitrox/issues">here on Github</a>.

### Translations
We have a translation platform for those of you who speak another language to work on translating the mod into your native language. You can get started at https://hosted.weblate.org/engage/subnauticanitrox/.

You'll need to sign up to start translating to a new language, or you can suggest translations for an existing language without an account (but someone with an account will have to manually verify your suggestions). This will send an email to the address you provide. Be sure check your spam folder, as Gmail can sometimes put the emails there.


### How can I contribute?
Simply submit a pull request. Full documentation & contribution guidelines can be found on the <a href="https://subnauticanitrox.github.io/Documentation/">documentation site</a>. Feel free to join us in the <a href="https://discord.gg/E8B4X9s">Nitrox Discord channel</a>.

### How can I donate?
We do not accept donations to the mod.  Those wishing to give money can do so here: https://www.doctorswithoutborders.org/

### Why the name 'Nitrox'?
Nitrox is an alternative air mixture, used by scuba divers, to achieve longer bottom times. As a mod, it will provide a new dimension of gameplay to extend your enjoyment.
