Skip to content

Subnautica Nitrox: Update to Nitrox 1.8.x #553

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

Open
norto22 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Subnautica Nitrox: Update to Nitrox 1.8.x #553

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,8 @@ Below is a categorized list of games with links to their respective server confi

#### [Soldat 2](./soldat_2)

#### [Subnautica: Nitrox Mod](./subnautica_nitrox_mod)

#### [Sunkenland](./sunkenland)

#### [Voyager of Nera](./voyagers_of_nera)
Expand Down
52 changes: 41 additions & 11 deletions subnautica_nitrox_mod/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,52 @@ Subnautica is an open world survival action-adventure video game developed and p
In it, players are free to explore the ocean on an alien planet, known as planet 4546B, after their spaceship, the Aurora, crashes on the planet's surface.
The multiplayer function is provided by the mod "Nitrox". This mod is still in alpha version and therefore not yet fully stable.

## NOTE
## Requirements

To download the base game, you will need to authenticate against Steam.
Because of the normally active Steamgaurd protection, it is important to enter the Steamgaurd code.
Once the initial installation is complete, you will need to enter the Steamguard code that will be emailed to you and then reinstall the server.
- **Nitrox 1.8+** — older versions are not supported by this egg.
- A Steam account that owns Subnautica. The account must use **email-based** Steam Guard; the authenticator app is not supported by SteamCMD's `+set_steam_guard_code` flow.

This will only work if you receive Steamguard codes via mail. The Authenticator app is not supported.
## Steam Guard install flow

## NOTE 2
Steam Guard codes are single-use and expire quickly.

NitroxMod version >=1.5.0.0 is required for this egg
1. Trigger the first install with `STEAM_GUARDCODE` blank. SteamCMD's login will fail and Steam will email a fresh code to the account owner.
2. Paste that code into the `Steam Guard Code` variable on the server's Startup page.
3. **Reinstall** the server — the install script consumes the code and downloads Subnautica.
4. Clear the `Steam Guard Code` field after the install succeeds; it's not needed on subsequent boots.

## Server Ports

The nitrox server requires only the default Server port.
Nitrox uses a single UDP port. Pterodactyl's default allocation is assigned automatically.

| Port | default |
|--------|---------|
| Server | any |
| Port | Default | Protocol |
|--------|---------|----------|
| Server | any | UDP |

Make sure the allocation includes UDP. Nitrox 1.8 removed the old "must be ≥1024" port restriction, so any free port the node allows is fine.

## Save folder

The save folder is hardcoded to `nitrox_world` (visible in the `Save Name` variable as read-only). Files live under `NitroxData/saves/nitrox_world/`. The `Save Name` variable is locked because Pterodactyl's config-file parser does not template variables inside file paths — changing it would break the panel's ability to manage `server.cfg`.

## Configuration

The egg manages these `server.cfg` keys from variables (no need to hand-edit unless you want options the egg doesn't expose):

- `ServerPort` (from the panel's allocation)
- `SaveInterval`, `DisableAutoSave`
- `ServerPassword`, `AdminPassword`
- `GameMode`, `SerializerMode`
- `MaxConnections`, `DefaultPlayerPerm`, `DisableConsole`
- `AutoPortForward`

The full `server.cfg` lives at `NitroxData/saves/nitrox_world/server.cfg`. Editable through the panel file manager when the server is stopped. Other Nitrox config keys not exposed as variables can be edited directly there.

## Known limitations

- **In-game console is not interactive from the panel console.** Typing `/op`, `/kick`, etc. into Pterodactyl's web console will not reach Nitrox. This is upstream — Nitrox's `ConsoleInputService` requires raw-mode terminal behaviour that Pterodactyl Wings' TTY doesn't currently provide. A yolks-level wrapper is being tracked in the Pterodactyl community. The server itself works fine; admin commands must currently be issued in-game by a player with admin permissions.
- **Graceful stop uses SIGINT, not the `stop` console command.** Consequence of the above. Pterodactyl's Stop button still works — the egg's stop configuration is set to `^C`, which .NET Generic Host catches and converts into a clean save + shutdown.

## Updating Nitrox

Set the `Nitrox Version` variable to `latest` (default) and reinstall to pull the newest release. Pin to a specific tag (e.g. `1.8.1.0`) if you need to lock the version — see [Nitrox releases](https://github.com/SubnauticaNitrox/Nitrox/releases) for tags.
Loading