generated from Turnip-Labs/bta-example-mod
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
36b41ff
commit 80c21f6
Showing
8 changed files
with
27 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,12 @@ | ||
# Example Mod | ||
# Playground | ||
|
||
Template for making Babric mods for BTA! | ||
This is the beginning of awesome mods! | ||
|
||
**Note: *DO NOT fork this repository unless you want to contribute!*** | ||
> **Important** | ||
> Required [Babric](https://github.com/Turnip-Labs/babric-instance-repo/releases) to run the mod. | ||
## Prerequisites | ||
- JDK for Java 17 ([Eclipse Temurin](https://adoptium.net/temurin/releases/) recommended) | ||
- IntelliJ IDEA | ||
- Minecraft Development plugin (Optional, but highly recommended) | ||
## Features | ||
|
||
## Setup instructions | ||
|
||
|
||
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`. | ||
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. While in the same place, select the Client and Server run configurations and edit the VM options under the SDK selection. | ||
|
||
![image](https://github.com/Turnip-Labs/bta-example-mod/assets/58854399/2d45551d-83e3-4a75-b0e6-acdbb95b8114) | ||
|
||
Click the double arrow icon to expand the list, and append `-Dfabric.gameVersion=1.7.7.0` to the end. | ||
|
||
![image](https://github.com/Turnip-Labs/bta-example-mod/assets/58854399/e4eb8a22-d88a-41ef-8fb2-e37c66e18585) | ||
|
||
5. 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`. | ||
|
||
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! | ||
- Feature #1 | ||
- Feature #2 | ||
- Feature #3 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 4 additions & 5 deletions
9
...ava/turniplabs/examplemod/ExampleMod.java → ...a/rootenginear/playground/Playground.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,15 @@ | ||
package turniplabs.examplemod; | ||
package rootenginear.playground; | ||
|
||
import net.fabricmc.api.ModInitializer; | ||
import org.slf4j.Logger; | ||
import org.slf4j.LoggerFactory; | ||
|
||
|
||
public class ExampleMod implements ModInitializer { | ||
public static final String MOD_ID = "examplemod"; | ||
public class Playground implements ModInitializer { | ||
public static final String MOD_ID = "playground"; | ||
public static final Logger LOGGER = LoggerFactory.getLogger(MOD_ID); | ||
|
||
@Override | ||
public void onInitialize() { | ||
LOGGER.info("ExampleMod initialized."); | ||
LOGGER.info("Playground initialized."); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,33 +1,29 @@ | ||
{ | ||
"schemaVersion": 1, | ||
"id": "examplemod", | ||
"id": "playground", | ||
"version": "${version}", | ||
|
||
"name": "Example Mod", | ||
"description": "This mod aims to help new BTA modders.", | ||
"name": "Playground", | ||
"description": "This is the beginning of awesome mods!", | ||
"authors": [ | ||
"Turnip Labs" | ||
"rootEnginear" | ||
], | ||
"icon": "icon.png", | ||
"contact": { | ||
"homepage": "", | ||
"sources": "" | ||
"homepage": "https://github.com/rootEnginear/bta-rootenginear-mods", | ||
"sources": "https://github.com/rootEnginear/bta-rootenginear-mods", | ||
"issues": "https://github.com/rootEnginear/bta-rootenginear-mods/issues" | ||
}, | ||
|
||
"license": "CC0-1.0", | ||
|
||
"environment": "*", | ||
"entrypoints": { | ||
"main": [ | ||
"turniplabs.examplemod.ExampleMod" | ||
"rootenginear.playground.Playground" | ||
] | ||
}, | ||
"mixins": [ | ||
"examplemod.mixins.json" | ||
"playground.mixins.json" | ||
], | ||
|
||
"depends": { | ||
"fabricloader": ">=0.13.3" | ||
}, | ||
"suggests": { | ||
} | ||
} |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file.
4 changes: 1 addition & 3 deletions
4
src/main/resources/examplemod.mixins.json → src/main/resources/playground.mixins.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters