Sync README, release 2.0.0
Crypnotic
parent
14a2c787d7
commit
b806ebaea7
51
README.md
51
README.md
|
|
@ -5,10 +5,10 @@
|
|||
Neutron is an open-source plugin written to try to provide the bare essentials for servers using Velocity.
|
||||
|
||||
## How do I get it?
|
||||
You can download Neutron from my GitHub:
|
||||
https://github.com/Crypnotic/Neutron/releases/tag/1.0.1-ALPHA
|
||||
You can download Neutron from the CodeMC Jenkins:
|
||||
https://ci.codemc.org/job/Crypnotic/job/Neutron/lastSuccessfulBuild/
|
||||
|
||||
_Neutron just entered its first alpha, expect issues when using it for now_
|
||||
_Neutron just entered its first release, there may still be lingering bugs_
|
||||
|
||||
## What does it offer?
|
||||
Currently, Neutron offers 6 commands:
|
||||
|
|
@ -17,24 +17,35 @@ Currently, Neutron offers 6 commands:
|
|||
* `info` - provides information regarding a player
|
||||
* `glist` - shows a list of all servers along with how many players are connected
|
||||
* `message` - sends a private message to another player
|
||||
* `send`- sends either a player/ a server/ or everyone to a specified server
|
||||
* `send`- sends either a player, a server, or everyone to a specified server
|
||||
|
||||
Alongside the commands, Neutron offers 2 modules:
|
||||
* Server list:
|
||||
* Provide a custom MOTD for your server in the multiplayer server list
|
||||
* Change the max players online:
|
||||
* `Static`: player count will always be the number defined under `max-player-count`
|
||||
* `Current`: player count matches the number of players online
|
||||
* `OneMore`: player count shows the number of players online plus 1
|
||||
* Change the message shown when the mouse hovers over the online player count:
|
||||
* `Message`: preview will show the messages defined under `preview-messages`
|
||||
* `Players`: preview matches the vanilla server preview of showing online players
|
||||
* `Empty`: preview is empty
|
||||
Alongside the commands, Neutron offers 4 modules:
|
||||
* Announcements:
|
||||
* Announcements will be sent to all online players at set intervals
|
||||
* Multiple lists can be defined, which can run a different intervals with different messages
|
||||
* You can choose whether a list will maintain its order or be randomized
|
||||
* Each list can have a `prefix`, which will be added to the beginning of every message in the list
|
||||
* Each list can have a `prefix`, which is added to the beginning of every message in the list
|
||||
* Commands:
|
||||
* Allows the customization of all command aliases
|
||||
* Disable each command individually, or disable them all
|
||||
* Locales:
|
||||
* Translate all messages per player using pre-defined localizations
|
||||
* English(`en_US`) is default and currently the only locale shipped with the plugin
|
||||
* Adding locales:
|
||||
1. Copy the existing `en_US.conf` file and rename it to the target locale
|
||||
2. Change any messages to your liking
|
||||
3. Save the file, and run /velocity reload in-game
|
||||
* Server list:
|
||||
* Provide a custom MOTD for your server in the multiplayer server list
|
||||
* Change the max players online:
|
||||
* `Current`: player count matches the number of players online
|
||||
* `OneMore`: player count shows the number of players online plus 1
|
||||
* `Ping`: ping all online backend servers and sum the max player counts
|
||||
* `Static`: player count will always be the number defined under `max-player-count`
|
||||
* Change the message shown when the mouse hovers over the online player count:
|
||||
* `Message`: preview will show the messages defined under `preview-messages`
|
||||
* `Players`: preview matches the vanilla server preview of showing online players
|
||||
* `Empty`: preview is empty
|
||||
|
||||
_Modules can be `enabled/disabled` in the `config.conf`_
|
||||
_All modules support reloading with the `/velocity reload` command_
|
||||
|
|
@ -44,14 +55,6 @@ Permissions are simply in the way that all command permissions are `neutron.comm
|
|||
|
||||
For example: the permission for alert is `neutron.command.alert`
|
||||
|
||||
## Lets talk about Locales
|
||||
Neutron has a built in Localization manager that allows all messages to be translated per player**
|
||||
|
||||
\** Messages can only be translated if the player's locale has been added to `neutron/locales`
|
||||
The English(`en_US`) localization is default and provided with the plugin.
|
||||
|
||||
To add another localization, copy the existing `en_US.conf` file and rename it to the name of the locale you would like to support. Note: it is easier to use the `/info` command on a player to figure out the country tag to use for the name of the file
|
||||
|
||||
## Issues
|
||||
If you run into any issues, please report them on Github: https://github.com/Crypnotic/Neutron/issues
|
||||
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ plugins {
|
|||
}
|
||||
|
||||
group 'me.crypnotic'
|
||||
version '2.0.0-SNAPSHOT'
|
||||
version '2.0.0'
|
||||
description 'An open-source essential suite for the Velocity proxy'
|
||||
|
||||
repositories {
|
||||
|
|
|
|||
Loading…
Reference in New Issue