Akkariin/eggs
1
0
Fork 0
mirror of https://github.com/parkervcp/eggs.git synced 2024-11-27 00:42:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
4d5d8e983b
eggs/game_eggs/steamcmd_servers/satisfactory/README.md
Red-Thirten 40e73bb26b Add Max Players & Revert Port Change 
Egg:
- Reverted the startup command so that the game port is the primary port and QUERY_PORT is the Server Query Port. I honestly think it will be confusing either way, so it's a wash for me; but ultimately, if Ptero calls the primary port the "Game Port" in Allocation Management, it should be Satisfactory's "game" port.
- Added the capability to override the server's default max players of 4. This consists of a new variable, default config file creation during install (because the server doesn't auto-create it), and a Configuration Files replacement on boot to accommodate variable changes.
- Reverted Game Port variable to Server Query Port variable.
- Changed port rules to use the more intuitive `between` rule.

README:
- Added Zarklord as a contributor.
- Added Max Players as an Egg Capability.
- Rewrote the Server Ports section (again) to accommodate the egg change and be as clear as possible.
- Added warning about stopping the server and saves.
- Added note to Minimum RAM Requirement that large saves can also cause excessive RAM usage.
- Updated Console Commands section with newly published Wiki information.
- Updated `steamclient.so` Wiki reference link (which will probably break again soon because the Wiki is being changed almost every hour now).

Co-Authored-By: Zarklord <1622280+Zarklord@users.noreply.github.com>
2021-10-28 16:27:30 -07:00

136 lines
7.3 KiB
Markdown
Raw Blame History

