ProjectRed

A Minecraft Forge mod all about Redstone circuity.

MC Version	Branch	Latest Release	Latest Beta	Status
1.19.2	main			Active
1.18.2	main/1.18			Maintenance
1.16.5	main/1.16			End-of-Life
1.15.2	main/1.15	N/A		End-of-Life

Development Environment Setup

Project Red uses a standard Forge Gradle environment. Setup steps should be the same as most other mods. Instructions below are for Intellij IDEA, but the process is very similar for both Eclipse and VSCode. See Forge Gradle docs for more info.

1. Create a new folder and check out the repository:

   mkdir ~/projectred && cd ~/projectred
   git checkout https://github.com/MrTJP/ProjectRed.git .
   

2. Build the project:

   ./gradlew build
   

3. Generate run configurations:

   ./gradlew genIntellijRuns
   

4. Open the project directory in Intellij IDEA and give it a few minutes to set up and index the Gradle project.

Building Locally

You can re-build jar files locally by running ./gradlew build. The jars can be found in ./<module>/build/libs.

ProjectRed API

Setup

ProjectRed API can be consumed by your ForgeGradle project by adding the following to your build.gradle:

// Add repository
repositories {
    maven { url = "https://proxy-maven.covers1624.net/" }
}

// Add dependency (replace ${mc_version} and ${pr_version} with the desired versions)
dependencies {
    /* minecraft dependency is here */
    
    // compile against the API but do not include it at runtime
    compileOnly fg.deobf("mrtjp:ProjectRed-${mc_version}:${pr_version}:api")
    
    // at runtime, use the full mod jars of the required modules
    runtimeOnly fg.deobf("mrtjp:ProjectRed-${mc_version}:${pr_version}:core")
    runtimeOnly fg.deobf("mrtjp:ProjectRed-${mc_version}:${pr_version}:integration")
    runtimeOnly fg.deobf("mrtjp:ProjectRed-${mc_version}:${pr_version}:transmission")
    // etc...
}

Usage

The primary entrypoint into the API is mrtjp.projectred.api.ProjectRedAPI where you will find static fields for each module of ProjectRed. If a module is installed, its corresponding field will be a non-null implementor of that module's API. See the javadocs for more information.