Update README.txt

This commit is contained in:
IM23a-spirgif
2025-04-29 10:11:35 +02:00
committed by GitHub
parent ed826a68c2
commit 1b9679be39
+8 -39
View File
@@ -1,46 +1,15 @@
KnockedBack replaces traditional deaths from most damage types with a “knocked out” state, letting players and mobs deliver the final blow—or even rescue their allies—before true death occurs.
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.
Lethal damage is canceled and the player is left at 1 HP in a helpless, immobile state for 20 seconds. While knocked you can’t move, sprint, jump, break blocks, attack, or interact. After those 20 seconds have passed, the player can move again and continue fighting.
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.
Living players can finish off (“execute”) a knocked target by pressing a key (default B) within range.
Setup Process:
==============================
Execution takes 3 s.
Step 1: Open your command-line and browse to the folder where you extracted the zip file.
Hostile or aggressive neutral mobs near a knocked player will automatically “grip” and execute them after 3 s, resetting if the mob is attacked first.
Step 2: You're left with a choice.
If you prefer to use Eclipse:
1. Run the following command: `./gradlew genEclipseRuns`
2. Open Eclipse, Import > Existing Gradle Project > Select Folder
or run `gradlew eclipse` to generate the project.
Mobs cannot execute players who are currently being carried. Press V near a knocked teammate to pick them up (they ride you), pausing their recovery timer. Executors (players or mobs) have their own movement/attack locked out during the 3 s delay. Any damage to a carrier drops their passenger and resumes that passenger’s recovery.
If you prefer to use IntelliJ:
1. Open IDEA, and import project.
2. Select your build.gradle file and have it import.
3. Run the following command: `./gradlew genIntellijRuns`
4. Refresh the Gradle Project in IDEA if required.
Fire, lava, fall, and explosion deaths bypass the knocked state and kill normally.
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, 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
Additional Resources:
=========================
Community Documentation: https://docs.minecraftforge.net/en/1.20.1/gettingstarted/
LexManos' Install Video: https://youtu.be/8VEdtQLuLO0
Forge Forums: https://forums.minecraftforge.net/
Forge Discord: https://discord.minecraftforge.net/
Animations and other stuff like config files and custom items for reviving will come in future updates.