Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/plusls/lls-manager

A velocity plugin to manage server, such as whitelist, chat bridge, remember last server, offline auth.
https://github.com/plusls/lls-manager

Last synced: about 2 months ago
JSON representation

A velocity plugin to manage server, such as whitelist, chat bridge, remember last server, offline auth.

Host: GitHub
URL: https://github.com/plusls/lls-manager
Owner: plusls
Created: 2021-07-16T19:37:12.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2022-01-31T08:25:49.000Z (almost 3 years ago)
Last Synced: 2024-10-31T11:36:33.154Z (2 months ago)
Language: Java
Homepage:
Size: 39.1 MB
Stars: 15
Watchers: 3
Forks: 6
Open Issues: 9
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# lls-manager

A velocity plugin to manage server, such as whitelist, chat bridge, remember last server, offline auth.

**This plugin still in beta.**

## Config file

Config file example.

### Main Config

Main config file example.

```json5
{
// show all player inn tab list
"showAllPlayerInTabList": true,
// allow bridge chat message
"bridgeChatMessage": true,
// send message to all server when player join
"bridgePlayerJoinMessage": true,
// send message to all server when player leave
"bridgePlayerLeaveMessage": true,
// whitelist
"whitelist": true,
// default use mojang auth
"defaultOnlineMode": true,
// default channel
"defaultChannel": "server",
// this server will be used to auth.
"authServerName": "lls-auth",
// Player in this channel will receive the message in server.
"chatMessageChannelList": [
"server",
"global"
],
// If player in this channel, player's chat will be bridge.
"bridgeMessageChannelList": [
"server",
"global"
],
// Player in this channel will receive the message of player leave message.
"leaveMessageChannelList": [
"server",
"global"
],
// Player in this channel will receive the message of player join message.
"joinMessageChannelList": [
"server",
"global"
]
}
```

### Player Config

Player config example.

```json5
{
"onlineMode": true,
"password": "",
"lastServerName": "survival",
"channel": "global",
"lastSeenTime": "Jul 21, 2021, 1:12:18 AM"
}
```

### Whitelist Config

Whitelist config example.

```json5
{
"whiteList": [
"plusls"
]
}
```

## Features

The features of lls-manager

### Show All Player In Tab List

lls-manager will add the player in other sub-server to tab list.

![show-all-player-in-tab-list.png](./docs/img/show-all-player-in-tab-list.png)

It supports show player's head when use chat bridge.(With mod [chat_heads](https://www.curseforge.com/minecraft/mc-mods/chat-heads))

![chat-bridge-head.png](./docs/img/chat-bridge-head.png)

### Chat Bridge

lls-manager will forward the chat from other server.

![ichat-bridge.png](./docs/img/chat-bridge.png)

#### Channel
lls-manager has a channel system, default if player in `server` or `global` channel, their message will be forwarded.

If player in `sub_server` channel, their chat will not be forwarded.

![ichat-bridge.png](./docs/img/channel.png)

### Offline Auth

lls-manager support offline-auth and mojang auth. I will check the username and find the user config.

If the `onlineMode` field in player config is false, it will use offline auth.

The offline auth need an `auth server` to auth user. It is very recommend to set game mode to **spectator** in Auth server, because player can do **everything** in auth server **except run command**.

The player who is not logged in just can run `/lls_register` and `/lls_login`.

After player logged in, player can use `/server` command to join other sub-server.

![offline-auth.png](./docs/img/offline-auth.png)

#### Note

When `defaultOnlineMode` is true, if server admin want to add a new offline auth user, should use `/lls_create_player ` to create a dummy user, and use `/lls_player setOnlineMode false` to set user to offline mode.

When `defaultOnlineMode` is false, if server admin want to add a new mojang auth user, should use `/lls_player setOnlineMode true` to set user to online mode.

### Whitelist

A custom whitelist system use username.

### Remember last server

It will remember the last logged in server of player.

### Compat

It compat with [Floodgate](https://github.com/GeyserMC/Floodgate/wiki)

## Command

The command in lls-manager.

### lls_whitelist

need permission `lls-manager.admin`

+ /lls_whitelist add \
+ /lls_whitelist remove \
+ /lls_whitelist list
+ /lls_whitelist reload
+ /lls_whitelist status
+ /lls_whitelist on
+ /lls_whitelist off

### lls_channel

#### Show all channel.

+ /lls_channel

#### Switch channel

+ /lls_channel \

### lls_login

+ /lls_login \

### lls_register

+ /lls_passwd \ \

### lls_passwd

Change password

+ /lls_passwd \ \

### lls_seen

See the last login time of player.

+ /lls_seen

![offline-auth.png](./docs/img/seen.png)

### lls_player

need permission `lls-manager.admin`

A command to manage player data.
+ /lls_player \ resetPassword
+ /lls_player \ setOnlineMode \
+ /lls_player \ setChannel \

### lls_create_player

need permission `lls-manager.admin`

A command to create a user with default config.

+ /lls_create_player \

## TODO

Add gRPC api to manage server.