|
1 | 1 |  |
2 | 2 |
|
3 | | -Akropolis is a modern Minecraft hub server solution that is based on DeluxeHub by ItsLewizzz. |
4 | | -It contains almost all of its features and configuration files are almost the same, so you can just |
5 | | -drop your configuration into the plugin's directory, make a few modifications and use it. |
| 3 | +<p align="center"> |
| 4 | + <img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/devblook/akropolis/build.yml?style=for-the-badge&logo=github" href=""> |
| 5 | + <a href="https://modrinth.com/plugin/akropolis"> |
| 6 | + <img alt="Modrinth Downloads" src="https://img.shields.io/modrinth/dt/akropolis?style=for-the-badge&logo=modrinth"> |
| 7 | + </a> |
| 8 | + <img alt="GitHub Downloads (all assets, all releases)" src="https://img.shields.io/github/downloads/devblook/akropolis/total?style=for-the-badge&logo=github"> |
| 9 | + <a href="https://discord.gg/w438z8TKej"> |
| 10 | + <img alt="Discord" src="https://img.shields.io/discord/1004083586326077512?style=for-the-badge&logo=discord&label=discord&color=%235865F2&link=https%3A%2F%2Fdiscord.gg%2Fw438z8TKej"> |
| 11 | + </a> |
| 12 | +</p> |
6 | 13 |
|
7 | | -The main difference between Akropolis and DeluxeHub is that Akropolis uses more modern technologies, like MiniMessage, |
8 | | -the Paper API and updated Java versions. While this give us some performance and usability benefits, it also means |
9 | | -that we won't be giving support to older versions of Minecraft and other Minecraft server software that isn't derivated |
10 | | -from Paper, which is not the case of DeluxeHub. |
11 | | -Simply use what you feel meets your needs. |
| 14 | +**Akropolis** is the **modern Minecraft lobby** server **core plugin** your network deserves. It is built to leverage the proven functionality of its predecessor, DeluxeHub, while focusing entirely on modernization and performance. |
12 | 15 |
|
13 | | -## How to |
| 16 | +#### 💎 Why you **should use Akropolis**? |
14 | 17 |
|
15 | | -### Install |
| 18 | +The key **distinction** (and our strength!) lies in the **cutting-edge technologies** that **Akropolis** exclusively supports: |
16 | 19 |
|
17 | | -To use this plugin just a grab a binary from the [releases page](https://github.com/devblook/akropolis/releases) |
18 | | -or [compile it](#compile) yourself and drop it into your `plugins/` directory. Take in mind that you will need to be |
19 | | -running Paper 1.21+ so Akropolis can run properly. You can download Paper from [here](https://papermc.io/downloads). |
| 20 | +- ✨ **MiniMessage:** For beautiful, advanced chat styling and vibrant color palettes. |
| 21 | +- 🚀 **Paper API:** Leveraging high-performance features for maximum speed and stability. |
| 22 | +- 💻 **Updated Java Versions:** Ensures you are running on the latest, fastest JVM. |
20 | 23 |
|
21 | | -### Compile |
| 24 | +This commitment to modernity provides **significant performance and usability benefits**. However, please note that we exclusively support **Paper 1.21+** (and modern server software derived from Paper). If you require support for older Minecraft versions, DeluxeHub may be a better fit. **Choose wisely!** |
22 | 25 |
|
23 | | -Compiling Akropolis is pretty simple, just one command, and you're ready to go: |
| 26 | +## ⚙️ How To |
24 | 27 |
|
25 | | -**Linux (and other UNIX derivatives):** |
| 28 | +### 💾 Install |
| 29 | + |
| 30 | +To begin using **Akropolis**, simply download the compiled plugin right here or [compile it yourself](https://github.com/devblook/akropolis/tree/stable#compile). |
| 31 | + |
| 32 | +**Important:** Akropolis requires you to be running **Paper 1.21+** to function correctly. You can easily download the latest Paper build from [here](https://papermc.io/downloads/paper). |
| 33 | + |
| 34 | +### 🔨 Compile |
| 35 | + |
| 36 | +Compiling Akropolis is straightforward and requires just one command: |
| 37 | + |
| 38 | +**🐧 Linux (and other UNIX derivatives):** |
26 | 39 |
|
27 | 40 | ```bash |
28 | | -./gradlew shadowJar |
| 41 | + ./gradlew shadowJar |
29 | 42 | ``` |
30 | 43 |
|
31 | | -**Windows:** |
| 44 | +**🪟 Windows:** |
32 | 45 |
|
33 | 46 | ```batch |
34 | | -gradlew.bat shadowJar |
| 47 | + gradlew.bat shadowJar |
35 | 48 | ``` |
36 | 49 |
|
37 | | -Then you will find the binary under the `build/libs/` directory. |
| 50 | +The resulting binary will be located in the `build/libs/` directory. |
| 51 | + |
| 52 | +### 📩 Report Bugs or Request Features |
| 53 | + |
| 54 | +Your feedback is invaluable for the continued development of Akropolis. To report issues or suggest enhancements, please use one of our dedicated templates: |
38 | 55 |
|
39 | | -### Report bugs or request features |
| 56 | +* [Click here to report a bug](https://github.com/devblook/akropolis/issues/new?assignees=zetastormy&labels=bug&template=bug_report.yml&title=A+brief+description+of+your+report) |
| 57 | +* [Click here to request a feature](https://github.com/devblook/akropolis/issues/new?assignees=zetastormy&labels=enhancement&template=feature_request.yml&title=A+brief+description+of+your+request) |
40 | 58 |
|
41 | | -Reporting a bug or requesting a feature can be useful for further development of the plugin. To do that you just need |
42 | | -to fill one of the issue templates we made for you: |
43 | | -[Click here to report a bug](https://github.com/devblook/akropolis/issues/new?assignees=zetastormy&labels=bug&template=bug_report.yml&title=A+brief+description+of+your+report) |
44 | | -or [click here to request a feature](https://github.com/devblook/akropolis/issues/new?assignees=zetastormy&labels=enhancement&template=feature_request.yml&title=A+brief+description+of+your+request). |
| 59 | +### 🤝 Contribute |
45 | 60 |
|
46 | | -### Contribute |
| 61 | +We encourage contributions! While we maintain minimal requirements, please ensure: |
47 | 62 |
|
48 | | -At the moment we don't have a lot of requirements to contribute, just make sure to clarify |
49 | | -the features or fixes that you introduce in your pull request and try to follow the |
50 | | -[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. |
| 63 | +1. You clarify the features or fixes you introduce in your pull request. |
| 64 | +2. You attempt to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification. |
51 | 65 |
|
52 | | -## License |
| 66 | +## 📄 License |
53 | 67 |
|
54 | 68 | This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for |
55 | 69 | details. |
0 commit comments