A work-in-progress library coremod for Cyan. This mod binds the server protocol with regular mods.
This project is build using gradle, but it supplies the wrapper so you dont need to install it. What you do need is Java JDK, if you have it installed, proceed with the following commands depending on your operating system.
ProtocolHooks supports both 1.16 and 1.17.
Adding the -PoverrideGameVersion=<version> argument to the build command will select the version.
On Linux, you need to run the following commands:
chmod +x gradlew
./gradlew buildOn Windows, you need to run only the following:
.\gradlew buildMain installation:
- Find the
build/ccmffolder - Copy the latest
ccmffile - Find your Cyan installation
- Navigate to
.cyan-data/coremods - Paste the mod file
After installing the mod file, you will need to install its trust file in order to run it:
- Find the
build/ctcsfolder - Enter the latest directory
- Copy the
ctcfile - Find your Cyan installation
- Create and/or enter the
.cyan-data/trustdirectory - Paste the
ctcfile
On Linux, you need to run the following commands to prepare the debug environment:
chmod +x gradlew
./gradlew creatEclipseOn Windows, you need to run only the following:
.\gradlew creatEclipseThis process will take a lot of time if run for the first time. After running the commands, you can import this project in the Eclipse IDE.
TIP: you can add -PoverrideGameVersion=<version> to select a game version.
First, open your mod's build.gradle file and edit it as following:
// File: build.gradle
// ...
// ProtocolHooks Version
def protocolHooksVersion = "1.2"
// Add ProtocolHooks to the dependencies block
// ...
dependencies {
// ...
// Protocol hooks dependency:
implementation Mod.byId("protocol:hooks", protocolHooksVersion + "-" + gameVersion)
// ...
}
// ...After that, re-generate the eclipse files:
On Linux, you need to run the following commands to prepare the debug environment:
chmod +x gradlew
./gradlew creatEclipseOn Windows, you need to run only the following:
.\gradlew creatEclipseCode Documentation: