Project icon

multiconnect

GitHub license GitHub issues GitHub tag

A mod to enable a Minecraft client to connect to multiple server versions.

Installation for Players

  1. Download and run the Fabric installer.
    • Click the "vanilla" button, leave the other settings as they are, and click "download installer".
    • Note: this step may vary if you aren't using the vanilla launcher or an old version of Minecraft.
  2. Download multiconnect from the releases page and move it to the mods folder (.minecraft/mods).

Installation for Mod Developers

This section is for when you are developing your own mod and want to use the multiconnect API, or run multiconnect alongside your mod in the IDE. Aside from the first step, you ONLY need to follow the steps applicable to you and your mod.

  1. Add a repositores {} block in your build.gradle (if there isn't already one), and add Earthcomputer's Bintray mods repository: 
    repositories {
  maven {
     url 'https://dl.bintray.com/earthcomputer/mods'
  }
}
    • Note: this repositories block is NOT the same as the one inside the buildscript {} block.
  2. If you want to use the API inside your mod, you will have to jar-in-jar it for the release and add it to the classpath. To do this, add the following to your dependencies {} block: 
    dependencies {
  // ...
  modImplementation 'net.earthcomputer.multiconnect:<version>:api'
  include 'net.earthcomputer:multiconnect:<version>:api'
}
    • Note: replace <version> with the version of multiconnect you want to depend on.
    • Note: SKIP the include part if your mod is NOT using the API in any way.
  3. If you want to run multiconnect in the IDE alongside your mod, add the following to your dependencies {} block: 
    dependencies {
  // ...
  modRuntime 'net.earthcomputer:multiconnect:<version>:slim'
}
    • Note: the previous step should also be done alongside this step.
    • Note: this step is only necessary if you want to run the full mod in the IDE. Otherwise you can skip this step.

Contributing

  1. Clone the repository 
    git clone https://github.com/Earthcomputer/multiconnect
cd multiconnect
  2. Generate the Minecraft source code 
    ./gradlew genSources
    • Note: on Windows, use gradlew rather than ./gradlew.
  3. Generate the IDE project depending on which IDE you prefer 
    ./gradlew idea      # For IntelliJ IDEA
./gradlew eclipse   # For Eclipse
  4. Import the project in your IDE and edit the code
  5. After testing in the IDE, build a JAR to test whether it works outside the IDE too 
    ./gradlew build

    The mod JAR may be found in the build/libs directory

  6. Create a pull request so that your changes can be integrated into multiconnect
    • Note: for large contributions, create an issue before doing all that work, to ask whether your pull request is likely to be accepted