|
|
@@ -1,4 +1,4 @@
|
|
|
-# Community Messaging Project
|
|
|
+# Community Messaging Project (CMP)
|
|
|
|
|
|
To communicate humanly between IRC, portal websites and gameservers or even more.
|
|
|
|
|
|
@@ -10,10 +10,16 @@ Example ...
|
|
|
|
|
|
## The IRC bots
|
|
|
|
|
|
+Historically, the IRC bots were first. :)
|
|
|
+
|
|
|
### Eggdrop Bot TCL plugin
|
|
|
|
|
|
-Configuration from a webserver
|
|
|
-XML
|
|
|
+Channel and ban configuration from a webserver
|
|
|
+simple XML (yikes anyhow)
|
|
|
+
|
|
|
+* Can act as standalone community IRC messaging service (CIMS)
|
|
|
+* expands itself with eggdrop botnet ability
|
|
|
+* expands itself with the messaging service and control server
|
|
|
|
|
|
provides the following commands on the messaging service:
|
|
|
|
|
|
@@ -24,18 +30,42 @@ YAML
|
|
|
|
|
|
provides the following commands on the messaging service:
|
|
|
|
|
|
+## Gameserver joining Bot
|
|
|
+
|
|
|
+A gameserver joining bot joins the gameservers by whatever means
|
|
|
+the gameserver protocol allows and then allows commands to be used
|
|
|
+by users to interact with other people.
|
|
|
+
|
|
|
+### QuakeWorld Bot
|
|
|
+
|
|
|
+The current QuakeWorld Bot connects to the quakeworld (qw) gameservers that are
|
|
|
+defined in its configuration file. It is able to connect to
|
|
|
+nearly unlimited qw servers. But be sure to have a look at the cpu strain it will
|
|
|
+get on the server.
|
|
|
+
|
|
|
+It also connects to the control server via SSH to send and receive
|
|
|
+network commands.
|
|
|
+
|
|
|
+* Can act as standalone QuakeWorld Bot community messaging
|
|
|
+* Expands itself with the messaging service and control server
|
|
|
+
|
|
|
+Provides the following commands on the messaging service:
|
|
|
+
|
|
|
## Control Server
|
|
|
|
|
|
-Commands to publish
|
|
|
-provides the following commands on the messaging service:
|
|
|
+The Control Server is a client on the messaging service. It allows
|
|
|
+for more interaction between the various kinds of clients.
|
|
|
+
|
|
|
+It provides the following commands on the messaging service:
|
|
|
|
|
|
## Messaging Service
|
|
|
|
|
|
-Every client connects to a messaging service where they can interact
|
|
|
-with a command and control server program. It is the communication
|
|
|
+Every client connects (or _can_ connect) to a messaging service where they can interact
|
|
|
+with a command and control server program and the other clients. It is the communication
|
|
|
backbone. So to say, it's the transport of the messages with
|
|
|
-which the programs interact. Let's say 'Program message transport' is a
|
|
|
-synonym.
|
|
|
+which the programs interact. Let's say 'message transport' is a
|
|
|
+synonym and 'network commands' are the commands that all the clients
|
|
|
+adhere to within the Community Messaging Project.
|
|
|
|
|
|
As a future (late 2017?) underlying message transport I chose NATS from Apcera.
|
|
|
https://nats.io
|
|
|
@@ -70,3 +100,8 @@ would still need to be able to connect to the network. So, we could - in
|
|
|
some unknown future - even add Amazon Web Services Simple Queuing Service (SQS)
|
|
|
to this network by coding a gateway from NATS to SQS. But that's future talk
|
|
|
for something that was never meant THIS big. ;-) Let's dream.
|
|
|
+
|
|
|
+## Final words
|
|
|
+
|
|
|
+This messaging service has been in use in the quakeworld community now for over
|
|
|
+a decade, dating back to 2002. Let's keep it alive and expandable.
|
Klumpp, Paul-Dieter