exhq/ajarcomputers
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
ajarcomputers/README.txt

47 lines
2.2 KiB
Text
Raw Normal View History

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 22:37:23 +01:00
Vestigal fml-ectomy.
2015-08-02 06:03:47 +02:00
Source installation information for modders
-------------------------------------------
This code follows the Minecraft Forge installation methodology. It will apply
some small patches to the vanilla MCP source code, giving you and it access
to some of the data and functions you need to build a successful mod.
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 22:37:23 +01:00
Note also that the patches are built against "un-renamed" MCP source code (aka
SRG Names) - this means that you will not be able to read them directly against
Vestigal fml-ectomy.
2015-08-02 06:03:47 +02:00
normal code.
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 22:37:23 +01:00
Setup Process:
Vestigal fml-ectomy.
2015-08-02 06:03:47 +02:00
==============================
Step 1: Open your command-line and browse to the folder where you extracted the zip file.
Update MDK Readme to describe new FG3 procedures. (#5553)
2019-02-26 03:11:41 +01:00
Step 2: You're left with a choice.
If you prefer to use Eclipse:
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 22:37:23 +01:00
1. Run the following command: `gradlew genEclipseRuns` (`./gradlew genEclipseRuns` if you are on Mac/Linux)
Update MDK Readme to describe new FG3 procedures. (#5553)
2019-02-26 03:11:41 +01:00
2. Open Eclipse, Import > Existing Gradle Project > Select Folder
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 22:37:23 +01:00
or run `gradlew eclipse` to generate the project.
Update MDK Readme to describe new FG3 procedures. (#5553)
2019-02-26 03:11:41 +01:00
If you prefer to use IntelliJ:
Vestigal fml-ectomy.
2015-08-02 06:03:47 +02:00
1. Open IDEA, and import project.
2. Select your build.gradle file and have it import.
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 22:37:23 +01:00
3. Run the following command: `gradlew genIntellijRuns` (`./gradlew genIntellijRuns` if you are on Mac/Linux)
Update MDK Readme to describe new FG3 procedures. (#5553)
2019-02-26 03:11:41 +01:00
4. Refresh the Gradle Project in IDEA if required.
Vestigal fml-ectomy.
2015-08-02 06:03:47 +02: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 22:37:23 +01:00
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.
Vestigal fml-ectomy.
2015-08-02 06:03:47 +02: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 22:37:23 +01:00
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, if you do not agree with it you can change your mapping names to other crowdsourced names in your
build.gradle. For the latest license text, refer to the mapping file itself, or the reference copy here:
https://github.com/MinecraftForge/MCPConfig/blob/master/Mojang.md
Vestigal fml-ectomy.
2015-08-02 06:03:47 +02: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 22:37:23 +01:00
Additional Resources:
Vestigal fml-ectomy.
2015-08-02 06:03:47 +02:00
=========================
Update MDK for 1.19 changes (#8675)
2022-06-09 20:37:52 +02:00
Community Documentation: https://mcforge.readthedocs.io/en/latest/gettingstarted/
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 22:37:23 +01:00
LexManos' Install Video: https://www.youtube.com/watch?v=8VEdtQLuLO0
Forge Forum: https://forums.minecraftforge.net/
Update MDK for 1.19 changes (#8675)
2022-06-09 20:37:52 +02:00
Forge Discord: https://discord.gg/UvedJ9m
Reference in a new issue Copy permalink