Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 4.1 KB

README.md

File metadata and controls

41 lines (30 loc) · 4.1 KB
Raw

MultiLoader Template

This project provides a Gradle project template that can compile mods for Fabric, Forge, and Quilt using a common sourceset. This project does not require any third party libraries or dependencies.

Getting Started

IntelliJ IDEA

This guide will show how to import the MultiLoader Template into IntelliJ IDEA. The setup process is roughly equivalent to setting up Forge and Fabric independently and should be very familiar to anyone who has worked with their MDKs.

  1. Clone or download this repository to your computer.
  2. Configure the project by editing the group, mod_author, and mod_id properties in the gradle.properties file. You will also need to change the rootProject.name property in settings.gradle.
  3. Open the template's root folder as a new project in IDEA. This is the folder that contains this README file and the gradlew executable.
  4. If your default JVM/JDK is not Java 17 you will encounter an error when opening the project. This error is fixed by going to File > Settings > Build, Execution, Deployment > Build Tools > Gradle > Gradle JVMand changing the value to a valid Java 17 JVM. You will also need to set the Project SDK to Java 17. This can be done by going to File > Project Structure > Project SDK. Once both have been set open the Gradle tab in IDEA and click the refresh button to reload the project.
  5. Open the Gradle tab in IDEA if it has not already been opened. Navigate to Your Project > Forge > Tasks > forgegradle runs > genIntellijRuns. Run this task to set up run configurations for Forge.
  6. Open your Run/Debug Configurations. Under the Application category there should now be options to run Forge and Fabric projects. Select one of the client options and try to run it.
  7. Assuming you were able to run the game in step 6 your workspace should now be set up.

Eclipse

While it is possible to use this template in Eclipse it is not recommended. During the development of this template multiple critical bugs and quirks related to Eclipse were found at nearly every level of the required build tools. While we continue to work with these tools to report and resolve issues support for projects like these are not there yet. For now Eclipse is considered unsupported by this project. The development cycle for build tools is notoriously slow so there are no ETAs available.

Development Guide

When using this template the majority of your mod is developed in the Common project. The Common project is compiled against the vanilla game and is used to hold code that is shared between the different loader-specific versions of your mod. The Common project has no knowledge or access to ModLoader specific code, apis, or concepts. Code that requires something from a specific loader must be done through the project that is specific to that loader, such as the Forge or Fabric project.

Loader specific projects such as the Forge and Fabric project are used to load the Common project into the game. These projects also define code that is specific to that loader. Loader specific projects can access all of the code in the Common project. It is important to remember that the Common project can not access code from loader specific projects.

Template README

Under this line is a README template for your mods. Remove this and above lines.

Mod Name

What does this mod do?

Animi ea distinctio architecto cum. Suscipit non praesentium omnis recusandae. Ea qui ut tempore sequi ea officiis. Similique consequatur eaque eum nam nulla quia iure.

Other Information: