Chocohead/Rift

A lightweight mod loader and API for Minecraft 1.13

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.chocohead:rift:v1.0.4-77'
	}
	dependencies {
		implementation("com.github.chocohead:rift:v1.0.4-77")
	}
	<dependency>
	    <groupId>com.github.chocohead</groupId>
	    <artifactId>rift</artifactId>
	    <version>v1.0.4-77</version>
	</dependency>

                            
    libraryDependencies += "com.github.chocohead" % "rift" % "v1.0.4-77"
        
        

                            
    :dependencies [[com.github.chocohead/rift "v1.0.4-77"]]

Readme

Rift

Rift is a lightweight modding API, library, and mod loader for Minecraft 1.13. The main objective of Rift is to make a more modular and lightweight modding API for Minecraft. Find out more on CurseForge.

This fork contains the Minecraft 1.13.1 port (in the newerer branch) and the Minecraft 1.13.2 port (in the newerest branch). For Minecraft 1.13 see here. Pull requests should go to either of those branches depending on Minecraft version, jitpack is for temporary publishing until everything is pulled into the main Rift repo.

Playing on Minecraft 1.13.2

If you have any problems or find any incompatibilities using this please do report them here. Previous problems with Optifine and water/connected textures appear to have been fixed so there is nothing known to cause trouble at the moment.

Using the Minecraft Launcher

The current version can be downloaded from here and installed just like the previous versions of Rift. Mods designed for 1.13 currently aren't supported but might be in future.

Using MultiMC

Modified original documentation from the Rift Wiki

  1. Make a new instance in MultiMC with with the wanted version of Minecraft—in our case, Minecraft 1.13.2
  2. Click Edit Instance—it should open the Version page of the instance.
  3. Click Add Empty.
  4. Set uid to org.dimdev.rift and name to Rift.
  5. Select the newly created component and click Edit—this should open the file in a text editor.
  6. Edit the JSON to look like the example below, then save the file.
  7. Launch the instance from MultiMC.

The version that I selected for the example is the one provided alongside VoxelMap here

If the example doesn't fit the Rift version exactly, change the version. For example, replace all occurrences of 2d8bb9bd56 with d6893ec777.

You can use the version page to check the file for errors—obvious mistakes will show up in the Version page as soon as you click the Refresh button.

If the JSON file doesn't open in a text editor, make sure your operating system is set up to open .json files in one first.

Example MultiMC Json

{
    "+tweakers": [
        "org.dimdev.riftloader.launch.RiftLoaderClientTweaker"
    ],
    "formatVersion": 1,
    "+libraries": [
        {
            "name": "com.github.Chocohead:rift:2d8bb9bd56",
            "url": "https://jitpack.io/"
        },
        {
            "name": "org.dimdev:mixin:0.7.11-SNAPSHOT",
            "url": "https://www.dimdev.org/maven/"
        },
        {
            "name": "org.ow2.asm:asm:6.2",
            "url": "http://repo1.maven.org/maven2/"
        },
        {
            "name": "org.ow2.asm:asm-commons:6.2",
            "url": "http://repo1.maven.org/maven2/"
        },
        {
            "name": "org.ow2.asm:asm-tree:6.2",
            "url": "http://repo1.maven.org/maven2/"
        },
        {
            "name": "net.minecraft:launchwrapper:1.12"
        }
    ],
    "mainClass": "net.minecraft.launchwrapper.Launch",
    "name": "Rift",
    "releaseTime": "2018-07-18T15:11:46+00:00",
    "requires": [
        {
            "equals": "1.13.2",
            "uid": "net.minecraft"
        }
    ],
    "uid": "org.dimdev.rift",
    "version": "1.0.4-2d8bb9bd56"
}

Modding on Minecraft 1.13.2

The fork of Forge Gradle 2 used for 1.13 has been improved for 1.13.2 so setupDecompWorkspace is now supported and is strongly encouraged to be used. Access transformers which would have otherwise silently failed will now explicitly crash so they can be fixed, which is helpful for updating. The locations of all found transformers can be found by running setupDecompWorkspace/setupDevWorkspace with --info and looking immediately after where the access transformer task is applied. Further improvements can be suggested here.

Any suggestions for Rift itself can be made as issues here, or pull requested directly. Feel free to join the Discord server if you want to talk about stuff first or have any other questions.

Setting up

For a bare bones setup which is ready to be tinkered with, see the Rift MDK (download).

If you want to start from scratch, use this build.gradle in favour of the Rift wiki's, otherwise the information provided there is still accurate.

buildscript {
	repositories {
		mavenCentral()
		maven { url 'https://www.jitpack.io' }
		maven { url 'https://files.minecraftforge.net/maven' }
	}
	dependencies {
		classpath 'com.github.Chocohead:ForgeGradle:moderniser-SNAPSHOT'
	}
}

apply plugin: 'net.minecraftforge.gradle.tweaker-client'
apply plugin: 'java'

group 'com.example'
version '1.0.0'
archivesBaseName = 'exampleMod'

sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
	mavenCentral()
	maven { url 'https://www.dimdev.org/maven/' }
	maven { url 'https://www.jitpack.io' }
	maven { url 'http://repo.strezz.org/artifactory/list/Strezz-Central' }
}

dependencies {
	implementation 'com.github.Chocohead:Rift:jitpack-SNAPSHOT:dev'
}

minecraft {
	version = '1.13.2'
	mappings = 'snapshot_20181130'
	runDir = 'run'
	tweakClass = 'org.dimdev.riftloader.launch.RiftLoaderClientTweaker'
}

Remember to change the group and archivesBaseName for the mod you're making before publishing.

Changes between Rift 1.13 and 1.13.2

Obviously the obfuscated mappings have changed so any access transformers will need to be updated. There is the beginnings of a tool provided for automatically doing this here. The same tool can also be used for more easily adding access transformer entries as it can go straight from MCP name to matching Notch names.

There have also been a few API changes within Rift to account for changes made in Minecraft 1.13.1:

  • The deprecated CustomPayloadHandler has been removed in favour of using MessageAdder
  • DimensionTypeAdder no longer expects a set of DimensionTypes but is a callback for registering them directly now DimensionType is not an enum. It provides a utility method addDimensionType for this purpose.
  • ClientTickable#tick now provides the Minecraft client instance directly to match ServerTickable#tick providing MinecraftServer

There's been many MCP method name changes too but most (if not all) are obvious enough to not need listing here.