https://github.com/arkaeriit/devzat-courier

A Devzat plugin to transmit messages between multiple instances.
https://github.com/arkaeriit/devzat-courier

Last synced: 26 days ago
JSON representation

A Devzat plugin to transmit messages between multiple instances.

• Host: GitHub
• URL: https://github.com/arkaeriit/devzat-courier
• Owner: Arkaeriit
• License: bsd-3-clause
• Created: 2024-08-09T21:21:11.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-08-15T16:34:08.000Z (4 months ago)
• Last Synced: 2024-08-15T22:30:30.857Z (4 months ago)
• Language: Go
• Size: 49.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Devzat Courier

A plugin to transmit messages between multiple Devzat instances.

![Local test](https://github.com/Arkaeriit/devzat-courier/blob/master/demo.png?raw=true)

## User manual

For users, Devzat Courier is very seamless. Talk in an instance and the message will be transferred to every other instance. There is also a `courier` command to get basic information about the plugin's state.

## Admin manual

To run your own Devzat Courier, you must have a token for every Devzat instance you want to connect. Then, create a JSON configuration file in the following format:

```json

[

  {

    "Host": "devzat.bobignou.red:2222",

    "Token": "dvz@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=",

    "Prefix": "ABD",

    "PrefixColor": "cyan",

    "NameColor": "yellow"

  },

  {

    "Host": "devzat.hackclub.com:5556",

    "Token": "dvz@xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=",

    "Prefix": "D@",

    "PrefixColor": "yellow",

    "NameColor": "green"

  }

]

```

There is one object for each Devzat instance which must contain:

* `Host`: URL and gRPC port of the instance.

* `Token`: Devzat token granted in that instance. 

* `Prefix`: Prefix put before every message coming from that instance.

* `PrefixColor`: Color used to display the prefix.

* `nameColor`: Color used to display names of users in that instance.

The available colors are:

* black

* red

* green

* yellow

* blue

* purple

* cyan

* white

Invalid or missing colors will default to uncolored text.

Compile the code in this repository with `go build` and run the resulting executable with the configuration file as argument.

## Future improvement

Possible now:

* Monitor active users in each instance.

* Add 8 bits colors.

* Try to read command outputs.

Depending on future Devzat improvements:

* If we get admin info from the instance: admins can block specific instances.

* If we get user's color: try to use them.