RedGuy/AuthMeVelocity
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: improved README

Browse Source
This commit is contained in:
Adrian 2023-02-06 21:10:09 -05:00
parent d3188205e3
commit d30857f682
2 changed files with 13 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -10,6 +10,14 @@ This plugin adds the support for [Velocity](https://velocitypowered.com/) to [Au
- Velocity 3.1.2 or 3.2.0 - Velocity 3.1.2 or 3.2.0
- Java 17+ - Java 17+
## Features
- Prevent your players from executing commands or typing in the chat before they are logged in
- Forces the first server that players enter to be an Auth server
- Send players to another server when logging in natively (AuthMeReloaded has bugs with this functionality on its own)
- Prevents players from having to re-login each time they join a server with AuthMe installed
- Get access to the AuthMe API from Velocity
- Compatibility with [FastLogin](https://github.com/games647/FastLogin) (AutoLogin support in the proxy) and [MiniPlaceholders](https://modrinth.com/plugin/miniplaceholders) (use AuthMeVelocity placeholders in any other plugin and vice versa)
## Setup ## Setup
1. Download the latest release of the plugin [link](https://github.com/4drian3d/AuthMeVelocity/releases) 1. Download the latest release of the plugin [link](https://github.com/4drian3d/AuthMeVelocity/releases)
2. Put the plugin in the Velocity plugins folder and on all your Auth servers that have AuthMe installed. 2. Put the plugin in the Velocity plugins folder and on all your Auth servers that have AuthMe installed.
@ -18,6 +26,10 @@ This plugin adds the support for [Velocity](https://velocitypowered.com/) to [Au
## Plugin API ## Plugin API
Check the plugin API [here](https://github.com/4drian3d/AuthMeVelocity/wiki/Plugin-API) Check the plugin API [here](https://github.com/4drian3d/AuthMeVelocity/wiki/Plugin-API)
### Javadocs
- Paper API [Javadocs](https://javadoc.jitpack.io/com/github/4drian3d/AuthMeVelocity/api-paper/latest/javadoc/)
- Velocity API [Javadocs](https://javadoc.jitpack.io/com/github/4drian3d/AuthMeVelocity/api-velocity/latest/javadoc/)
## Configuration ## Configuration
Check the plugin configuration [here](https://github.com/4drian3d/AuthMeVelocity/wiki/Configuration) Check the plugin configuration [here](https://github.com/4drian3d/AuthMeVelocity/wiki/Configuration)

3
velocity/src/main/java/me/adrianed/authmevelocity/velocity/commands/AuthMeCommand.java
View File

@ -19,7 +19,6 @@ package me.adrianed.authmevelocity.velocity.commands;
import com.mojang.brigadier.Command; import com.mojang.brigadier.Command;
import com.mojang.brigadier.builder.LiteralArgumentBuilder; import com.mojang.brigadier.builder.LiteralArgumentBuilder;
import com.mojang.brigadier.tree.LiteralCommandNode;
import com.velocitypowered.api.command.BrigadierCommand; import com.velocitypowered.api.command.BrigadierCommand;
import com.velocitypowered.api.command.CommandManager; import com.velocitypowered.api.command.CommandManager;
import com.velocitypowered.api.command.CommandMeta; import com.velocitypowered.api.command.CommandMeta;
@ -38,7 +37,7 @@ public class AuthMeCommand {
final CommandManager manager, final CommandManager manager,
final Logger logger final Logger logger
) { ) {
LiteralCommandNode<CommandSource> command = LiteralArgumentBuilder.<CommandSource>literal("authmevelocity") final var command = LiteralArgumentBuilder.<CommandSource>literal("authmevelocity")
.requires(src -> src.hasPermission("authmevelocity.commands")) .requires(src -> src.hasPermission("authmevelocity.commands"))
.then(LiteralArgumentBuilder.<CommandSource>literal("reload") .then(LiteralArgumentBuilder.<CommandSource>literal("reload")
.executes(cmd -> { .executes(cmd -> {