Update and rename README.txt to README.md

2025-11-17 20:56:45 +01:00
parent 7efa8989cf
commit 43e0f47c90
2 changed files with 44 additions and 46 deletions
@@ -0,0 +1,44 @@
+# Mind & Motion
+
+*A lightweight gameplay systems mod adding Sanity, Insanity, and Tempo.*
+
+## Epilepsy Warning
+
+**Mind & Motion includes occasional screen flashes, distortion, and shader-based visual effects that may be triggered when Sanity becomes low or Insanity becomes high. Players with photosensitive epilepsy or sensitivity to flashing lights should disable visual effects in the mod’s configuration or avoid using the mod.**
+
+## Overview
+
+Mind & Motion is a small gameplay-enhancement mod inspired by *Deepwoken*. It introduces three new player attributes: **Sanity**, **Insanity**, and **Tempo**, that respond dynamically to your environment, combat state, and actions. These systems aim to add atmosphere and decision-making without changing core Minecraft progression.
+
+All features are fully configurable and can be adjusted or disabled depending on your preferred playstyle.
+
+## Features
+
+### Sanity
+* Default maximum: **80**
+* Sanity decreases in specific conditions, such as:
+  * Being in dark or enclosed locations
+  * Encountering certain mobs
+  * Remaining at low health
+* As Sanity falls, **Insanity** rises.
+  * High Insanity cause:
+  * Visual distortion
+  * Ambient audio effects
+  * Light gameplay impacts
+
+### Insanity
+* Increases when Sanity drops.
+* Introduces hallucinations, screen effects and sound cues.
+
+### Tempo
+* Default maximum: **120**
+* Does **not** regenerate naturally.
+* Gained by:
+  * Dealing damage
+  * Taking damage
+* Gradually decreases when out of combat.
+* If **Iron’s Spells & Spellbooks** is installed, Tempo increases mana regeneration.
+* **Vent Ability:**
+  * Press **G** (rebindable) to perform a short-range pulse that pushes nearby enemies back.
+  * Costs **40 Tempo**.
+  * Intended as a defensive tool for escaping danger or creating space
@@ -1,46 +0,0 @@
-
-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.
-
-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.
-
-Setup Process:
-==============================
-
-Step 1: Open your command-line and browse to the folder where you extracted the zip file.
-
-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.
-
-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.
-
-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/