Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (77 loc) · 4.23 KB

CONTRIBUTING.md

File metadata and controls

107 lines (77 loc) · 4.23 KB
Raw

Contributing to UHC-Fork

Thank you for your interest in contributing to this plugin! If you have any questions, don't hestitate to ask in the #dev channel on the Discord server.

Submitting feature requests and bug reports

If you have an idea for a new feature, or found a bug that needs to be fixed, you can create an issue at the GitHub repository. Please be as descriptive as possible and include all relevant information, such as error messages and/or server logs when submitting a bug report. You are also welcome to discuss the matter on the Discord server, in the #bugs or #suggestions channel.

Contributing features and bug fixes

Before you start coding, consider discussing the matter on the Discord server, or submitting a feature request or bug report (see above) describing what you want to contribute. You may receive tips about where to start or how to structure your code, which increases the likelihood of your contribution being accepted. For simple contributions, like fixing a typo or editing a few lines, you can skip this step.

Required software

  • Git, to clone the repository and to submit your contribution.
  • A Java Development Kit (JDK), to run the Gradle build tool.
  • A code editor with support for Java projects using the Gradle build tool.
    • You should also make sure that your editor has support for EditorConfig, perhaps by downloading a plugin. This will ensure that your code is formatted consistently with the rest of the code in the project.

Recommended steps

  1. Fork this repository and clone the fork to your local machine.
  2. Open the root directory as a Gradle project in your code editor.
  3. Wait for the projects to be imported, and then start coding!
  4. When you think you are done, make sure to test your changes.
  5. Commit and push your changes on a new Git branch in your forked repository.
  6. Create a pull request for your contribution.

Testing your changes

You can execute the runServer Gradle task to automatically build the plugin and run it on a Paper server, for quick and easy testing. This task comes from the run-paper Gradle plugin.

Build and run on Windows

gradlew runServer

Build and run on Linux or macOS

./gradlew runServer

The project targets Minecraft 26.1.2 only. The mcVersion property is retained for local experiments, but other Minecraft versions are unsupported.

Build and run for Minecraft 26.1.2 on Windows

gradlew runServer -PmcVersion=26.1.2

Build and run for Minecraft 26.1.2 on Linux or macOS

./gradlew runServer -PmcVersion=26.1.2

The server files will be stored under the run/<version>/ folder (relative to the base of this repository), such as run/26.1.2/. Note that you will need to edit the run/<version>/eula.txt file manually the first time you run a server, in order to agree to the Minecraft EULA.

If you need to edit server and/or plugin configuration files or install additional plugins for testing your code, you can do so in the run/<version>/ folder. This folder will be reused on subsequent executions of runServer.

Debugging

After starting the server using runServer, you can also attach a debugger via JDWP, which allows you to set breakpoints, inspect variables and more while the plugin is running. Consult the documentation of your code editor for more information. Below are documentation links for a few popular editors:

You should attach the debugger to the localhost address, at port 5005.