Skip to content
This repository has been archived by the owner on Jan 24, 2022. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
comp500 committed Aug 3, 2020
1 parent 92a007a commit 7758f93
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Jumploader
Jumploader is a mod that allows the use of Fabric mods in Twitch modpacks, by loading Fabric as if it were a Forge mod. It works on both the client and server, however it's only necessary on the server if you want to launch the game using tools that only support Forge. Jumploader is fully configurable to download any Minecraft version and mod loader, but by default it will download the Fabric loader and library versions corresponding to your current version of the game. It only loads if your game was launched from Forge/ModLauncher, so it won't do anything if your Minecraft launcher already supports Fabric.

**Warning: This mod will stop Forge mods from loading!** Make sure you back up before you join worlds where you have used Forge mods previously - as all the blocks/items added by those mods will disappear.

## What it does
- Loads Fabric (or a different configured mod loader) instead of Forge, from a Forge installation.
- Automatically downloads the latest Fabric loader version for your version of the game, with no required configuration.
Expand All @@ -9,10 +11,7 @@ Jumploader is a mod that allows the use of Fabric mods in Twitch modpacks, by lo

## What it doesn't do
- Jumploader doesn't let you run Fabric mods in tandem with Forge mods - it hijacks the launching process so that Forge never loads. See [Patchwork](https://github.com/PatchworkMC) for a project aiming to do this.
- Jumploader doesn't currently work very well on the client for loading a Minecraft game with a different major version (including snapshots) to the currently loaded game, as supplementary assets (such as sounds) are downloaded separately by the game launcher. It may be possible, however, to make a Fabric mod that fixes this issue.
- Jumploader doesn't currently work very well on the client for loading a Minecraft game with a different major version (including snapshots) to the currently loaded game, as supplementary assets (such as sounds) are downloaded separately by the game launcher. The [Asset Validator](https://github.com/modmuss50/AssetValidator) mod fixes this issue.

## Requirements
Requires a Forge version that uses ModLauncher (or ModLauncher on it's own, without Forge) - this usually means 1.13 or newer.

## Compiliation notes
- Needs to be compiled with Java 9 or newer, using Java 8 language level, because some of the APIs needed for compatibility with Java 12 and newer are only available for Java 9 and newer.
Requires a Forge version that uses ModLauncher (or ModLauncher on it's own, without Forge) - this usually means 1.13 or newer.

0 comments on commit 7758f93

Please sign in to comment.