Skip to content
This repository has been archived by the owner on Dec 12, 2021. It is now read-only.
/ ThonkMod Public archive

A repository for learning to mod Minecraft with the Forge MDK.

License

Notifications You must be signed in to change notification settings

sjalkote/ThonkMod

Repository files navigation

GitHub Workflow Status (branch)

Thonk Mod

Mod Logo

About

ThonkMod is a simple mod by me to learn my way around modding Minecraft using the Forge MDK.

Playing

To use the mod, go to the latest releases and download the mod .jar, listed under assets. It should be thonkmod-X.X.X.jar or similar. Once you download it, make sure you have installed the Forge Modloader. It will have generated a mods folder in your .minecraft directory. Drag the ThonkMod .jar file into the mods folder, and start playing with the Forge Minecraft profile! Make sure that you are playing on the correct Minecraft version, this mod is currently for Forge 1.17.1 or later.

Localization Notice

The mod may include language files for languages other than American English (en-us). However, keep in mind that translations may not be 100% accurate. If you spot an incorrect translation and want to help make it accurate, it would be preferred for you to open an issue with your proposed corrections, rather than a PR.

License

I have opted for the GNU GENERAL PUBLIC LICENSE v3 which essentially states that

1. Anyone can copy, modify and distribute this software.

2. You have to include the license and copyright notice with each and every distribution. For the full license, see the LICENSE file available in the repository.

3. You can use this software privately.

4. You can use this software for commercial purposes.

There is of course, much more that the license entails, but for that you can view the license webpage on gnu.org, which can tell you everything that you can and can't do.

Contribution

Since this mod is mostly just for self-learning rather than actual gameplay purposes, I am not really open to pull requests. However, I may consider some depending on the proposed changes, but they must target the ThonkMod/dev branch. If you have a translation fix in mind, please open an issue with your proposed changes rather than a pull request.

TL;DR you may open PR's, just don't expect them to be accepted into the repository.