Rewrote the example configurations and split them

up into seperate files for each pseudo client.

Also reorganized how the modules are stored, and
made most of the old "extra" modules "core"

1 files changed, 101 insertions, 0 deletions

diff --git a/data/global.example.conf b/data/global.example.conf
new file mode 100644
index 000000000..5a3566e4e
--- /dev/null
+++ b/data/global.example.conf
@@ -0,0 +1,101 @@
+/*
+ * Example configuration file for Global.
+ */
+
+/*
+ * First, create the service.
+ */
+service
+{
+	/*
+	 * The name of the Global client
+	 */
+	nick = "Global"
+
+	/*
+	 * The username of the Global client.
+	 */
+	user = "services"
+
+	/*
+	 * The hostname of the Global client.
+	 */
+	host = "localhost.net"
+
+	/*
+	 * The realname of the Global client.
+	 */
+	gecos = "Global Noticer"
+}
+
+/*
+ * Core Global module.
+ *
+ * Provides essential functionality for Global.
+ */
+module { name = "gl_main" }
+
+/*
+ * Configuration for Global provided by gl_main.
+ */
+global
+{
+	/*
+	 * The name of the client that should be Global.
+	 */
+	name = "Global"
+
+	/*
+	 * If set, Services will send global messages on starting up and shutting
+	 * down/restarting.
+	 *
+	 * This directive is optional.
+	 */
+	#globaloncycle = yes
+
+	/*
+	 * This is the global message that will be sent when Services are being
+	 * shutdown/restarted. This directive is only required if you enable
+	 * globaloncycle above.
+	 */
+	globaloncycledown = "Services are restarting, they will be back shortly - please be good while we're gone"
+
+	/*
+	 * This is the global message that will be sent when Services (re)join the
+	 * network. This directive is only required if you enable globaloncycle above.
+	 */
+	globaloncycleup = "Services are now back online - have a nice day"
+
+	/*
+	 * If set, Services will hide the IRC operator's nick in a global
+	 * message/notice.
+	 *
+	 * This directive is optional.
+	 */
+	#anonymousglobal = yes
+}
+
+/*
+ * Core Global commands.
+ *
+ * In Anope modules can provide (multiple) commands, each of which has a unique command name. Once these modules
+ * are loaded you can then configure the commands to be added to any client you like with any name you like.
+ *
+ * Additionally, you may provide a permission name that must be in the opertype of users executing the command.
+ *
+ * Sane defaults are provided below that do not need to be edited unless you wish to change the default behavior.
+ */
+
+/* Give it a help command */
+command { service = "Global"; name = "HELP"; command = "generic/help"; }
+
+/*
+ * gl_global
+ *
+ * Provides the command global/global.
+ *
+ * Used for sending a message to every online user.
+ */
+module { name = "gl_global" }
+command { service = "Global"; name = "GLOBAL"; command = "global/global"; permission = "global/global"; }
+