search

asusoda / Corundum

This is a new plugin-based server-side modding A.P.I. for Minecraft. [WIP]
MIT License
7 stars 1 forks source link

readme

Corundum

Description

This project is a Java-based server-side plugin-based modification A.P.I. for Minecraft. Using Mojang's minecraft_server.jar as a resource, it can work like a Minecraft server while allowing user-programmed Java plugins to handle events that occur during the gameplay in order to modify the mechanics of Minecraft. This can be used to do small tasks like preventing the spawning of baby zombies or large, complex tasks such as creating minigames servers like MinePlex, The Shotbow Network, or HyPixel's server.

Installation

NOTE: This product is not finished!

Installing Normally

NOTE: There is no normal download yet!

  1. If your Java version is less than 7, install your favorite Java 7+ Virtual Machine.

  2. Download the Corundum launcher .jar. NOTE: There is not currently a Corundum launcher download!

  3. Run the Corundum launcher .jar with your Java 7+ Virtual Machine.

The Corundum launcher will help you from there!

Building from Source

You can either use the installer under the Corundum installer directory here, OR follow these steps.

Download the tools
  1. Download MCP v9.08.
  2. Download the minecraft_server.jar for Minecraft 1.8.1 from Minecraft's official website.
  3. Download the source code from this repository (at least both Corundum and the Corundum Hub).
Compile the source
  1. Put the minecraft_server.jar in MCP's "jar" folder and run MCP's decompile script (decompile.bat for Windows, decompile.sh for *nix-based systems, including Mac).
  2. Compile Corundum and the Corundum Hub with your favorite Java 7 compiler. If you had to combine the source files for Corundum and Hub to achieve this, separate them again into two separate folders.
    • The Corundum Hub can be compiled as an average Java program.
    • Corundum, however, requires three things to be in its compilation envorionment:
      • the Corundum Hub (source code or compiled JAR)
      • the Minecraft code deobfuscated by M.C.P. (just the net.minecraft package and its subpackages), and
      • the official minecraft_server.jar itself with the "net" folder removed from the archive.
Reobfuscate

NOTE: If this is your first time using MCP, you may have to decompile, recompile, and reobfuscate both the client and server normally before attempting the following steps. If you don't, M.C.P. may throw weird errors, often concerning a client.log or something similar.

  1. Copy the Corundum bytecode (.class files from the "org" folder) into MCP's "bin/minecraft_server" folder.
  2. Run MCP's reobfuscate script (in the MCP folder, ending in ".bat" for Windows machines or ending in ".sh" for Unix-based systems, including Mac).
  3. Package the "org" folder in MCP's "reobf" folder into a new jar called "Corundum.jar". Make sure that inside the jar, the top-level directory is "org".
Zip it!
  1. Package the "org" folder in MCP's "reobf" folder into a new jar called "Corundum.jar". Make sure that inside the jar, the top-level directory is "org".
  2. Add a META_INF folder with a MANIFEST.MF file to the Corundum Hub.jar and designate "org.corundummc.hub.CorundumHub" as the main class.
Run it!
  1. Place the Corundum.jar, Corundum Hub.jar, and minecraft_server.jar in the same directory.
  2. Run the Corundum Hub.jar with a Java 7 Virtual Machine. (Running with a Java 8 Virtual Machine may cause errors.)

Sorry it's so complicated.