Skip to content

Commit 842eec6

Browse files
committed
docs: design is finished
1 parent a7d9b67 commit 842eec6

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
# JManhunt ![Version](https://img.shields.io/badge/Version-1.0.0--SNAPSHOT-aqua) ![Java](https://img.shields.io/badge/Java-21-orange) ![Platform](https://img.shields.io/badge/Platform-Paper-blue) [![Discord](https://img.shields.io/discord/844095367704477756?color=7289da&label=Discord)](https://jozelot.de/discord)
2-
1+
# JManhunt [![Version](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Frepo.jozelot.de%2Frepository%2Fmaven-public%2Fde%2Fjozelot%2Fjmanhunt-api%2Fmaven-metadata.xml&label=version&color=aqua)](https://modrinth.com/plugin/jmanhunt) ![Java](https://img.shields.io/badge/Java-21-orange) ![Platform](https://img.shields.io/badge/Platform-Paper-blue) [![Discord](https://img.shields.io/discord/844095367704477756.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://jozelot.de/discord)
32

43
High Performance Manhunt Engine für Minecraft. For Players and Developers.
54

6-
75
**Support and Project Discussion:**
86
- [Discord](https://jozelot.de/discord)
97

@@ -17,17 +15,17 @@ High Performance Manhunt Engine für Minecraft. For Players and Developers.
1715
- Full plugin- and world-reset for starting a new manhunt
1816

1917
## How to (Developing Addons)
20-
- [See our API](https://github.com/FrostleafDev/JManhunt/tree/master/api)
21-
- [Frostleaf's API javadocs](https://jozelot.de/javadocs)
22-
- [JManhunt API javadocs](https://jd.jozelot.de/jmanhunt-api/)
23-
- [JManhunt API documentation](https://docs.jozelot.de/manhunt-api)
24-
- [JManhunt API versions](https://repo.jozelot.de/#browse/browse:maven-public:de%2Fjozelot%2Fjmanhunt-api)
18+
* [See our API](https://github.com/FrostleafDev/JManhunt/tree/master/api)
19+
* [Frostleaf's API javadocs](https://jozelot.de/javadocs)
20+
* [JManhunt API javadocs](https://jd.jozelot.de/jmanhunt-api/)
21+
* [JManhunt API documentation](https://docs.jozelot.de/manhunt-api)
22+
* [JManhunt API versions](https://repo.jozelot.de/#browse/browse:maven-public:de%2Fjozelot%2Fjmanhunt-api)
2523

2624
You can easily create addons for the plugin.
2725
I will provide some addons from my own to show how the api works.
2826
When you publish an addon please send it to my discord so I can review it and advertise it here on the Github and the docs.
2927

30-
**Addons I will create**
28+
**Addons I will create:**
3129
- Simple Voice Chat Integration
3230

3331
**Gradle (Kotlin & Groovy)**
@@ -67,12 +65,17 @@ java {
6765
```
6866

6967
## How To (Compiling From Source)
70-
To compile JManhunt yourself, you need JDK 21 or later and an internet connection<br>
68+
To compile JManhunt yourself, you need JDK 21 or later and an internet connection<br><br>
7169
Clone this repo. Then navigate either to the `api` or `plugin` folder and run: `mvn clean package`
7270
You can find the compiled jar in the `/plugin/target` or `api/target` folder.
7371

74-
## Contribution
72+
## ❤️ Support the Project
73+
JManhunt is a passion project developed in our free time. If you want to support the development:
74+
75+
* **Contribute:** Help us by reporting bugs or submitting pull requests.
76+
* **Community:** Join our [Discord](https://jozelot.de/discord) and share your feedback.
77+
* **Spread the word:** If you like the engine, tell your friends or share it on social media.
7578

76-
The plugin is open source. You can create forks and develop it on your own as long as you don't try to publish it.
79+
---
7780

78-
Proudly maintained by Jozelot & the Frostleaf team.
81+
Proudly maintained by **jozelot_** & the **Frostleaf** team.

0 commit comments

Comments
 (0)