• R/O
  • HTTP
  • SSH
  • HTTPS

コミット

タグ

よく使われているワード(クリックで追加)

javaandroidc++linuxc#objective-ccocoa誰得qtrubybathyscaphegamepythonphpguiwindowsc翻訳omegattwitterframeworkbtronarduinovb.net計画中(planning stage)directxpreviewertestゲームエンジンdom

Administrator's Toolkit VS plugin


コミットメタ情報

リビジョン1cdf18592e2740bb15c039c106f137daa4986acf (tree)
日時2019-08-15 07:11:17
作者melchior <melchior@user...>
コミッターmelchior

ログメッセージ

added instructional text

変更サマリ

差分

--- /dev/null
+++ b/AdminToolkit/readme.md
@@ -0,0 +1,80 @@
1+
2+Instructions for using the Administrator's Toolkit;
3+
4+It provides the (server side only) commands:
5+
6+/rules
7+/admins
8+/backups
9+
10+=== RULES ===
11+
12+Server administrators should create a unicode (UTF-8) text file;
13+
14+(server config directory root): /Rules/rules_en.txt
15+
16+Keep it small (1~2K) as it spools ONE-LINE-AT-A-TIME to players that have used the
17+'/rules' command. (CR/LF is acceptable - .NET supports either line endings)
18+
19+Any player can issue the '/rules accept' command to "Accept" whatever the rules mean; (it keeps track - they can only 'accept' once)
20+
21+This _CAN_ have an effect of changing the players role (IF the 'admintoolkit.json' is setup).
22+
23+See: '/ModConfig/admintoolkit.json' -
24+
25+ "PlayerRoleRestrain": "suvisitor", <<< This is the role they are 'demoted' to just-after joining; when the have *NOT* already accepted the rules.
26+ "PlayerRoleNormal": "suplayer", <<< This is the role that a 'normal' player will be 'promoted' to, after using '/rules accept'
27+ "RuleRoleChangerEnabled": false, <<< When 'true' players roles WILL Be CHANGED depending on IF they 'accepted' the rules (/rules just prints out the rules)
28+
29+All these roles must exist and use the 'code' name, any misconfiguration will prevent the command from working. (with error messages in the log...)
30+
31+=== BACKUPS ===
32+
33+An automatic call to the '/genbackup' command exists as a Administrator only ('controlserver' permission) function.
34+
35+By default it isn't automatically activated;
36+
37+Manual triggering of the backup cycle with:
38+
39+'/backups enable'
40+
41+And to stop the automatic backup process;
42+
43+'/backups disable'
44+
45+Note; This process ISN'T AWARE OF FREE DISK SPACE!
46+(the '/genbackup' command itself may fail without free disk/volume space!)
47+
48+To alter the time delay:
49+
50+'/backups delay 9'
51+
52+Sets the delay to 9 hours (and restarts the backup schedule IF its already active).
53+
54+To inquire about the existing backups and when the last one was issued;
55+
56+'/backups stats' - will print out various information about when/if/how many, backups were made...if any.
57+
58+The number of "old" backup files to keep (at least 4):
59+
60+'/backups count 10'
61+
62+
63+See: '/ModConfig/admintoolkit.json' -
64+
65+ "BackupDelay": "04:00:00", <<< The time-span delay BETWEEN Starting a backup. In "HH:MM:SS" format, so to delay 3 Hours, 15 Minutes, 21 Seconds: "03:15:21" It is limited to a max of 500 HOURS.
66+ "BackupCount": 6, <<< The count of backups; minimum of 4, max is uint. (billions...) to keep around.
67+ "Autobackup": false <<< set to true if you want the server to automatically run the backup cycle UNATTENDED, without an admin issuing '/backups enable'
68+
69+
70+
71+Note; The 'admin' role needs to exist for internal use purposes, this mod will NOT function correctly without it.
72+
73+
74+=== ADMINS ===
75+
76+'/admins'
77+
78+Usable by anyone - it just prints a listing of all higher role(s)
79+present (or not) on the server.
80+