-
Notifications
You must be signed in to change notification settings - Fork 3
Notifications
The server is capable of sending notifications. These notifications can be various, but mostly they contain information about certain events happening and registered on the server side such as player has completed a daily task or a new voting has been started.
For the notifications mechanism to work a MQTT protocol is used. The MQTT protocol has 2 key components: publisher (=server) and subscriber (=client). The publisher can publish a message (= send notification) and the subscribers can listen and wait for the message to come.
The subscribers can listen to messages by using topics (= endpoints). When some message come to a specific topic, subscriber gets it. Topic is a unique string usually containing slashes (/) - separators. The separators are used for organizing the structure of the topics overall.
Subscriber can listen to a specific topic and also it can use a wildcard, for example to subscribe to all of the topics starting with a specific string, i.e. with "/clan" to listen to all notifications related to clans.
The messages coming from a topics can have any format, there are not restrictions for that.
More detailed description about MQTT can be found here
The notifications mechanism with topics structure and more built on the server can be found here
The supported MQTT topics are covered in the doc folder of the repo. There are links to those in the main page of the README.md.