Commit Graph

25 Commits

  • 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.
  • Fix whitespace issues in README.md
    Fixed a regression with newline spacing.
  • General README Improvements
    Updated some info and cleaned up verbiage in some places.
  • Added "Disable Seasonal Events" Option
    Added "Disable Seasonal Events" startup variable and updated the startup command to add the new flag `-DisableSeasonalEvents` if the variable is "true". This new flag was added to Satisfactory in 0.5.1.4 (https://satisfactory.fandom.com/wiki/Patch_0.5.1.4).
  • feat: add steam_disk_space egg feature to SteamCMD eggs
    A new egg feature modal was introduced in Panel v1.7.0 triggering when server has run out of disk space to provide more user-friendly instructions to both admins and normal users. This is unique to SteamCMD specific errors.
  • fixed heading levels
    added blank lines as needed
    addec code block tags
  • 0.5.0.6 Boot Crash Hotfix & Explicit Game Port Declaration
    - Adds the newly discovered `-multihome` flag to fix 0.5.0.6 update's IPv6 related issue, where the IP binds to IPv6 by default, causing a crash on boot. Server will now bind to IPv4 by default. As this is a hotfix, IPv6's possible support will be investigated at a later date.
    - Adds the newly discovered `?listen` flag to the `-Port` flag to explicitly declare the port. This will prevent the server from possibly auto-incrementing the port if, for whatever reason, it thinks there's another Satisfactory server present in the same container.
  • 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>
  • 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.
  • Migrate Install Script to use Debian Yolk Image
    - Changed the Install Script Container to use Pterodactyl Debian Installer Yolk image.
    - Removed the apt update code that is already handled by the installer image.
  • Fix Install Script using Wrong App ID Variable Name
    Changed `APP_ID` to `SRCDS_APPID` in the install script to match the corresponding variable.
  • 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.
  • Small Fixes to README
    - Added correct anchor to wiki link on the SteamAPI library error
    - Added new line to top warning lines.
  • 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)
  • Update egg's port variables
    - Removed them from view of the end user as they less relevant at the moment (because they cannot be changed from the defaults).
    - Reworded the Beacon port's description to be more correct and clear.
    - Temporarily restricted the Beacon port to 15000 because it currently cannot be changed.
  • 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.
  • Add "Errors/Warnings" Section to README
    Added a section detailing some common errors and warnings that can safely be ignored.
  • Update Satisfactory README
    Removed placeholder and filled in correct information.
  • Initial Upload
    README is currently a placeholder and will be updated with the following commit.