Skip to content

Commit

Permalink
Update documentation for changes to updating game server
Browse files Browse the repository at this point in the history
  • Loading branch information
Elyviere committed Oct 8, 2024
1 parent 087243a commit 4a24c9c
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 7 deletions.
25 changes: 21 additions & 4 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ Method 1:

#. SSH into the appliance and run the command ``confconsole``.

#. Select ``Advanced`` menu or press the ``A`` key.
#. Select ``Advanced`` menu or press the ``A`` key and then <Enter>.

#. Select ``Gameserver`` or press the ``G`` key.
#. Select ``Gameserver`` or press the ``G`` key and then <Enter>.

#. Select ``Update`` or press the ``U`` key.
#. Select ``Update list`` or press the ``U`` key and then <Enter>.

#. Done!

Expand All @@ -99,8 +99,25 @@ Done!

Update game server version
----------------------------
If there is an update to the game after deploying your server, you may need to update the server to allow clients with the newer version to connect. Currently, the GUI does not support updating the server version. Instead, follow the following procedure:
If there is an update to the game after deploying your server, you may need to update the server to allow clients with the newer version to connect. Like with updating the game server list, this can either be done through the GUI or manually. Here are instructions for the two methods:

Method 1:
^^^^^^^^^^^

#. SSH into the appliance and run the command ``confconsole``.

#. Select ``Advanced`` menu or press the ``A`` key and then <Enter>.

#. Select ``Gameserver`` or press the ``G`` key and then <Enter>.

#. Select ``Update server`` or press the ``U`` key **twice** and then <Enter>.

#. Be patient, the update can take a few minutes.

#. Done!

Method 2:
^^^^^^^^^^^

#. Find your installed game server on the [supported games](https://github.com/jesinmat/linux-gameservers/tree/master#supported-games) list. You will need the "Code" shown in this list.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,12 @@ def run():
os.chdir(curdir)
return

console.infobox('Attemting to update game server')
console.infobox('Attemting to update game server. Be patient, this takes at least a few minutes...')
ret = subprocess.run(
['./auto_install.sh', '-g', game_code, '-u', 'gameuser', '-p', '/home/gameuser/gameserver'],
capture_output=True, text=True)
if ret.returncode != 0:
console.msgbox('Error', 'An error occurred during the update:\n' + ret.stderr)
# Attempt to restart the game server even if issues occurred during the update
console.msgbox('Error', 'An error occurred during the update (will attempt to restart the server regardless):\n' + ret.stderr)

console.infobox('Restarting the game server')
ret = subprocess.run(['systemctl', 'start', 'gameserver'], capture_output=True, text=True)
Expand Down

0 comments on commit 4a24c9c

Please sign in to comment.