Changes between Version 5 and Version 6 of Instance management

Timestamp:

14.11.2023 18:27:51 (6 months ago)

Author:

Alloc

Comment:

--

Instance management

@@ -21 +21 @@
 7dtd.sh instances create
 }}}
-This will first ask for a name for the new instance and afterwards ask you for all the config-parameters. Parameter queries look like this:
-{{{
-Server name:                    
+This will first ask for a name for the new instance and afterwards opens the config.xml in your default text editor.
 
-Public server [false]:              
-
-Drop on Death, options:
-   0: Everything
-   1: Toolbelt only
-   2: Backpack only
-   3: Delete all
-Select option (0-3) [1]:            
-
-Night percentage (10-90) [15]:      
-}}}
- Server name::
-   This example shows a parameter which has no default so you have to enter a name.
- Public server::
-   Here a default value (false) is given. If you only press <ENTER> without typing anything the default will be used. Also this is a boolean value, so you can only enter yes/no/y/n/true/false.
- Drop on Death::
-   This is a enumerated value, meaning you are shown the option values and then select one of them by the appropriate number.
- Night percentage::
-   Here a valid range (10-90) is given, meaning you can not enter a value outside this range.
-
-'''NOTE:''' Currently there are three options that are automatically set:
+'''NOTE:''' Currently there are three options that are forced when instances are launched so setting them in the config has no effect:
 * TelnetEnabled: This has to ''true'' so the management scripts can access the instance. '''Having this open to the public internet is a security risk. See [[Ports]]'''
 * AdminFileName: This is set to ''admins.xml'' so it automatically uses that file in the instance folder.
-* SaveGameFolder: This is set to the instance folder.
+* UserDataFolder: This is set to the instance folder.
 
-When you are done with entering all parameters the config.xml will be saved and the instance is ready to be started.
+When you are done with entering all parameters save the config.xml and the instance is ready to be started.
 
 
@@ -58 +36 @@
 {{{
 7dtd.sh instances print_config <instancename>
+}}}
+
+Alternatively print the actual XML as is, optionally with syntax highlighting if you have ''pygmentize'' installed:
+{{{
+7dtd.sh instances print_xml <instancename>
 }}}
 
@@ -68 +51 @@
 }}}
 
-You will then be shown an interface to edit the options similar to the interface when creating a new instance.
+This will open the config.xml in your default text editor.
 
 
@@ -82 +65 @@
 '''WARNING:''' This will delete every aspect of the instance:
 * Save games
+* Created RWG world (if the instance used a custom one)
+* Mods local to the instance
 * Configuration
 * Logs