Changes between Version 1 and Version 2 of Console Commands

Timestamp:

Jul 24, 2014, 8:50:42 PM (10 years ago)

Author:

Christian Illy

Comment:

--

Console Commands

@@ +1 @@
+== Console Commands ==
+
+In order to do some bits of administration or even for informational purposes 7 Days to Die integrates a console system. This can be accessed in three ways:
+* In game by a client. The key to open the console is layout dependend, e.g. for a german layout it is the "ö"
+* Telnet. This has to be enabled server side and can then be accessed with a simple Telnet client
+* Web control panel. Has to be enabled server side too and can then be accessed with any web browser
+
+
+== admins.xml and in game console ==
+
+=== Unmodified server code ===
+Each command has to have a permission level set in ''admins.xml'' and the player who wants to use the command must have the appropriate level, i.e. the permission level of the player must be lower or equal to the permission level of the command to be executed. All commands that are not defined in the ''admins.xml'' can not be executed at all.
+
+'''Example:'''
+''admins.xml'':
+{{{
+<?xml version="1.0" encoding="UTF-8"?>
+<adminTools>
+    <admins>
+        <admin steamID="123456" permission_level="0" />
+        <admin steamID="987654" permission_level="4" />
+    </admins>
+
+    <permissions>
+        <permission cmd="dm" permission_level="3" />
+        <permission cmd="mem" permission_level="4" />
+        <permission cmd="admin" permission_level="0" />
+        <permission cmd="kick" permission_level="5" />
+        <permission cmd="lt" permission_level="10" />
+        <permission cmd="setgameprefs" permission_level="0" />
+        <permission cmd="le" permission_level="1000" />
+    </permissions>
+</adminTools>
+}}}
+
+* Player with ID 123456 (permission level 0):
+  * ''dm'' -> ok
+  * ''mem'' -> ok
+  * ''admin'' -> ok
+  * ''sg'' (which is the short version of ''setgameprefs'') -> denied (not in list exactly like this)
+  * ''shutdown'' -> denied (not in list at all)
+* Player with ID 987654 (permission level 4):
+  * ''dm'' -> denied (dm requires permission level of 3 or less)
+  * ''mem'' -> ok
+  * ''kick'' -> ok
+  * ''le'' -> ok
+* Any other player with no defined permission level:
+  * ''le'' -> denied (permission level 1000 is just an arbitrary number)
+  * any other command -> denied
+
+=== Running a server with the [[Server fixes]] installed ===
+
+Mostly the same applies as without the fixes. Changes are:
+* A command with permission level of >=1000 can be executed by '''any''' player, even those not listed in the ''admins.xml'' at all
+* Any command not having an permission level set in ''admins.xml'' will automatically have a permission level of 0
+* Commands defined in the ''admins.xml'' affect both short and long versions
+
+'''Example:'''
+Considering the same ''admins.xml'' as before:
+* Player with ID 123456 (permission level 0):
+  * ''dm'' -> ok
+  * ''mem'' -> ok
+  * ''admin'' -> ok
+  * ''sg'' (which is the short version of ''setgameprefs'') -> '''ok''' (''setgameprefs'' is defined so it also affects ''sg'')
+  * ''shutdown'' -> '''ok''' (implicitly defined as permission level 0)
+* Player with ID 987654 (permission level 4):
+  * ''dm'' -> denied (dm requires permission level of 3 or less)
+  * ''mem'' -> ok
+  * ''kick'' -> ok
+  * ''le'' -> ok
+* Any other player with no defined permission level:
+  * ''le'' -> '''ok''' (permission level 1000 -> any player can execute this command)
+  * any other command -> denied
+
+
+== Implemented commands ==
 
 ||= Command =||= Parameters =||= Description =||