Modding: Difference between revisions

imported>Ambos
m (Added BTA instances and Kotlin example mod links)
imported>Newcome
mNo edit summary
 
(28 intermediate revisions by 6 users not shown)
Line 1: Line 1:
Like vanilla versions of ''Minecraft'', it is possible to download and create mods for ''Better than Adventure!''. This page aims to provide resources to assist in mod creation and installation for ''Better than Adventure!''.
== Users ==
== Users ==
=== Prerequisites ===
=== Prerequisites ===


Line 8: Line 9:
Note: to avoid a common issue on GNU/Linux systems, both users and developers should use the [https://adoptium.net/ Temurin 17 JDK] ([https://aur.archlinux.org/packages/jdk17-temurin AUR package])
Note: to avoid a common issue on GNU/Linux systems, both users and developers should use the [https://adoptium.net/ Temurin 17 JDK] ([https://aur.archlinux.org/packages/jdk17-temurin AUR package])


=== Installation ===
=== Singleplayer ===
 
==== Installation ====
We are going to use Babric, which is a modification of Fabric for Minecraft Beta 1.7.3.
We are going to use Babric, which is a modification of Fabric for Minecraft Beta 1.7.3.


# Download the Babric MultiMC instance for [https://github.com/Turnip-Labs/babric-instance-repo/releases/tag/v1.7.7.0 BTA! 1.7.7.0] ([https://cdn.discordapp.com/attachments/1046707025234640956/1137706168005963806/BTA_1.7.7.0_Babric.zip archive]) or [https://github.com/Turnip-Labs/babric-instance-repo/releases/tag/v1.7.6.2_02 BTA! 1.7.6.2_02] ([https://drive.google.com/file/d/1d_VocjEW2ItjIzbUAsrX_pBThH_zkZAn/view archive])
# Download the Babric MultiMC instance for BTA! [https://github.com/Turnip-Labs/babric-instance-repo/releases/download/v1.7.7.0_02/bta_babric_instance_1.7.7.0_02.zip 1.7.7.0_02], [https://github.com/Turnip-Labs/babric-instance-repo/releases/download/v1.7.7.0_01/bta_babric_instance_1.7.7.0_01.zip 1.7.7.0_01], [https://github.com/Turnip-Labs/babric-instance-repo/releases/download/v1.7.7.0/instance.zip 1.7.7.0] ([https://cdn.discordapp.com/attachments/1046707025234640956/1137706168005963806/BTA_1.7.7.0_Babric.zip archive]) or [https://github.com/Turnip-Labs/babric-instance-repo/releases/download/v1.7.6.2_02/instance.zip 1.7.6.2_02] ([https://drive.google.com/file/d/1d_VocjEW2ItjIzbUAsrX_pBThH_zkZAn/view archive])
# [https://github.com/MultiMC/Launcher/wiki/Import-Instance Import the instance] into your launcher
# [https://github.com/MultiMC/Launcher/wiki/Import-Instance Import the instance] into your launcher


=== Adding mods ===
==== Finding and adding mods ====
 
# Search through the <code>#mods-and-community-downloads</code> channel on the official BTA! Discord server or find mods on [https://github.com/ Github] ([https://github.com/Turnip-Labs example]), or on [https://bta-modding.nouma-vallee.fr/ BTA Modding] (by Nouma).
# Search through the <code>#mods-and-community-downloads</code> channel on the official BTA! Discord server or find mods on [https://github.com/ Github] ([https://github.com/Turnip-Labs example])
# Download the JAR file
# Download the JAR file
# Put it inside your <code>.minecraft/mods</code> folder in your Babric BTA! instance directory
# Put it inside your <code>.minecraft/mods</code> folder in your Babric BTA! instance directory
=== Multiplayer ===
==== Installation ====
# Download the Babric server for [https://github.com/Turnip-Labs/babric-instance-repo/releases/download/v1.7.7.0_02/bta_babric_server_1.7.7.0_02.zip 1.7.7.0_02] or [https://github.com/Turnip-Labs/babric-instance-repo/releases/download/v1.7.7.0_01/bta_babric_server_1.7.7.0_01.zip 1.7.7.0_01]
# Add your mods to the <code>mods</code> directory
# Customize your server (see [[Setting up a Server]])
# Run <code>start.bat</code> if you are on Windows or <code>start.sh</code> if you are on GNU/Linux


== Developers ==
== Developers ==
Line 27: Line 38:


=== Set up the development environment ===
=== Set up the development environment ===
 
Download or clone the [https://github.com/Turnip-Labs/bta-example-mod BTA Babric Example Mod] (or [https://github.com/Turnip-Labs/bta-example-mod-kotlin the Kotlin version] / [https://github.com/Turnip-Labs/bta-example-mod-scala the Scala version])  repository and follow the setup instructions
# Download or clone the [https://github.com/Turnip-Labs/bta-example-mod BTA Babric Minimal Mod] (or [https://github.com/Turnip-Labs/bta-example-mod-kotlin BTA Example Mod Kotlin])  and put it somewhere: <code>git clone <nowiki>https://github.com/Turnip-Labs/bta-minimal-mod.git</nowiki></code>
# Import the project in IntelliJ IDEA, close it and open it again.
# Create a new run configuration by going in <code>Run > Edit Configurations</code>. Then click on the plus icon and select Gradle. In the <code>Tasks and Arguments</code> field enter <code>build</code>. Running it will build your finished jar files and put them in <code>build/libs/</code>
# Open <code>File > Settings</code> and head to <code>Build, Execution, Development > Build Tools > Gradle</code>. Change <code>Build and run using</code> and <code>Run tests using</code> to <code>IntelliJ IDEA</code>
# Open <code>File > Project Structure</code>, select <code>Project</code> and set <code>Compiler output</code> to your project's path/out.
# Make sure your Client and Server run configurations have <code>-Dfabric.gameVersion=1.7.7.0</code> in <code>VM options</code>
# Done. Now all that's left is to change every mention of <code>examplemod</code> to your own mod id.


== Resources ==
== Resources ==
Line 45: Line 49:
* [https://jenkins.liteloader.com/view/Other/job/Mixin/javadoc/index.html Mixin javadoc]
* [https://jenkins.liteloader.com/view/Other/job/Mixin/javadoc/index.html Mixin javadoc]
* [https://github.com/2xsaiko/mixin-cheatsheet/blob/master/README.md Mixin Cheatsheet]
* [https://github.com/2xsaiko/mixin-cheatsheet/blob/master/README.md Mixin Cheatsheet]
* [https://discord.gg/FTUNJhswBT BTA modding Discord] (unofficial)


Note: Since BTA is distributed without obfuscation, all Mixin classes must set the <code>remap</code> option to false. Also, when modding for BTA! 1.7.6.2_02, set <code>loadMods</code> to false in option.txt to avoid errors showing up in the run client configurations logs.
Note: Since ''Better than Adventure!'' is distributed without obfuscation, all Mixin classes must set the <code>remap</code> option to false. Also, when modding for [[Better than Adventure! 1.7.6.2_02|''Better than Adventure!'' 1.7.6.2_02]], set <code>loadMods</code> to false in option.txt to avoid errors showing up in the run client configurations logs.

Latest revision as of 20:58, 2 November 2023

Like vanilla versions of Minecraft, it is possible to download and create mods for Better than Adventure!. This page aims to provide resources to assist in mod creation and installation for Better than Adventure!.

Users Edit

Prerequisites Edit

Note: to avoid a common issue on GNU/Linux systems, both users and developers should use the Temurin 17 JDK (AUR package)

Singleplayer Edit

Installation Edit

We are going to use Babric, which is a modification of Fabric for Minecraft Beta 1.7.3.

  1. Download the Babric MultiMC instance for BTA! 1.7.7.0_02, 1.7.7.0_01, 1.7.7.0 (archive) or 1.7.6.2_02 (archive)
  2. Import the instance into your launcher

Finding and adding mods Edit

  1. Search through the #mods-and-community-downloads channel on the official BTA! Discord server or find mods on Github (example), or on BTA Modding (by Nouma).
  2. Download the JAR file
  3. Put it inside your .minecraft/mods folder in your Babric BTA! instance directory

Multiplayer Edit

Installation Edit

  1. Download the Babric server for 1.7.7.0_02 or 1.7.7.0_01
  2. Add your mods to the mods directory
  3. Customize your server (see Setting up a Server)
  4. Run start.bat if you are on Windows or start.sh if you are on GNU/Linux

Developers Edit

Prerequisites Edit

Set up the development environment Edit

Download or clone the BTA Babric Example Mod (or the Kotlin version / the Scala version) repository and follow the setup instructions

Resources Edit

Developers documentation Edit

Note: Since Better than Adventure! is distributed without obfuscation, all Mixin classes must set the remap option to false. Also, when modding for Better than Adventure! 1.7.6.2_02, set loadMods to false in option.txt to avoid errors showing up in the run client configurations logs.