Skip to content

Commit eb3a45c

Browse files
author
Roch Blonndiaux
committed
feat: super generic readme
1 parent 5cd1eed commit eb3a45c

1 file changed

Lines changed: 38 additions & 10 deletions

File tree

README.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,41 @@
1-
# GeyserUtils
1+
**GeyserUtils**
2+
================
23

3-
- camera shake
4-
- NPC form
5-
- animation
6-
- camera features(require modify geyser's startgamepacket by yourself XP)
7-
- (and thank daoge cmd so much ❤️ XD)
4+
A collection of utilities and tools designed to make development with Geyser easier and more efficient.
85

9-
_Install_
6+
**Overview**
7+
------------
108

11-
- GeyserUtils-Spigot -> your spigot server plugins folder
12-
- GeyserUtils-Velocity -> your velocity proxy (if exists)
13-
- GeyserUtils-Geyser -> your geyser extensions folder
9+
This project provides a set of reusable code snippets, functions, and classes that can be used in various projects built using the [Geyser](https://geysermc.org). The goal is to simplify common tasks and reduce boilerplate code, making development with Geyser more enjoyable.
10+
11+
**Features**
12+
------------
13+
14+
* Camera shake
15+
* NPC form
16+
* Animation
17+
* Camera features _(require modify geyser's StartGamePacket by yourself XP)_
18+
* And more!
19+
20+
**Contributing**
21+
---------------
22+
23+
We welcome contributions to this repository! If you'd like to add a new feature or fix a bug, please:
24+
25+
1. Fork the repository: `git fork https://github.com/GeyserExtensionists/GeyserUtils.git`
26+
2. Create a new branch: `git checkout -b new-feature`
27+
3. Make your changes and commit them
28+
4. Push your changes to your forked repository
29+
5. Open a pull request against the original repository
30+
31+
**License**
32+
-----------
33+
34+
GeyserUtils is licensed under the [MIT License](https://opensource.org/licenses/MIT).
35+
36+
**Acknowledgments**
37+
------------------
38+
39+
A special thank you to all contributors who have helped shape this project into what it is today.
40+
41+
Feel free to reach out if you'd like more information about GeyserUtils or its usage in your projects.

0 commit comments

Comments
 (0)