Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrtjp/projectred
Redstone Engineering
https://github.com/mrtjp/projectred
forge minecraft minecraft-forge minecraft-mod
Last synced: 7 days ago
JSON representation
Redstone Engineering
- Host: GitHub
- URL: https://github.com/mrtjp/projectred
- Owner: MrTJP
- License: mit
- Created: 2013-07-06T06:59:40.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2025-01-04T16:23:59.000Z (20 days ago)
- Last Synced: 2025-01-10T16:06:25.117Z (14 days ago)
- Topics: forge, minecraft, minecraft-forge, minecraft-mod
- Language: Java
- Homepage:
- Size: 17.7 MB
- Stars: 476
- Watchers: 55
- Forks: 184
- Open Issues: 88
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ProjectRed
A Minecraft Forge mod all about Redstone circuity.
## Latest Versions
| MC Version | Branch | Latest Release | Latest Beta | Status |
|:----------:|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------|
| 1.20.1 | `1.20.1` |  |  | Active |
| 1.19.2 | `1.19.x` |  |  | Maintenance |
| 1.18.2 | `1.18.x` |  |  | Maintenance |
| 1.16.5 | `1.16.x` |  |  | End-of-Life |
| 1.15.2 | `1.15.x` | N/A |  | End-of-Life |
## Links
| Module | Modrinth | CurseForge |
|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Core | [](https://modrinth.com/mod/project-red-core) | [](https://www.curseforge.com/minecraft/mc-mods/project-red-core) |
| Expansion | [](https://modrinth.com/mod/project-red-expansion) | [](https://www.curseforge.com/minecraft/mc-mods/project-red-expansion) |
| Exploration | [](https://modrinth.com/mod/project-red-exploration) | [](https://www.curseforge.com/minecraft/mc-mods/project-red-exploration) |
| Fabrication | [](https://modrinth.com/mod/project-red-fabrication) | [](https://www.curseforge.com/minecraft/mc-mods/project-red-fabrication) |
| Illumination | [](https://modrinth.com/mod/project-red-illumination) | [](https://www.curseforge.com/minecraft/mc-mods/project-red-illumination) |
| Integration | [](https://modrinth.com/mod/project-red-integration) | [](https://www.curseforge.com/minecraft/mc-mods/project-red-integration) |
| Transmission | [](https://modrinth.com/mod/project-red-transmission) | [](https://www.curseforge.com/minecraft/mc-mods/project-red-transmission) |
## 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](https://docs.minecraftforge.net/en/fg-5.x/gettingstarted/#setting-up-forgegradle) 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 `.//build/libs`.
## ProjectRed API
### Setup
ProjectRed API can be consumed by your ForgeGradle project by adding the following to your `build.gradle`:
```groovy
// 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.