Skip to content

Latest commit

 

History

History
154 lines (104 loc) · 6.8 KB

README.md

File metadata and controls

154 lines (104 loc) · 6.8 KB
Raw

AurionChat

What is it ?

AurionChat is a cross chat plugin beetween server for bukkit and sponge. We can describe as a chat channel plugin too. This plugin work with rabbitmq to transfer the message beetween the server if you don't know what i'm talking please refer to this

How it works ?

When you send the message if other people listen to the same channel as you typed, they will receive the message. The same apply for you :)

Features

  • Chat channel
  • Formating chat
  • Bukkit 1.7 to 1.20.1 - Sponge 8 - Fabric 5.1.20 - Forge 1.16 and 1.18 support
  • Automessage

Commands

  • channel : List the channel listened
  • channel join <channelName> : Listen and Join the desired channel
  • channel leave <channelName> : Leave the desired channel
  • channel spy <channelName> : Listen the desired channel
  • channel alllisten : Listen to all available channel

Permissions

Permission Description
aurionchat.chat.speak Can speak in channel
aurionchat.chat.colors Usage of colors in chat
aurionchat.joinchannel.<channel> Auto join the channel
aurionchat.listenchannel.<channel> Auto listen to the channel
aurionchat.channel.join.<channel> Can join the channel
aurionchat.channel.leave.<channel> Can leave the channel
aurionchat.channel.spy.<channel> Can spy the channel
aurionchat.channel.alllisten Can spy/listen all the channel

Chat

You need a rabbitmq server for the plugin to make it work. Just replace the uri with you user and pass and the host. You can have more info about the uri here : https://www.rabbitmq.com/uri-spec.html

⚠️ By default, player who join will listen to the channel "global" and will have his current channel set to the serverName in the configuration

The plugin/mod assume that a global channel is always defined and player who join the server will listen to the channel and the channel of the server by default

This an example to declare a channel :

channels:
    #You can put any alphanumeric name you want.
    <name>:
        format : "[GLOBAL] {prefix}{display_name} : &f{message}"
        alias: "g" # It's just an alias for the command

At this time you can use only this token :

{prefix} : Get the prefix from Vault (Bukkit) Or LuckPerms (Sponge)
{suffix} : Get the suffix from Vault (Bukkit) or LuckPerms (Sponge)
{display_name} : Get the displayname you have on the server
{message} : The message :)

You can put any color code beetwen the token or any characters if you want.

Forge 1.16

The mod need FTBRanks to be working with a minimal version of 1605.1.5.

The config file is the same syntax as the sponge one.

Server crash with this error : java.lang.NoClassDefFoundError: org/slf4j/spi/SLF4JServiceProviderg

When you start the server with the mod and you have the error below :

java.lang.NoClassDefFoundError: org/slf4j/spi/SLF4JServiceProvider
	at java.lang.ClassLoader.defineClass1(Native Method) ~[?:?] {}
	at java.lang.ClassLoader.defineClass(ClassLoader.java:1017) ~[?:?] {}
	at java.security.SecureClassLoader.defineClass(SecureClassLoader.java:174) ~[?:?] {}
	at jdk.internal.loader.BuiltinClassLoader.defineClass(BuiltinClassLoader.java:800) ~[?:?] {}
	at jdk.internal.loader.BuiltinClassLoader.findClassOnClassPathOrNull(BuiltinClassLoader.java:698) ~[?:?] {}
	at jdk.internal.loader.BuiltinClassLoader.loadClassOrNull(BuiltinClassLoader.java:621) ~[?:?] {}
	at jdk.internal.loader.BuiltinClassLoader.loadClass(BuiltinClassLoader.java:579) ~[?:?] {}
	at jdk.internal.loader.ClassLoaders$AppClassLoader.loadClass(ClassLoaders.java:178) ~[?:?] {}
	at java.lang.ClassLoader.loadClass(ClassLoader.java:576) ~[?:?] {}

You need to delete this folder from your server : libraries/org/apache/logging/log4j/log4j-slf4j18-impl and you can start again the server.

Forge 1.18

The mod need Luckperms to be working with a minimal version of 5.1.20. Be careful Luckperms need a specific version of forge to be working.

Follow the 1.16 section for futher instructions

Fabric

The mod need Luckperms to be working with a minimal version of 5.1.20. The config file is the same syntax as the sponge one.

URL Mode

Theres a variety of options available for handling URLs. Options are as follows:

The option are based on enum in the code : https://github.com/Mineaurion/Aurionchat/blob/master/common/src/main/java/com/mineaurion/aurionchat/common/Utils.java#L24

Name Value Description
Disallow URL and Domain DISALLOW Disallow domain and url and replace it with "[url removed]"
Disallow URL DISALLOW_URL Disallow only url and domain remain intact
Display only Domain DISPLAY_ONLY_DOMAINS Replace any url with only the domain, the url is instact for click
Force Https FORCE_HTTPS Replace any http url with https instead
Allow only domain click CLICK_DOMAIN Domain will be only clickable
Allow URLs ALLOW Allow url to be clickable and domain

The options.url_mode configuration value is an array so you can add multiple to value to it. Be careful to respect the syntax of the value or the config will not work.

Automessage

For this part to work you need to install this plugin on one of our server.

You can disable the automessage for one server in the configurtion just switch this :

 enable=true

To this :

 enable=false

Permission of every automessage channel is : aurionchat.automessage.<channelName>

Discord

Integration Service

There is a third-party Discord integration bot that works with AurionChat available here.

Support Server

If you need support regarding our plugin, come on our discord

Development

For debugging purpose and test, there is a docker-compose.yaml available to setup a simple rabbitmq