Compatibility
Minecraft: Java Edition
Platforms
75% of ad revenue goes to creators
Support creators and Modrinth ad-free with Modrinth+Creators
Details
BasedUtils
Welcome to the BasedUtils PaperMC page!
If you're looking for a powerful Minecraft plugin API, you've come to the right place.
Getting Started
1. Download the API
- Download the latest version from the Releases Tab.
2. Import as Dependency
Import the API into your project as a dependency. (The Steps may vary based on your IDE. If you're unsure how to do this, a quick online search should help.)
3. Update plugin.yml
Edit your plugin.yml
to include the following lines:
api-version: 1.21
depend: [BasedUtils]
This informs the server that your plugin depends on BasedUtils and cannot run without it.
4. Explore the Documentation
Check out the Documentation!
- It contains detailed info and examples on how to use the API.
- It's generated from comments using Dokka, making it easy to follow.
For questions, reach out through my links on my website.
5. Check Server Compatibility
Ensure your server is:
- Running a compatible Java version.
- Supporting the latest Minecraft version.
You can find information about which Minecraft or Java version the BasedUtils supports in the release section.
FAQ
What if I don't understand a feature?
- Check the relevant Wiki article for examples and explanations.
- Look at the issue tracker for similar questions.
- If you're still unsure, feel free to ask for help via my links on my website.
Why was BasedUtils created?
BasedUtils was designed to simplify plugin development.
- It provides reusable functionalities.
- It reduces the need for repetitive coding tasks.
What are the benefits of using BasedUtils?
- Time-saving: It helps you implement advanced features easily.
- Simplicity: No need to struggle with complex implementations.
Can I request a feature?
Absolutely! If you have a feature in mind, submit a Feature Request.
I found a bug. What should I do?
If you encounter a bug:
- Please report it by creating an Issue in the tracker.
- We will address it as soon as possible.
License
This program is free software licensed under the GNU General Public License, version 3 or later.
For more details, see the GNU General Public License.