Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hello-andrew-yan/velocity-relink
Utility plugin that will relink you to your previously connected server in a Velocity network.
https://github.com/hello-andrew-yan/velocity-relink
java minecraft minecraft-plugin velocity velocity-plugin
Last synced: 3 days ago
JSON representation
Utility plugin that will relink you to your previously connected server in a Velocity network.
- Host: GitHub
- URL: https://github.com/hello-andrew-yan/velocity-relink
- Owner: hello-andrew-yan
- License: mit
- Created: 2024-04-08T02:49:12.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-08-30T09:06:57.000Z (5 months ago)
- Last Synced: 2024-12-06T18:17:51.353Z (2 months ago)
- Topics: java, minecraft, minecraft-plugin, velocity, velocity-plugin
- Language: Java
- Homepage:
- Size: 79.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Relink
Relink is a utility plugin designed for Velocity, a proxy server for Minecraft.
It will automatically relink players to their previously connected server within the network seamlessly.
---
## Installation
1. Download the most recent release of the `relink.jar` file from this repository.
2. Copy the `relink.jar` file into the plugins folder of your velocity network.
3. Restart the Velocity network to load the plugin.
## Configuration
Upon loading the plugin for the first time, a default configuration file (`config.toml`) will be generated in the plugin folder. You can customize this configuration according to your preferences.
### Configuration Options
```toml
#####################################################
[proxy]
# Default values are based on the default servers
# generated when creating new velocity network.
linked = ["lobby", "factions", "minigames"]
#####################################################
[sql]
url = ""
username = ""
password = ""
#####################################################
```
- **Proxy Servers** (`[proxy]`)
- Define the list of servers that are linked by Relink.
- Default values are provided based on the default servers in the network upon first installation.
- **SQL Database Connection** (`[sql]`)
- Specify the URL, username, and password for the SQL database.
- This is required for Relink to store and retrieve player connection data.
- **Local Storage Alternative**
- If the user wishes not to connect to a MySQL database, they can leave the values blank in under the `[sql]` table, and Relink will automatically switch to a local file called `data.toml` stored in the plugin folder.
```toml
# Example data.toml file.
185b9b7a-2cfc-499e-b36a-5e39d6d86e14 = "minigames"
1638e0cf-9204-4b56-b888-07edb1d4a803 = "minigames"
02395569-dc0a-403c-a01d-dbf49e98f855 = "factions"
2137687a-e10d-462b-b574-86d309277146 = "hub"
```
Users are stored via their UUID's followed by the name of the server under the Velocity network they last connected to before disconnecting.
## Usage
Users need to specify which servers are linked by Relink in the `[proxy]` table accordingly. Once configured, Relink will seamlessly relink players to their last visited server within the network. To retrieve the name of servers in your velocity network, check your `velocity.toml` configuration file in your velocity proxy under the `[servers]` table.
## Contributing
Feel free to contribute to this project by submitting bug reports, feature requests, or pull requests on the [GitHub repository](https://github.com/hello-andrew-yan/velocity-relink).
## License
This project is licensed under the [MIT License](LICENSE).
---
Broken Link icon by Icons8