MDK-1.21-ModDevGradle/README.md


Installation information
=======

This template repository can be directly cloned to get you started with a new
mod. Simply create a new repository cloned from this one, by following the
instructions provided by [GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).

Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse.

If at any point you are missing libraries in your IDE, or you've run into problems you can
run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything 
{this does not affect your code} and then start the process again.

Mapping Names:
============
By default, the MDK is configured to use the official mapping names from Mojang for methods and fields 
in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this
license. For the latest license text, refer to the mapping file itself, or the reference copy here:
https://github.com/NeoForged/NeoForm/blob/main/Mojang.md

Additional Resources: 
==========
Community Documentation: https://docs.neoforged.net/  
NeoForged Discord: https://discord.neoforged.net/
Regenerate patches with relative headers. This should lower conflicts in future PRs. Convert Forge to use Official mappings. Mojang released their obfuscation mappings but we have not used them up until now due to wanting to get their license to be more explicitly permissive. It is clear that their intent is to allow us to use their names for developing mods like this. See the full wording, and our interpretation here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md 2021-03-09 13:37:23 -08:00
Update readme 2023-07-15 17:03:54 -04:00			`Installation information`
			`=======`
Vestigal fml-ectomy. 2015-08-02 00:03:47 -04:00
Update readme 2023-07-15 17:03:54 -04:00			`This template repository can be directly cloned to get you started with a new`
			`mod. Simply create a new repository cloned from this one, by following the`
Remove outdated license notice 2024-06-21 00:13:01 +03:00			`instructions provided by [GitHub](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).`
Update readme 2023-07-15 17:03:54 -04:00
Update setup process (#17) Co-authored-by: sciwhiz12 <sciwhiz12@gmail.com> 2023-12-01 23:42:20 +09:00			`Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse.`
Vestigal fml-ectomy. 2015-08-02 00:03:47 -04:00
Update setup process (#17) Co-authored-by: sciwhiz12 <sciwhiz12@gmail.com> 2023-12-01 23:42:20 +09:00			`If at any point you are missing libraries in your IDE, or you've run into problems you can`
Regenerate patches with relative headers. This should lower conflicts in future PRs. Convert Forge to use Official mappings. Mojang released their obfuscation mappings but we have not used them up until now due to wanting to get their license to be more explicitly permissive. It is clear that their intent is to allow us to use their names for developing mods like this. See the full wording, and our interpretation here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md 2021-03-09 13:37:23 -08:00			run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean` to reset everything
			`{this does not affect your code} and then start the process again.`
Vestigal fml-ectomy. 2015-08-02 00:03:47 -04:00
Regenerate patches with relative headers. This should lower conflicts in future PRs. Convert Forge to use Official mappings. Mojang released their obfuscation mappings but we have not used them up until now due to wanting to get their license to be more explicitly permissive. It is clear that their intent is to allow us to use their names for developing mods like this. See the full wording, and our interpretation here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md 2021-03-09 13:37:23 -08:00			`Mapping Names:`
Update readme 2023-07-15 17:03:54 -04:00			`============`
Regenerate patches with relative headers. This should lower conflicts in future PRs. Convert Forge to use Official mappings. Mojang released their obfuscation mappings but we have not used them up until now due to wanting to get their license to be more explicitly permissive. It is clear that their intent is to allow us to use their names for developing mods like this. See the full wording, and our interpretation here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md 2021-03-09 13:37:23 -08:00			`By default, the MDK is configured to use the official mapping names from Mojang for methods and fields`
			`in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this`
Remove outdated license notice 2024-06-21 00:13:01 +03:00			`license. For the latest license text, refer to the mapping file itself, or the reference copy here:`
Update readme 2023-07-15 17:03:54 -04:00			`https://github.com/NeoForged/NeoForm/blob/main/Mojang.md`
Vestigal fml-ectomy. 2015-08-02 00:03:47 -04:00
Regenerate patches with relative headers. This should lower conflicts in future PRs. Convert Forge to use Official mappings. Mojang released their obfuscation mappings but we have not used them up until now due to wanting to get their license to be more explicitly permissive. It is clear that their intent is to allow us to use their names for developing mods like this. See the full wording, and our interpretation here: https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md 2021-03-09 13:37:23 -08:00			`Additional Resources:`
Update readme 2023-07-15 17:03:54 -04:00			`==========`
			`Community Documentation: https://docs.neoforged.net/`
			`NeoForged Discord: https://discord.neoforged.net/`