aboutsummaryrefslogtreecommitdiffstats
path: root/server/src/commands/admin
diff options
context:
space:
mode:
authorNeel Kamath <neelkamath@protonmail.com>2018-05-13 12:33:22 +0200
committerNeel Kamath <neelkamath@protonmail.com>2018-05-13 12:33:22 +0200
commit343157350f627b9495184246a90033a1c41f1a2c (patch)
treee8688471fbee2bdcd5834abcb559ea1694eecadf /server/src/commands/admin
parentUse the 'use strict' directive when needed (diff)
downloadhackchat-343157350f627b9495184246a90033a1c41f1a2c.tar.gz
hackchat-343157350f627b9495184246a90033a1c41f1a2c.zip
Re-add module documentation
Diffstat (limited to '')
-rw-r--r--server/src/commands/admin/addmod.js6
-rw-r--r--server/src/commands/admin/listusers.js5
-rw-r--r--server/src/commands/admin/reload.js6
-rw-r--r--server/src/commands/admin/saveconfig.js5
-rw-r--r--server/src/commands/admin/shout.js6
5 files changed, 23 insertions, 5 deletions
diff --git a/server/src/commands/admin/addmod.js b/server/src/commands/admin/addmod.js
index 992f9c4..4c13b22 100644
--- a/server/src/commands/admin/addmod.js
+++ b/server/src/commands/admin/addmod.js
@@ -40,4 +40,8 @@ exports.run = async (core, server, socket, data) => {
exports.requiredData = ['trip'];
-exports.info = { name: 'addmod' };
+exports.info = {
+ name: 'addmod',
+ usage: 'addmod {trip}',
+ description: 'Adds target trip to the config as a mod and upgrades the socket type'
+};
diff --git a/server/src/commands/admin/listusers.js b/server/src/commands/admin/listusers.js
index 92fa998..a539a3c 100644
--- a/server/src/commands/admin/listusers.js
+++ b/server/src/commands/admin/listusers.js
@@ -32,4 +32,7 @@ exports.run = async (core, server, socket, data) => {
}, socket);
};
-exports.info = { name: 'listusers' };
+exports.info = {
+ name: 'listusers',
+ description: 'Outputs all current channels and sockets in those channels'
+};
diff --git a/server/src/commands/admin/reload.js b/server/src/commands/admin/reload.js
index 40de059..e2cfbe6 100644
--- a/server/src/commands/admin/reload.js
+++ b/server/src/commands/admin/reload.js
@@ -28,4 +28,8 @@ exports.run = async (core, server, socket, data) => {
}, { uType: 'mod' });
};
-exports.info = { name: 'reload' };
+exports.info = {
+ name: 'reload',
+ description: '(Re)loads any new commands into memory, outputs errors if any'
+};
+
diff --git a/server/src/commands/admin/saveconfig.js b/server/src/commands/admin/saveconfig.js
index 116abd6..ed3a312 100644
--- a/server/src/commands/admin/saveconfig.js
+++ b/server/src/commands/admin/saveconfig.js
@@ -30,4 +30,7 @@ exports.run = async (core, server, socket, data) => {
}, { uType: 'mod' });
};
-exports.info = { name: 'saveconfig' };
+exports.info = {
+ name: 'saveconfig',
+ description: 'Saves current config'
+};
diff --git a/server/src/commands/admin/shout.js b/server/src/commands/admin/shout.js
index 2efff32..1358dd9 100644
--- a/server/src/commands/admin/shout.js
+++ b/server/src/commands/admin/shout.js
@@ -16,4 +16,8 @@ exports.run = async (core, server, socket, data) => {
exports.requiredData = ['text'];
-exports.info = { name: 'shout' };
+exports.info = {
+ name: 'shout',
+ usage: 'shout {text}',
+ description: 'Displays passed text to every client connected'
+}; \ No newline at end of file