Updated README (#234)

- Added logo
- Added CONTRIBUTING.md for setting up
- Added gradle wrapper
- Removed outdated Notepad++ language file
- Moved credits further down
- Make release workflow run only in main repo

Author: ScribbleTAS

.github/workflows/release.yml

@@ -5,6 +5,7 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    if: github.repository == 'MinecraftTAS/TASmod'
     steps:
       - uses: actions/checkout@v4
       - name: Setup Java

.gitignore

@@ -16,9 +16,6 @@ out
 # gradle
 build
 .gradle
-gradle
-gradlew
-gradlew.bat
 
 # other
 eclipse

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Setting up
+## 1. Clone this repository into your workspace
+```sh
+git clone https://github.com/MinecraftTAS/TASmod.git
+```
+## 2. Import root project into your IDE
+### Eclipse
+1. Set your workspace folder to the parent folder of the TASmod folder, so if you have something like `workspace/TASmod`, set the workspace folder to "TASmod".
+2. Click `File>Import` then search for "Existing Gradle project" and click next
+3. Select the "TASmod" folder as a project root directory then click finish
+### IntelliJ
+Use `File>Open`, then select the `TASmod` folder
+## 3. Decompile Source
+Run the gradle task `genSources` either in your IDE or by running
+```sh
+./gradlew genSources
+```
+# Run Minecraft in Dev-Environment
+## Eclipse
+1. Run the gradle task `eclipse`
+2. Select the project, right click, then gradle>Refresh Gradle Project
+3. Select the TASmod_client.launch file then click the run button or press Ctrl+F11
+## IntelliJ
+Run the gradle task `runClient`
+
+# Building
+1. Run the gradle task `build`
+```sh
+./gradlew build
+```
+2. The generated jar is in `build/libs`

README.md

@@ -1,30 +1,12 @@
-> [!WARNING]
-> This mod is in **early-development** and is not ready for use yet. If you wish to download the early testing releases, be prepared to encounter various bugs and desyncs!  
-> For a more stable mod, without input recording and playback, check [LoTAS](https://github.com/MinecraftTAS/LoTAS)
-# TASmod  
-A Tool-Assisted Speedrun-Mod for Minecraft 1.12.2.  
-Is able to capture inputs and play them back, by pretending to be a keyboard.
+<p align="center"><img src="https://minecrafttas.com/images/TASmodLogo.svg" alt="Logo" width="500"></p>
 
-To reduce complexity, all aspects of RNG-Manipulation have been externalized to a repository called [KillTheRNG](https://github.com/MinecraftTAS/KillTheRNG). It is now available as an optional dependency and a [standalone mod](https://maven.mgnet.work/#/main/com/minecrafttas/killtherng-full)
+A [Tool-Assisted Speedrun](https://tasvideos.org/WelcomeToTASVideos) mod for Minecraft.  
+Adds tools such as input playback, slowdown and savestates for creating TASes,  
+which aim to beat the game as fast as possible.
 
-> [!IMPORTANT]
-> We are currently shifting over to **[Legacy-Fabric 1.12.2](https://legacyfabric.net/)**. The development branch currently works with Legacy-Fabric while the release branch is on **Forge** 1.12.2
->
-> This means all **Alpha** releases only work for Forge.
->
-> Future **Beta** releases will be on Legacy-Fabric.
-
-# Credits  
-Author of the original mod: [tr7zw](https://github.com/tr7zw/MC-TASmod)  
-Main Mod Author: Scribble  
-  
-Contributions by: famous1622, Pancake  
-  
-Tickratechanger: [Guichaguri](https://github.com/Guichaguri/TickrateChanger)  
-Tickrate 0 idea: [Cubitect](https://github.com/Cubitect/Cubitick)  
-Savestate idea: [bspkrs, MightyPork](https://github.com/bspkrs-mods/WorldStateCheckpoints), although implementation is totally different now
-  
-Special thanks: Darkmoon, The Minecraft TAS Community  
+# Installation
+This mod uses the modloader [LegacyFabric](https://legacyfabric.net/), a fork of [Fabric](https://fabricmc.net/) for versions below 1.14.4.  
+**Does NOT need LegacyFabric-API**
 # Features  
 ## Playback
 This mod can record and play back
@@ -66,24 +48,23 @@ This mod can record and play back
 Record TASes with friends! Needs operator permissions to run tasmod related commands.  
 /savestate can be used to manage savestates.
 
-> **Note:** /fullrecord, /fullplay and /restartandplay are not guaranteed to work in multiplayer at this time.
+> [!Note]
+> /fullrecord, /fullplay and /restartandplay are not guaranteed to work in multiplayer at this time.
 
 ## HUD
 When ingame, hitting <kbd>F6</kbd> will show you options for customising your HUD, with monitoring options and more. Even more options are available when KillTheRNG is installed. 
 
-# Development
-## Setup
-1. Clone this repository and put it in your workspace directory (where you open eclipse or idea)
-2. Import gradle project
-	- Use gradle version 4.10.3
-	- Use [JDK 8](https://adoptium.net/en/temurin/releases/?version=8)
-3. Run gradle tasks `setupDecompWorkspace` then `eclipse`.
-4. *Optional but recommended:* Run gradle task `downloadKTRNG` (in the "tasmod" category) to download KillTheRNG to the run/mods folder.
+# Credits  
+Author of the original prototype: [tr7zw](https://github.com/tr7zw/MC-TASmod)  
+Main Mod Author: Scribble  
 
-## Running
-The task `eclipse` should've generated to launch configs: `TASmod_Client.launch` and `TASmod_Server.launch`. Select it, then click the run or debug button in your IDE.
+Contributions by: famous1622, Pancake  
+  
+Initial Tickratechanger: [Guichaguri](https://github.com/Guichaguri/TickrateChanger)  
+Tickrate 0 idea: [Cubitect](https://github.com/Cubitect/Cubitick)  
+Savestate idea: [bspkrs, MightyPork](https://github.com/bspkrs-mods/WorldStateCheckpoints)
 
-> **Note:** Additional setup is required for the server to actually start, like changing the eula.txt and setting `online-mode` to false in server.properties.
+Special thanks: Darkmoon, notz23, The Minecraft TAS Community  
 
-## Building
-Build the mod using the gradle task `build` (or alternatively `shadowJar`).
+# Development
+For setting up and building the mod, check [CONTRIBUTING.md](https://github.com/MinecraftTAS/TASmod/blob/develop/CONTRIBUTING.md)

TASFile_Dark_Npp_language.xml

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists