Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 2.01 KB

README.md

File metadata and controls

51 lines (33 loc) · 2.01 KB

⚠️ Kettle is still very raw and you may encounter issues in using it with your server. You have been warned!

Kettle

Kettle

What's Kettle?

Kettle is the next link in the hybrid server chain: Kettle ➡️ Contigo ➡️ Thermos ➡️ KCauldron ➡️ Cauldron ➡️ MCPC+

Kettle was initially concieved as a fork of Contigo, but after a few iterations got rid of Contigo's dependencies and can no longer be concidered it's fork, but a standalone hybrid server.

Kettle is dependent on custom Forge and Paper builds, meaning it can run both Craftbukkit/spigot-based plugins and forge-based mods.

We hope to eliminate all issues with craftbukkit forge servers. In the end, we envision a seamless, low lag Kettle experience with support for new 1.12+ versions of Minecraft.

Deployment

Installation

  1. Download the server from the Releases section
  2. Make a new folder for the server
  3. Move the server to the folder and rename it to kettle.jar
  4. Make a launch script

Building the sources

All builds are available in build/distributions

  • Clone the Project
    • You can use GitHub Desktop/GitKraken or clone using the terminal
      • git clone https://github.com/KettleFoundation/Kettle
    • Next you are gonna want to clone the submodule
      • git submodule update --init --recursive
  • Building
    • First you want to setup the project
      • ./gradlew setup
    • After you have setup the project you are going to want to run the build
      • ./gradlew build
    • Now go and get a drink this may take some time

Chat

You are welcome to visit Kettle Discord server here.

Unstable/Test builds

For unstable/test builds you can check this repository (how handy)