Skip to content

ConduitMC/Conduit

Repository files navigation

Conduit Status Codacy Badge Nexus

Conduit is a next-generation Minecraft server built for stability, ease of use, and speed - without breaking Vanilla Minecraft mechanics.

Contributing

If you would like to contribute to Conduit, please first visit our issues page and find one you would like to tackle.

Guidelines

  • Descriptive commits (don't make them like "did something")
  • Keep commit messages appropriate.
  • Keep pull request descriptions short, and descriptive.
  • Be ready for feedback

Setting up a development environment

Requirements:

  • Java 8+
  • Git

To get started with developing, you can setup your environment with the following commands:

git clone https://github.com/ConduitMC/ConduitLauncher
cd ConduitLauncher
./gradlew build install
cd ..

mkdir Server
cd Server
cp ../ConduitLauncher/build/libs/ConduitLauncher-*.jar ConduitLauncher.jar
java -jar ConduitLauncher.jar dev

# Once that finishes, you have a fully ready to go server for development, and all other libraries installed.
# Now, you can clone Conduit and start hacking!
cd ..
git clone https://github.com/ConduitMC/Conduit
cd Conduit
./gradlew build install

# Then copy this build to the .mixins folder in the server.
cp target/Conduit.jar ../Server/.mixins/Conduit.jar