Skip to content

Commit 7f90eea

Browse files
committed
chore(readme): Update README.md
1 parent c984c21 commit 7f90eea

File tree

1 file changed

+59
-63
lines changed

1 file changed

+59
-63
lines changed

README.md

Lines changed: 59 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,102 @@
1-
> [!IMPORTANT]
2-
> This is a fork of Outspending's original BiomesAPI.
3-
> This fork is designed to add additional features and
4-
> support the project for **modern** Minecraft versions.
5-
> I am not interested in backporting this fork to older
6-
> Minecraft versions.
7-
8-
91
<div align="center">
102
<h1>BiomesAPI</h1>
11-
<p>Custom Biomes!</p>
12-
<img src="https://img.shields.io/github/last-commit/Outspending/BiomesAPI">
13-
<img src="https://img.shields.io/github/contributors/Outspending/BiomesAPI">
14-
<img src="https://img.shields.io/github/forks/Outspending/BiomesAPI">
15-
<img src="https://img.shields.io/github/stars/Outspending/BiomesAPI">
16-
</div>
17-
18-
<div align="center">
19-
<img src="https://github.com/Outspending/BiomesAPI/actions/workflows/gradle.yml/badge.svg">
3+
<p>Custom Biomes! (1.21.11+)</p>
4+
<img src="https://img.shields.io/github/last-commit/LumaLibre/BiomesAPI">
5+
<img src="https://img.shields.io/github/contributors/LumaLibre/BiomesAPI">
6+
<img src="https://img.shields.io/github/forks/LumaLibre/BiomesAPI">
7+
<img src="https://img.shields.io/github/stars/LumaLibre/BiomesAPI">
208
</div>
219

2210
---
2311

2412
> [!NOTE]
2513
> BiomesAPI is currently being developed and ain't finished yet
2614
27-
BiomesAPI is a Custom Biome API for Spigot / PaperMC Servers. This API allows you to create custom biomes with custom colors. This API is also pretty easy to use and user-friendly.
2815

