Update readme

This commit is contained in:
cpw 2023-07-15 17:03:54 -04:00
parent 55cc1e2504
commit 2b3334097e
No known key found for this signature in database
GPG key ID: 8EB3DF749553B1B7
2 changed files with 13 additions and 17 deletions

View file

@ -1,16 +1,15 @@
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.
Installation information
=======
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
normal code.
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 at [github](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template).
Once you have your clone, you can initialize your copy.
Setup Process:
==============================
--------
Step 1: Open your command-line and browse to the folder where you extracted the zip file.
@ -31,16 +30,14 @@ run `gradlew --refresh-dependencies` to refresh the local cache. `gradlew clean`
{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, 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
https://github.com/NeoForged/NeoForm/blob/main/Mojang.md
Additional Resources:
=========================
Community Documentation: https://mcforge.readthedocs.io/en/latest/gettingstarted/
LexManos' Install Video: https://www.youtube.com/watch?v=8VEdtQLuLO0
Forge Forum: https://forums.minecraftforge.net/
Forge Discord: https://discord.gg/UvedJ9m
==========
Community Documentation: https://docs.neoforged.net/
NeoForged Discord: https://discord.neoforged.net/

View file

@ -1 +0,0 @@
Empty