Skip to content

Commit

Permalink
Updated ReadMe
Browse files Browse the repository at this point in the history
  • Loading branch information
JingPing99 committed Jan 1, 2024
1 parent 001aec6 commit b00dd68
Showing 1 changed file with 8 additions and 23 deletions.
31 changes: 8 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,13 @@
# Example Mod
# Dye Revoker

Template for making Babric mods for BTA!
---

**Note: *DO NOT fork this repository unless you want to contribute!***
A simple mod adding some trommel recipes, mainly undoing dye'd varients of things.

## Prerequisites
- JDK for Java 17 ([Eclipse Temurin](https://adoptium.net/temurin/releases/) recommended)
- IntelliJ IDEA
- Minecraft Development plugin (Optional, but highly recommended)
**Requires:**
- HalpLibe (https://github.com/Turnip-Labs/bta-halplibe)

## Setup instructions
**Current Features:**
- Trommeling wool gives string or its respective dye

1. Click the `Use this template` button on this repo's page above. Choose `Create a new repository`, you will be redirected to a new page. Enter your repo's name and description, and hit `Create repository`.
To get your project, open IntelliJ IDEA and click `Get from VCS`. Select `Repository URL` and enter your repo's url

2. After the project has finished importing, close it and open it again.
If that does not work, open the right sidebar with `Gradle` on it, open `Tasks` > `fabric` and run `ideaSyncTask`.

3. Create a new run configuration by going in `Run > Edit Configurations`.
Then click on the plus icon and select Gradle. In the `Tasks and Arguments` field enter `build`.
Running it will build your finished jar files and put them in `build/libs/`.

4. Lastly, open `File` > `Settings` and head to `Build, Execution, Development` > `Build Tools` > `Gradle`.
Make sure `Build and run using` and `Run tests using` is set to `Gradle`.

5. Done! Now, all that's left is to change every mention of `examplemod` and `turniplabs` to your own mod id and mod group, respectively. Happy modding!
P.S. This is my first attempt at modding anything! Use at your own risk!

0 comments on commit b00dd68

Please sign in to comment.