Update README.md

README.md

@@ -29,7 +29,11 @@ Issue Server Commands:
 - Force a save
 - Broadcast a message.
 
-Note: Kick and Ban not implemented yet (will be in v1.1.0, Game bug not allowing messages with spaces to be sent.<br>
+Note: Kick and Ban not implemented yet (will be in v1.1.0)
+- Kick a player by using either their SteamID or playername.
+- Ban a player by using either their steamID or playername. Script has the ability to ban player even if they're offline.
+
+Note: Game bug not allowing messages with spaces to be sent, underscores should be used instead.<br>
 
 **Shutdown Reminders**<br>
 Want your server to restart daily but want to give users some warning?<br>
@@ -39,7 +43,13 @@ NOTE: An improved version of this feature will be in release in v1.1.0 which wil
 **Player Log**<br>
 TBC in v1.1.0
 Capture who was online at what time in a daily text file.<br>
-Also capture a csv of all players who have visited your server.<br>
+Also capture a csv of all players who have visited your server and any playernames they may have used.<br>
+This is useful if you need to ban someone who was on your server but is not currently online.<br>
+
+**Server Setup Helper**
+TBC in v1.1.0
+Running the script with -setup will run through steps to setup SteamCMD, install Palworld Dedicated server, install ARRCON and configure Inbound & Outbound Firewall rules required.
+This means you're only left with the task of configuring your Portforwarding and configuring your Palworld Server settings.
 
 **Daily Settings Switcher**<br>
 Run daily events on your server! That's right you can have different settings for each day of the week.<br>
@@ -50,12 +60,22 @@ Example Idea below:<br>
 **Server Admin**<br>
 You can check for updates (manually and at server launch), initiate updates, start and stop the server.<br>
 
-Note: Kick and Ban not implemented yet, will be in v1.1.0<br>
+Note: Kick and Ban not implemented yet, will be in v1.1.0 TODAY!<br>
 Note: Auto Update feature not implemented yet but plan to have a feature to regularly check for new versions and if so force a restart and update.<br>
 
 **Backups**<br>
-Not available yet, coming soon in v1.1.0. This will sort backups into hourlies, dailies and monthlies.<br>
-Will also supply a guide on how you can have your backup folder sync to the cloud, for free, essentially the same instructions I wrote for Valheim: https://www.reddit.com/r/valheim/comments/lxjdu7/guide_auto_cloud_backup_your_valheim_worldplayer/?rdt=33007
+Not available yet, coming TODAY in v1.1.0.<br>
+When running the -backup parameter this will save a backup into a backup folder. Unless you specify a custom backup location in config, the default path for backups is "<ServerPath>\Pal\Saved\SaveGames\Backups".<br>
+Feature is intended to be used on an hourly basis (using task scheduler) but can be used on a more frequently if desired.
+Backup feature includes an automatic cleanup to prevent disk space blowout:
+- For any backups older than 30 days, the last backup of that month will be retained
+- For any backups older than 7 days, the last backup of that day will be retained
+- All backups taken within the last 7 days will be retained
+
+Note: 'Days' is not taken from current date but rather by assessing how many days worth of backups you have and working backwards. EG If you go for 7 days with no backups, you'll still have 7 days worth of hourly restore points from the previous week.
+
+Recommend that you save the backups to a Cloud sync'd location (eg. OneDrive, DropBox, Sync.com etc etc).
+Optionally you can also redirect your entire SaveGames folder to the cloud using Symbolic links, see this reddit post for an old guide I wrote up on this: https://www.reddit.com/r/valheim/comments/lxjdu7/guide_auto_cloud_backup_your_valheim_worldplayer/
 
 **Useful for those with Home Assistant**<br>
 For Home Assistant users, Using HASS.Agent on your windows PC you can setup PowerShell based sensors/commands to retrieve/send data to the server.<br>
@@ -64,11 +84,10 @@ You can setup a card like this and share it with your players/mods for basic rem
 For more info see [PalworldServerTools Home Assistant Documentation](docs/HOMEASSISTANT.md).
 
 # Setup Information #
-**Download Script Release, ARRCON.exe and SteamCMD**<br>
-1. Download ARRCON from https://github.com/radj307/ARRCON and place the .exe somewhere on your PC (anywhere is fine).
-2. Download Latest PalworldServerTools Release from my Github [here](https://github.com/shupershuff/PalworldServerTools/releases/latest).
-3. Extract PalworldServerTools to any folder you want, I would recommend putting the files in the same folder as palserver.exe
-4. TBC SteamCMD steps
+**Download Script Release**<br>
+1. Download Latest PalworldServerTools Release from my Github [here](https://github.com/shupershuff/PalworldServerTools/releases/latest).
+2. Extract PalworldServerTools to any folder you want, I would recommend putting the files in the same folder as palserver.exe
+Note that ARRCON and SteamCMD will be automatically installed once script is run in a later step.
 
 **Optional - Configure your .ini files**<br>
 If you want the script to load different server settings depending on what day it is, you'll need to create the .ini files. Otherwise you can skip this section.<br>
@@ -87,8 +106,9 @@ Section TBC but the config.xml file should mostly be self explanatory with the d
 - RCONPort - Connection Port for RCON
 - RCONPass - Administrator Password for RCON
 - SteamCMDPath - Path to the folder steamcmd.exe sits in.
-- ARRCONPath -  Path to the folder ARRCON.exe sits in.
-- ServerPath - Path to the folder that palserver.exe sits in.
+- ARRCONPath - Path to the folder ARRCON.exe should sit in. If left blank ARRCON will be installed to "C:\Program Files\ARRCON\"
+- ServerPath - Path to the folder that palserver.exe sits in. Cannot be left blank.
+- BackupPath - Path of where backups are stored. Leave blank for default backup path (<SERVER>\Pal\Saved\SaveGames\Backup) or specify your own.
 - ThemeSettingsPath - Path to where your custom.ini files live. Leave blank for the default path to be used (<SERVERPATH>\Pal\Saved\Config\WindowsServer\CustomSettings\")
 - NormalSettingsName - Name of the file that you want your standard server settings (.ini file) to load from. Default "Normal Settings"
 - AutoShutdownTimer - Used for restarting server. Time that server should wait until shutdown to give players a bit of notice.
@@ -102,6 +122,7 @@ You'll want to test the functions first and ensure there aren't any errors due t
 ![image](https://github.com/shupershuff/PalworldServerTools/assets/63577525/ef656764-1a45-4f6f-83ae-03a861d118a3)<br>
 2. Enter in "& '.\PalworldServerTools.ps1' -info" to test (info as an example parameter). Obviously change the parameter for any other things you want to test.
 3. If there are issues, you can review the log file in the folder where the script lives for further information.
+4. Note that there may be some first time run setup tasks (eg installation of ARRCON and/or SteamCMD).
 
 ** Optional Home Assistant Setup**<br>
 See [PalworldServerTools Home Assistant Documentation](docs/HOMEASSISTANT.md).
@@ -123,13 +144,14 @@ Parameters utilizing RCON:<br>
 - -ShutdownMessage - To use this use -broadcast "message". Used to customise the shutdown message.
 - -Broadcast - To use this use -broadcast "message". Sends a message to all players. Note that as of the time of writing, it's not possible to send messages with spaces in them (game limitation).
 - -DoExit - Schedule an immediate shutdown of the server.
-- -kick (or -kickplayer) - TBC FROM v1.1.0 ONWARDS Used to kick a player. Script allows you to specify either steam ID or playername to kick.
-- -ban (or -banplayer) - TBC FROM v1.1.0 ONWARDS Used to ban a player. Script allows you to specify either steam ID or playername to ban. If specified player isn't online, script will warn you (in case you made a typo).
+- -Kick (or -kickplayer) - TBC FROM v1.1.0 ONWARDS Used to kick a player. Script allows you to specify either steam ID or playername to kick.
+- -Ban (or -banplayer) - TBC FROM v1.1.0 ONWARDS Used to ban a player. Script allows you to specify either steam ID or playername to ban eg -ban shupershuff or -ban 1234567890123. If specified player isn't online, script will check against playernames and steam ID's of players who have previously joined the server. Note that if used from a web front end (eg Home Assistant) where CLI prompts can't be seen, playername or steamID MUST be typed perfectly.
 - -Save - Force server to save data.
 
 Server Launch and misc Parameters:
-- -backup - TBC FROM v1.1.0. Will initiate a backup
-- -StartNoTheme - Will check for updates and start the server using your "Normal" settings
+- -Setup - Run through steps to setup SteamCMD, Install Palworld Dedicated server, install ARRCON and configure Inbound & Outbound Firewall rules required.
+- -Backup - TBC FROM v1.1.0. Will initiate a backup and save it to "<BackupPath>\<Year>\<MonthName>\<Day>\<TimeOfBackup>\"
+- -Start - Will check for updates and start the server using your "Normal" settings
 - -StartThemed - Will check for updates and start the server using the 'themed' settings for whatever day it is. NOTE that this will overwrite PalworldSettings.ini with the contents of the .ini file you've specified in config.xml
 - -NoUpdate - To be used in conjuntion with -StartNoTheme or -StartThemed so that server starts immediately without checking for updates.
 - -UpdateOnly - Will launch the script to update the Palworld server.