# Satisfactory
***Server version currently marked as experimental by the Satisfactory developers! Egg loads fine, but your mileage may vary in-game.***
___
### Authors / Contributors
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center">
<a href="https://github.com/lilkingjr1">
<img src="https://avatars.githubusercontent.com/u/4533989" width="50px;" alt=""/><br /><sub><b>Red-Thirten</b></sub>
</a>
<br />
<a href="https://github.com/parkervcp/eggs/commits?author=lilkingjr1" title="Codes">💻</a>
<a href="https://github.com/parkervcp/eggs/commits?author=lilkingjr1" title="Maintains">🔨</a>
</td>
<td align="center">
<a href="https://github.com/iamkubi">
<img src="https://avatars.githubusercontent.com/u/6176191" width="50px;" alt=""/><br /><sub><b>Kubi</b></sub>
</a>
<br />
<a href="https://github.com/parkervcp/eggs/commits?author=iamkubi" title="Codes">💻</a>
<a href="https://github.com/parkervcp/eggs/commits?author=iamkubi" title="Contributor">💡</a>
</td>
<td align="center">
<a href="https://github.com/matthewpi">
<img src="https://avatars.githubusercontent.com/u/26559841" width="50px;" alt=""/><br /><sub><b>matthewpi</b></sub>
</a>
<br />
<a href="https://github.com/parkervcp/eggs/commits?author=matthewpi" title="Codes">💻</a>
<a href="https://github.com/parkervcp/eggs/commits?author=matthewpi" title="Contributor">💡</a>
</td>
<td align="center">
<a href="https://github.com/Software-Noob">
<img src="https://avatars.githubusercontent.com/u/10975908" width="50px;" alt=""/><br /><sub><b>Software-Noob</b></sub>
</a>
<br />
<a href="https://github.com/parkervcp/eggs/commits?author=Software-Noob" title="Codes">💻</a>
<a href="https://github.com/parkervcp/eggs/commits?author=Software-Noob" title="Contributor">💡</a>
</td>
<td align="center">
<a href="https://github.com/Zarklord">
<img src="https://avatars.githubusercontent.com/u/1622280" width="50px;" alt=""/><br /><sub><b>Zarklord</b></sub>
</a>
<br />
<a href="https://github.com/parkervcp/eggs/commits?author=Zarklord" title="Codes">💻</a>
<a href="https://github.com/parkervcp/eggs/commits?author=Zarklord" title="Contributor">💡</a>
</td>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
___
### Game Description
From Coffee Stain's [Website](https://www.satisfactorygame.com/):
> Satisfactory is a first-person open-world factory building game with a dash of exploration and combat. Play alone or with friends, explore an alien planet, create multi-story factories, and enter conveyor belt heaven!
___
### Egg Capabilities
- Configuration of the Server Query, Beacon, and Game ports.
- Configurable to automatically check for server updates on start via SteamCMD. Forcing validation is also configurable.
- *[Experimental]* Max player configuration.
- Misc. settings listed below can be configured by an admin client via the game's UI, and are currently **not** set via the Egg:
- Server Password
- Admin Password
- Auto-Save on Player Disconnect
- Pause When No Players Online
- ...and possibly more as the client's UI is developed further for more configuration options.
___
### Server Ports
- Default server ports are listed below, but all three ports can be changed freely.
- **Note:** The Primary/Default/Game Port for your server in Pterodactyl will be Satisfactory's `-Port=????` game port, even though clients will **connect with the Query port**.
- It is recommended to distance ports of other running Satisfactory servers in Pterodactyl by **increments of 100** (it is currently unknown what the minimum increment is, but an increment of +1 caused cross-server talk in testing). Also, your internal ports **must match** your external ports on your network (ie. you can't have an external port of 7778 forwarded to your 7777 internal port; they must match).
- ***All three ports are required to be open for normal server behavior!***
| Port | Default (UDP) |
|---------|---------|
| **Game (Primary Port in Pterodactyl)** | 7777 |
| Beacon | 15000 |
| Server Query | 15777 |
___
### Installation Requirements/Instructions
- No major requirements, other than RAM and Disk space noted below.
- You *do not* need to own the base game to host this server.
- However, to fully "initialize" your server, a client who owns the game must log into the server to "claim" it and create a new session. The generated session will not be written to disk until the first save occurs.
- Currently, there is no way to save the session on server stop. Therefore, ensure the session is saved or the last player has disconnected (causing an auto-save) before stopping the server.
___
### Minimum RAM Requirement
This server requires a minimum of 4096 MiB of RAM to boot, but the developers recommend 6144 to 8192 MiB of RAM for 4 players or large save files.
___
### Minimum Disk Requirement
This server requires just under 5 GB of disk space to safely run properly. However, save files could easily surpass this amount, so 7-10 GB is recommended.
___
### Save File Location
[According to the developer](https://www.youtube.com/watch?v=Nn-1s87JJxc), save files will be able to be uploaded and downloaded by clients via their game client in the future. Until then, below is the save file location in case you would like to upload or download a save file manually:
`/home/container/.config/Epic/FactoryGame/Saved/SaveGames/server`
Single-player save files can be uploaded here and are playable if desired.
___
### Console Commands
As of v5.0.4, the console tab in the client server manager is the only way to execute commands. Entering commands via Pterodactyl do nothing.
[List of known commands can be found via the Wiki](https://satisfactory.fandom.com/wiki/Dedicated_servers#Commands)
___
### Errors/Warnings
The following errors or warnings you see in the console can safely be ignored:
```log
steamclient.so: cannot open shared object file: No such file or directory
[S_API] SteamAPI_Init(): Loaded '/home/container/.steam/sdk64/steamclient.so' OK. (First tried local 'steamclient.so')
LogSteamShared: Warning: Steam Dedicated Server API failed to initialize.
```
The local file of 'steamclient.so' was attempted to be loaded, but could not because it is not present, causing the warning message. However, the backup `/home/container/.steam/sdk64/steamclient.so` is loaded successfully (this is the correct behavior according to the [Wiki](https://satisfactory.fandom.com/wiki/Dedicated_servers#No_Such_File_or_Directory)).
```log
Warning: failed to init SDL thread priority manager: SDL not found
```
This is a common error with Steam related software on Linux, but can safely be ignored.
```log
...Error: Couldn't find file for package...
```
```log
...Error: Navmesh bounds are too large!...
```
```log
...Warning: NiagaraSystem...
```
```log
LogStreaming: Warning: Failed to read file '../../../FactoryGame/Saved/SaveGames/GameAnalytics.sav' error.
```
These seem to be common error messages with the current experimental version of the game.
Reference in New Issue View Git Blame Copy Permalink