Commit Graph

17 Commits

Author SHA1 Message Date
Red-Thirten
8c72d5ae33
Update Satisfactory README.md
Notes the increase in RAM required to run the server without crashing due to the recent Satisfactory Update 6 coming to the Early Access branch today.
2022-09-20 18:05:52 -07:00
Red-Thirten
d4c3296696
fix(satisfactory): SteamCMD download link & PTDL_v2 Upgrade (#1727) 2022-07-02 18:17:53 +03:00
Red-Thirten
dcdb4fdfb1
Fix whitespace issues in README.md
Fixed a regression with newline spacing.
2022-04-26 12:46:43 -07:00
Red-Thirten
c1f57dfd74
General README Improvements
Updated some info and cleaned up verbiage in some places.
2022-04-26 12:31:18 -07:00
LRMtheBoss
5fba7ef2bb fixed heading levels
added blank lines as needed
addec code block tags
2021-12-09 13:03:56 -05:00
Red-Thirten
8a74a512da
[Satisfactory] 0.5.1.2 General QoL Update (#1430) 2021-12-02 19:31:33 +02:00
Red-Thirten
0c4b7fb3b6
[Satisfactory] 0.5.0.12 General QoL Update & EA Readiness (#1407) 2021-11-20 07:15:41 +02:00
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
Red-Thirten
127bea6a4d Custom Ports Update + More
Egg:
- Changed the startup command to call the binary directly to avoid end-users changing the provided bash file to run whatever they'd like.
- Changed the install script to check that the server successfully installed, and makes the server binary executable. Also added Software-Noob as a contributor.
- Fixed the startup command to support custom ports. The SERVER_PORT variable is now tied to the Server Query Port (because that is what clients use to connect to the server). The GAME_PORT variable was added for the Game Port. Also changed the Game Port to use the correct flag.
- Changed the Server Query Port variable to be the Game Port and provided a better description.
- Updated the Beacon Port description to be more accurate. Also unlocked it's restriction to port 15000 because it can be changed now.

README:
- Updated any text mentioning restricted ports to text explaining their configuration. Also used clearer verbiage for the port table.
- Added Software-Noob as a contributor.
- Added info on "initializing"/"claiming" a server.
- Added info on the command line.
- Added "SDL" warning as a warning to safely ignore.
2021-10-27 16:11:17 -07:00
Red-Thirten
9057ce2aa2
Small fixes to Save Location section in README
Fixed typo
2021-10-27 02:18:33 -07:00
Red-Thirten
58eadedb69
Add Save File Info to README
- Added save file location information to the readme (since the location differs on Ptero compared to the wiki).
- Additional formatting tweaks.
2021-10-26 20:12:46 -07:00
Red-Thirten
e80ee5ac8e
Small Fixes to README
- Added correct anchor to wiki link on the SteamAPI library error
- Added new line to top warning lines.
2021-10-26 19:45:25 -07:00
Red-Thirten
a066c373e5
Additional Port Clarification in the README
- Mentioned only one server can be run on Ptero due to the port limitation.
- Added mention that external ports must match internal ports (because the game client only looks for port 7777 at the moment)
2021-10-26 19:32:11 -07:00
Red-Thirten
468aeb3b72
Port Info Corrections and Small Changes for README
- Fixed misinformation of required ports and made it clear that the default ports are currently required to be used for the server to work.
- Fixed typos.
- Updated the recommended RAM amount, based off an update to the developer's wiki made today.
2021-10-26 19:05:06 -07:00
Red-Thirten
b661cd4b8d
Add "Errors/Warnings" Section to README
Added a section detailing some common errors and warnings that can safely be ignored.
2021-10-26 16:45:57 -07:00
Red-Thirten
3b00cdc5b6
Update Satisfactory README
Removed placeholder and filled in correct information.
2021-10-26 16:16:09 -07:00
Red-Thirten
c108ce3917 Initial Upload
README is currently a placeholder and will be updated with the following commit.
2021-10-26 15:42:36 -07:00