Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 5.72 KB

including-oneconfig.md

File metadata and controls

84 lines (52 loc) · 5.72 KB
Raw
description
A beginner's guide to starting modding with OneConfig

Modding Basics

This page will serve as a basic guide to getting started with modding using OneConfig's example mod.

Minecraft mods are most commonly added into the game using a loader, the most popular of which are Fabric and Forge. Forge is popular for older Minecraft versions, while Fabric is considered the main platform for vanilla compatible modding in 1.16+. The term 'mod' refers to a modification of the Minecraft game.

Since Minecraft is in Java, most of its mods are as well. You may also find mods written in Kotlin, a programming language designed to be compatible with the JVM (Java Virtual Machine). Some developers find Kotlin easier to use than Java. OneConfig includes Kotlin so you shouldn't include it yourself in your mod if you wish to use it. However, OneConfig itself mostly uses Java over Kotlin.

You will need some basic knowledge of programming to effectively develop Minecraft mods. But don't worry! Java is reasonably easy to pick up, as it is an object-orientated programming (OOP) language with a reasonably easy-to-understand syntax. However, you should still watch a few tutorials and get your feet relatively wet before diving into Minecraft modding.

Step 1: Installing IntelliJ IDEA

For this tutorial, we are going to use the OneConfig Example which can be found here. In this guide, we are going to use JetBrains IntelliJ IDEA as our integrated development environment (IDE), as this is the preferred choice for most Minecraft mod developers.

Firstly, head to their downloads page and download IntelliJ IDEA for your operating system or platform. We recommend the 'Community Edition' for casual developers. It's free and probably has all the features you'll need. After downloading it, follow the prompts to get it installed.

Once that has been downloaded, you may want to open up your files browser and create yourself a directory for all your mods (e.g C:/Users/Bob/Developer/). This is just a quality of life step, so if you wish, you can ignore it and do as you wish.

Step 2: Creating the Project

Now that you have installed IntelliJ, you should be ready to clone the project. Open up IntelliJ and you should be greeted with a screen a bit like this (after accepting the terms):

IntelliJ welcome screen

Once you're at this screen:

  • Click the Get from VCS button.
  • Go to Repository URL.
  • Check that Version Control is set to Git.
  • Set the directory to the root folder you made earlier for mod development.
  • In the URL box, input https://github.com/Polyfrost/OneConfigExampleMod.
  • At the end of the Directory box, add the name of your mod. In this tutorial, it will be called ExampleMod.

It should now look something like this:

IntelliJ clone screen

If that all looks good, go ahead and click the Clone button in the bottom right.

Step 3: Project Setup

Now, you will need to set up your Java Development Kits (JDKs) to get started with coding. These are used to run your code and Minecraft, and allow you to build your projects into distributable java executable binaries (commonly known as JARs).

GRADLE JVM

  • Windows & Linux: Press Ctrl+Alt+S to open Settings
    macOS: Press ⌘ , (command + comma), or go to IntelliJ IDEA > Preferences from the menu bar, to open Preferences
  • Go to Build, Execution and Deployment > Build Tools > Gradle from the left sidebar menu.
  • At the bottom of this screen, look for a dropdown list button labelled Gradle JVM. Open the dropdown list.
  • Now, click Download JDK and set the Version to 17 or above on the popup that appears. Don't change anything else — just hit Download. Once finished, set this new JVM as the Gradle JVM and click Apply to complete the changes.

Gradle JVM settings screen

PROJECT JVM

  • Windows & Linux: Press Ctrl+Alt+Shift+S to open Project Structure.
    macOS: Press ⌘ ; (command + semicolon), or go to File > Project Structure from the menu bar to open Project Structure.
  • Go to Project Settings > Project.
  • Open the SDK dropdown menu.
  • Again, go to Add SDK then Download JDK. This time, choose 1.8 as the version and press Download. Once finished, set this new JVM as the Project SDK. Click Apply to set the changes.
  • Again, go to Add SDK and then Download SDK. This time, choose 1.8 as the version and press Download. Once that has finished, set that new JVM as the Project SDK and click Apply to set the changes.
  • Set the Language level to SDK Default.

Project SDK settings

In case you weren't sure, here is an example of the download dialogue box:

Java 8 download window (example)

Step 4: Reloading and Building

Now you have your JDKs set up, you can go ahead and close all those windows to go back to the main IDE.

Step 5: Run Your Mod

You are now ready to run your mod for the first time! Make sure that Minecraft Client is selected, and click the play button. Loom should have automatically installed the build configs for you, if not, try restarting IntelliJ or reimporting the Gradle project. With some luck, your game should launch.

{% hint style="info" %} If you encounter any issues, feel free to join our Discord server and ask. {% endhint %}