search

ntaklive / BackupMod

A 7 days to die modlet which makes it possible to automatically backup and restore your game saves
11 stars 3 forks source link

Add help text based on readme #5

Closed jonathan-robertson closed 2 years ago

jonathan-robertson commented 2 years ago

Close #4

This update provides help output in the console when running help bp or help backup:

Before

help bp
2022-09-28T09:22:09 1138.844 INF Executing command 'help bp' by Telnet from 127.0.0.1:35912
*** Command: bp ***
No detailed help available.
Description: Some commands to simplify the creation of backups (commands are provided by BackupMod)
version
Game version: Alpha 20.6 (b8) Compatibility Version: Alpha 20.6
Mod Backup mod: 2.1.0

After

help bp
*** Command: bp ***
Usage:
  1. backup
  2. backup info
  3. backup list
  4. backup restore
  5. backup delete
  6. backup start
  7. backup stop
Description Overview
1. perform a forceful backup
2. show the current configuration of the mod
3. show all available backups
4. restore a save from a backup
5. delete a backup
6. start an AutoBackup process (even if disabled in settings.json)
7. stop the current AutoBackup process
version
Game version: Alpha 20.6 (b8) Compatibility Version: Alpha 20.6
Mod Backup mod: 2.1.1

Unchanged

help * bp
*** List of Commands for "bp" ***
 backup bp => Some commands to simplify the creation of backups (commands are provided by BackupMod)