Skip to content
This repository has been archived by the owner on Jul 12, 2023. It is now read-only.

CherryMods/NeoK

Repository files navigation

DON'T USE THIS VERSION!

I decided to start over AGAIN, because apparently I still had no idea how to use Git when I started NeoK. Go check out Tea-Client for the third revision of K-Client.

The old readme content starts below this line:


NeoK (New K-Client) for 1.17+

⚠ IMPORTANT ⚠

If you have any suggestions for this repo that aren't related to NeoK-specific features, (for example, you made a new hack) please go contribute to the original repo instead!

Setup (for contributors)

To work on the project, you need to set it up the exactly the same way as Wurst. You can find instructions in the README file!

This project runs on Java 17. Make sure you have a JDK for Java 17 before reporting build errors!

Contributing

If you want to help but are not sure what to do, take a look at our planning board or the help wanted list. Of course you can contribute anything you like, but these issues are particularly useful.

If you are contributing multiple unrelated features, please create a separate pull request for each feature. Squeezing everything into one giant pull request makes it very difficult for me to add your features, as I have to test, validate and add them one by one.

Thank you for your understanding - and thanks again for taking the time to contribute!!

Translations

We have a Crowdin project for translations. You can also submit translations here on GitHub, but Crowdin is preferred since it makes it much easier to resolve issues.

To enable translations in-game, go to Wurst Options > Translations > ON.

Names of features (hacks/commands/etc.) should always be kept in English. This ensures that everyone can use the same commands, keybinds, etc. regardless of their language setting. It also makes it easier to communicate with someone who uses Wurst in a different language.

The translation files are located in this folder, in case you need them.

License

This code is licensed under the GNU General Public License v3. You can only use this code in open-source clients that you release under the same license! Using it in closed-source/proprietary clients is not allowed!

Note about Pull Requests

If you are contributing multiple unrelated features, please create a separate pull request for each feature. Squeezing everything into one giant pull request makes it very difficult for us to add your features, as we have to test, validate and add them one by one.

Thank you for your understanding - and thanks again for taking the time to contribute!!