Skip to content

Commit e05adf4

Browse files
authored
Update README.md
1 parent d0f8571 commit e05adf4

File tree

1 file changed

+12
-33
lines changed

1 file changed

+12
-33
lines changed

README.md

+12-33
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,15 @@
1-
# Example Mod
1+
# Catalyst
22

3-
Template for making Babric mods for BTA!
3+
**Library for advanced modding needs of BTA 7.1**
44

5-
**Note: *DO NOT fork this repository unless you want to contribute!***
5+
Catalyst is split into modules, the current available modules are described below.
66

7-
## Prerequisites
8-
- JDK for Java 17 ([Eclipse Temurin](https://adoptium.net/temurin/releases/) recommended)
9-
- IntelliJ IDEA
10-
- Minecraft Development plugin (Optional, but highly recommended)
11-
12-
## Setup instructions
13-
14-
15-
1. Click the `Use this template` button on this repo's page above. Choose `Create a new respository`, you will be redirected to a new page. Enter your repo's name and description, and hit `Create repository`.
16-
To get your project, open IntelliJ IDEA and click `Get from VCS`. Select `Repository URL` and enter your repo's url
17-
18-
2. After the project has finished importing, close it and open it again.
19-
If that does not work, open the right sidebar with `Gradle` on it, open `Tasks` > `fabric` and run `ideaSyncTask`.
20-
21-
3. Create a new run configuration by going in `Run > Edit Configurations`.
22-
Then click on the plus icon and select Gradle. In the `Tasks and Arguments` field enter `build`.
23-
Running it will build your finished jar files and put them in `build/libs/`.
24-
25-
4. While in the same place, select the Client and Server run configurations and edit the VM options under the SDK selection.
26-
27-
![image](https://github.com/Turnip-Labs/bta-example-mod/assets/58854399/2d45551d-83e3-4a75-b0e6-acdbb95b8114)
28-
29-
Click the double arrow icon to expand the list, and append `-Dfabric.gameVersion=1.7.7.0` to the end.
30-
31-
![image](https://github.com/Turnip-Labs/bta-example-mod/assets/58854399/e4eb8a22-d88a-41ef-8fb2-e37c66e18585)
32-
33-
5. Lastly, open `File` > `Settings` and head to `Build, Execution, Development` > `Build Tools` > `Gradle`.
34-
Make sure `Build and run using` and `Run tests using` is set to `Gradle`.
35-
36-
6. 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!
7+
Available modules:
8+
- Core
9+
- The core module, **every other module depends on this**. Adds misc utility classes for modules and other mods to use.
10+
- Fluid
11+
- Improved api for fluid storage and transportation.
12+
- Energy
13+
- Adds a simple, configurable energy api.
14+
- Multiblocks
15+
- Adds support for multiblock structures/machines.

0 commit comments

Comments
 (0)