Update README

This commit is contained in:
Night Kaly 2025-04-09 15:55:02 +01:00
parent 0368b5f86f
commit 6e4f3650cb
Signed by: night0721
SSH key fingerprint: SHA256:B/hgVwUoBpx5vdNsXl9w8XwZljA9766uk6T4ubZp5HM

View file

@ -1,9 +1,7 @@
# NullValkyrie
NullValkyrie is multipurpose Minecraft plugin with a lot of features where most modern servers have.
## Features
# Features
- Custom items to use and play
- Miners to generate money and ores when you are offline
- Custom enchantments
@ -12,27 +10,21 @@ NullValkyrie is multipurpose Minecraft plugin with a lot of features where most
- Custom holograms
- Custom NPCs to do all kind of things
## Getting Started
# Building
To get started with the project, simply clone the repository and install the dependencies using Maven:
```cmd
git clone https://github.com/night0721/NullValkyrie.git
```sh
git clone https://github.com/night0721/NullValkyrie
cd NullValkyrie
```
If you are using IntelliJ, you can import the project as a Maven project and install the dependencies by clicking button on the right side of the screen.
After installing dependencies, you are able to use install/package command to compile the plugin to JAR, or instead, use build artifact.
Then, you can add the plugin to your plugin folder and start the server to use it.
## Support
If you need support, you can join the [Discord server](https://discord.gg/SbQHChmGcp) or DM me on Discord: night.dev
## License
NullValkyrie is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/NullValkyrie/blob/master/LICENSE) for more information.
## Contribution
# Contributions
If you have any ideas for improvements or new features, please feel free to fork the project and create a pull request or open an issue.
All contributions are welcome, including translations, documentation, and code.
# License
NullValkyrie is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/NullValkyrie/blob/master/LICENSE) for more information.