29-
BiomesAPI was made for servers who are looking for more of an aesthetic feel to their builds.
16+
## About 📃
17+
18+
BiomesAPI is a Custom Biome API for PaperMC Servers. This API is a fork of Outspending's original BiomesAPI and
19+
has been updated to support the **modern** Minecraft versions. Currently, we support Minecraft **1.21.11**
20+
but version support will expand with time.
21+
22+
23+
Please be aware that BiomesAPI is in active development, and some features may not be fully implemented yet.
24+
25+
**From Outspending:** "BiomesAPI was made for servers who are looking for more of an aesthetic feel to their builds."
26+
27+
28+
## Getting Started ⭐
29+
30+
BiomesAPI is built using Gradle and is hosted on my repository (rep.jsinco.dev). To get started with BiomesAPI,
31+
follow the instructions below to add BiomesAPI to your project.
32+
33+
1. Find the latest version of BiomesAPI [HERE](https://repo.jsinco.dev/#/releases/me/outspending/biomesapi/BiomesAPI). Versions with a git commit has at the end are snapshot builds and may be unstable.
34+
2. Add the repository to your `build.gradle.kts`, `build.gradle`, or `pom.xml` file.
35+
36+
And example for Gradle Kotlin DSL is provided below:
37+
38+
```kotlin
39+
plugins {
40+
// Make sure to shade it in!
41+
id("com.gradleup.shadow") version "$SHADOW_VERSION"
42+
}
3043

31-
## Release Notes 📃
32-
Check out the more detailed release notes [HERE](https://github.com/Outspending/BiomesAPI/blob/main/RELEASE_NOTES.md)
3344

34-
## Installation ⭐
35-
Installing BiomesAPI is easy! Just follow these steps, and you'll be on your way to creating your own custom biomes!
36-
1. Find the latest version of BiomesAPI [HERE](https://github.com/Outspending/BiomesAPI/releases)
37-
2. Add the repository to your `build.gradle` file
38-
```groovy
3945
repositories {
40-
mavenCentral()
41-
maven { url 'https://jitpack.io' }
46+
maven("https://repo.jsinco.dev/releases")
4247
}
43-
```
44-
3. Add the dependency to your `build.gradle` file
45-
```groovy
48+
49+
// 3. Replace VERSION with the latest version found in step 1
4650
dependencies {
47-
implementation 'me.outspending.biomesapi:BiomesAPI:0.0.5'
51+
implementation("me.outspending.biomesapi:BiomesAPI:$VERSION")
4852
}
49-
```
50-
4. Build your project
51-
5. All done!
5253

53-
Now you can use our API to create your own custom biomes!
54+
// 4. Shade the BiomesAPI package to avoid conflicts
55+
shadowJar {
56+
relocate("me.outspending.biomesapi", "your.package.name.biomesapi")
57+
}
58+
```
5459

55-
## Nightly Builds 🌙
56-
Nightly builds are builds that add experimental features to BiomesAPI. Some of these features are just in testing and might not make it into the main API!
60+
You must know how to shade dependencies in order to use BiomesAPI. BiomesAPI is not a standalone plugin.
5761

58-
If you are intrested in **Nightly Builds** please check our [Wiki](https://github.com/Outspending/BiomesAPI/wiki/Nightly-Builds) and the [Nightly Branch](https://github.com/Outspending/BiomesAPI/tree/nightly)
5962

60-
## Wiki 🧑‍💻
63+
## Wiki 🌙
6164
Our Wiki is a great place to learn how to use BiomesAPI. This Wiki is updated frequently to make sure our users know how to use our API.
6265

6366
The wiki has everything from how to create a biome to how to use our API to its full potential. It's also pretty descriptive, so you'll know exactly what you're doing.
6467

65-
Check out the Wiki [HERE](https://github.com/Outspending/BiomesAPI/wiki)
68+
Check out the Wiki at https://biomes.lumas.dev
6669

6770
## Why BiomesAPI 🤔
68-
BiomesAPI is the best way to create custom biomes for free, and it's easy to use! We also offer a Plugin and Skript addon for people who don't know how to use Java.
6971

70-
BiomesAPI is a light-weight API and is pretty small in size. This API is also very fast and efficient, so you don't have to worry about lag. And is updated frequently to make sure it's up-to-date with the latest version of Spigot.
72+
I believe that BiomesAPI is one of the best ways to create custom biomes on a Paper-based Minecraft server.
73+
At the time of writing, there are no other APIs that allow you to create custom biomes as easily as BiomesAPI does.
74+
75+
BiomesAPI is designed to be easy to use, flexible, and friendly for developers of all skill levels.
7176

7277
## Advantages & Disadvantages 👌
7378

7479
### Advantages
7580
- Easy to use
76-
- Light-weight
77-
- Fast and efficient
7881
- Updated frequently
79-
- Free
80-
- Plugin and Skript addon
81-
- Well Documented Wiki
82+
- Free forever
83+
- Wiki and javadocs available
84+
- Supports modern Minecraft versions
85+
- Supports packet-based biome changing with ProtocolLib or PacketEvents
8286

8387
### Disadvantages
84-
- Only works on Spigot 1.19.3+
88+
- Only works on 1.21.11+ Paper-based servers
89+
- Requires shading to avoid conflicts
90+
- Still in active development, so some features may be missing
91+
- Registered biomes cannot be unregistered without restarting the server
8592

8693
## Credits 🙏
87-
Thanks to all of these people for helping make BiomesAPI possible!
88-
89-
- [SpigotMC](https://www.spigotmc.org/) - For making Spigot and allowing us to use their API
90-
- [Jitpack](https://jitpack.io/) - For allowing us to use their repository
91-
- [Gradle](https://gradle.org/) - For allowing us to use their build tool
92-
- [GitHub](https://github.com/) - For hosting our code
93-
- [IntelliJ IDEA](https://www.jetbrains.com/idea/) - For allowing us to use their IDE
94-
- [Lombok](https://projectlombok.org/) - For allowing us to use their library
94+
BiomesAPI was originally created by Outspending. I (Jsinco) have forked the project to add additional features and
95+
support modern Minecraft versions. This project would not be possible without Outspending's original work.
9596

9697
## Contributing 📰
9798

98-
> [!WARNING]
99-
> If you do not follow our conventions, your pull request will be denied.
100-
101-
If you are looking to contribute to BiomesAPI, please read our [CONTRIBUTING.md](CONTRIBUTING.md) file before doing so.
102-
103-
This file will tell you everything about our conventions and how to contribute to BiomesAPI.
99+
Contributions are welcome! If you find a bug or have a feature request, please open an issue on GitHub.
104100

105101
## License 🪪
106102
BiomesAPI is licensed under the [GPL-3.0 License](LICENSE)

0 commit comments

Comments
 (0)