diff --git a/README.md b/README.md index 5e0d96a19..c462edaff 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,109 @@ ![Aelysium Wordmark Image](https://github.com/Aelysium-Group/.github/blob/main/images/rustyconnector-wordmark.png?raw=true) -# RustyConnector -![Velocity](https://badgen.net/badge/Velocity/3.1.1%20-%203.2.0/1197d1?icon=dockbit) -![PaperMC](https://badgen.net/badge/Paper/1.16%20-%201.20.1/F96854?icon=telegram) -![Folia](https://badgen.net/badge/Folia/Supported/E004BC?icon=maven) -[![Aelysium](https://badgen.net/badge/Discord/Aelysium/5865F2?icon=discord)](https://join.aelysium.group/) -[![Build](https://badgen.net/github/release/Aelysium-Group/rusty-connector?label=Latest%20Stable%20Release&icon=maven)](https://github.com/Aelysium-Group/rusty-connector/releases) +# 👋 Welcome to RustyConnector +![Velocity](https://flat.badgen.net/badge/Velocity/3.1.1%20-%203.2.0/1197d1?icon=dockbit) +![PaperMC](https://flat.badgen.net/badge/Paper/1.16%20-%201.20.1/F96854?icon=telegram) +![Folia](https://flat.badgen.net/badge/Folia/Supported/E004BC?icon=maven) +[![Aelysium](https://flat.badgen.net/badge/Discord/Aelysium/5865F2?icon=discord)](https://join.aelysium.group/) +[![Build](https://flat.badgen.net/github/release/Aelysium-Group/rusty-connector?label=Latest%20Stable%20Release&icon=maven)](https://github.com/Aelysium-Group/rusty-connector/releases) +[![License](https://flat.badgen.net/badge/License/MIT/5865F2)](https://github.com/Aelysium-Group/rusty-connector/blob/main/LICENSE) -RustyConnector is a Velocity network backbone plugin. It lets you register brand-new servers to the proxy during runtime and load balance players between them. +[RustyConnector] is a load-balancing plugin that can run on [Velocity]/[Paper]/[Folia] networks, which allows your proxy to automatically register or unregister sub-servers while is running. -
+ + + +

🧭 Links

+ + + + + + + + + + + + + + + + + + + +
+
+ +
+

Wiki

+

+ Wanna learn how to get started? Look here! +

+
+
+ +
+

Download

+

+ Download from GitHub, or check out the plugin release pages. +

+
+
+ +
+

Support

+

+ Join our Discord community here for support! +
+ (Support is offered to paying server members only) +

+
+
+ +
+

Report Bugs

+

+ Experiencing annoying bugs while using the plugin? Report them here to help us squash them. +

+
-## [Support](https://join.aelysium.group/) | [Wiki](https://github.com/Aelysium-Group/rusty-connector/wiki) | [Download](https://github.com/Aelysium-Group/rusty-connector/releases) | [Report Bugs](https://github.com/Aelysium-Group/rusty-connector/issues) - -## [Modrinth](https://modrinth.com/plugin/rustyconnector) | [Hangar](https://hangar.papermc.io/nathan-i-martin/RustyConnector) - -
+ + + +

🚀 Plugin Release Page

+ + + + + + + + + + + +
+
+ +
+

Modrinth

+

+ Click to go to Modrinth plugin release page. +

+
+
+ +
+

Hangar

+

+ Click to go to Hangar plugin release page. +

+
--- -# Features +# ✨ Features - ### ✅ Built for large networks - ### ✅ Register brand-new servers to the proxy during runtime - ### ✅ Blazing fast data transmission with Redis integration @@ -34,13 +119,14 @@ RustyConnector is a Velocity network backbone plugin. It lets you register brand - ### ✅ Works with Folia - ### ❌ Can't give you a hug --- -# Networks Served: +# 🎨 Statistics + +## 🌌 Networks Served ([Click to view](https://bstats.org/plugin/velocity/RustyConnector/17972)): [![RustyConnector bstats graph](https://bstats.org/signatures/velocity/RustyConnector.svg)](https://bstats.org/signatures/velocity/RustyConnector.svg) -# Sub-Servers Served: +## 🌌 Sub-Servers Served ([Click to view](https://bstats.org/plugin/bukkit/RustyConnector/17973)): [![RustyConnector bstats graph](https://bstats.org/signatures/bukkit/RustyConnector.svg)](https://bstats.org/signatures/bukkit/RustyConnector.svg) --- -## Incoming Features/Changes -- [ ] Rounded families (families built for round based gamemodes!) [__Under Development__] +## 🛠 Incoming Features/Changes - [ ] Player parties (join your friend's party and follow them around the network as they connect to different families!) [__Under Development__] - [ ] Websocket as a backup for if Redis fails [__Under Research__] - [ ] Example RustyConnector Networks for Documentation Purposes [__Under Development__] @@ -53,7 +139,7 @@ RustyConnector is a Velocity network backbone plugin. It lets you register brand --- -# Wiki +# 📖 Wiki ### [Home](https://github.com/Aelysium-Group/rusty-connector/wiki) ### [FAQ](https://github.com/Aelysium-Group/rusty-connector/wiki#faq) ### [Getting Started](https://github.com/Aelysium-Group/rusty-connector/wiki/Getting-Started-(First-Time)) @@ -68,3 +154,21 @@ RustyConnector is a Velocity network backbone plugin. It lets you register brand - [RC-Velocity](https://github.com/Aelysium-Group/rusty-connector/wiki/Config-v2#rc-velocity) - [RC-Paper](https://github.com/Aelysium-Group/rusty-connector/wiki/Config-v2#rc-paper) ### [Config Migration](https://github.com/Aelysium-Group/rusty-connector/wiki/Config-Migration) + +## 🌐 Language Switch + +语言切换 / Need to switch languages? + +[![English](https://flat.badgen.net/badge/English/Click%20me/blue)](https://github.com/Aelysium-Group/rusty-connector/blob/main/README.md) +![简体中文](https://flat.badgen.net/badge/简体中文/Coming%20soon/blue) +![繁體中文](https://flat.badgen.net/badge/繁體中文/Coming%20soon/blue) + + + +2023 © [Aelysium](https://www.aelysium.group) + + +[Folia]:https://github.com/PaperMC/Folia +[Paper]: https://papermc.io +[Velocity]: https://velocitypowered.com +[RustyConnector]: https://github.com/Aelysium-Group/rusty-connector diff --git a/blob/images/logo/hangar.svg b/blob/images/logo/hangar.svg new file mode 100644 index 000000000..1514fecec --- /dev/null +++ b/blob/images/logo/hangar.svg @@ -0,0 +1,225 @@ + + diff --git a/blob/images/logo/modrinth.svg b/blob/images/logo/modrinth.svg new file mode 100644 index 000000000..9c569ca46 --- /dev/null +++ b/blob/images/logo/modrinth.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/blob/images/logo/rc-logo.webp b/blob/images/logo/rc-logo.webp new file mode 100644 index 000000000..44d4be348 Binary files /dev/null and b/blob/images/logo/rc-logo.webp differ