aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: a3f5daf0d1a4fb96171c824d783b59faf7506525 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# Roughly Enough Items
https://minecraft.curseforge.com/projects/roughly-enough-items <br>
Roughly Enough Items is a mod to view Items and Recipes for Minecraft 1.13 - 1.17, supporting mod loaders from Forge, Rift to Fabric.
-----

[Help translate REI on Crowdin!](https://crowdin.com/project/roughly-enough-items)

![](https://i.imgur.com/eQsWDrM.png)

![](https://i.imgur.com/OcOQLip.png)

This mod is both client sided and server sided.

# Maven
Firstly, add my Maven repository (If you already have the architectury maven, you don't need to do this, they are the same repo)
```gradle
repositories {
    maven { url "https://maven.shedaniel.me" }
}
```

## Choosing the correct artifact to depend on
### Fabric
REI recommends you to declare a compile dependency on REI's API, and a runtime dependency on REI's full package.
```gradle
dependencies {
    modCompileOnly "me.shedaniel:RoughlyEnoughItems-api-fabric:VERSION"
    modRuntimeOnly "me.shedaniel:RoughlyEnoughItems-fabric:VERSION"
}
```

Additionally, if you want to interact with the builtin plugins, you may declare a compile dependency on it as well.
```gradle
dependencies {
    modCompileOnly "me.shedaniel:RoughlyEnoughItems-default-plugin-fabric:VERSION"
}
```

### Forge (ForgeGradle)
REI recommends you to just depend on REI's full package.
```gradle
dependencies {
    implementation fg.deobf("me.shedaniel:RoughlyEnoughItems-forge:VERSION")
}
```

### Forge (Architectury Loom)
REI recommends you to declare a compile dependency on REI's API, and a runtime dependency on REI's full package.
```gradle
dependencies {
    modCompileOnly "me.shedaniel:RoughlyEnoughItems-api-forge:VERSION"
    modRuntimeOnly "me.shedaniel:RoughlyEnoughItems-forge:VERSION"
}
```

Additionally, if you want to interact with the builtin plugins, you may declare a compile dependency on it as well.
```gradle
dependencies {
    modCompileOnly "me.shedaniel:RoughlyEnoughItems-default-plugin-forge:VERSION"
}
```

### Architectury
REI recommends you to declare a compile dependency on REI's common API, and declare the full package on the individual platform's subprojects.
```gradle
// Common
dependencies {
    modCompileOnly "me.shedaniel:RoughlyEnoughItems-api:VERSION"
}

// Fabric
dependencies {
    modRuntimeOnly "me.shedaniel:RoughlyEnoughItems-fabric:VERSION"
}

// Forge
dependencies {
    modRuntimeOnly "me.shedaniel:RoughlyEnoughItems-forge:VERSION"
}
```

Additionally, if you want to interact with the builtin plugins, you may declare a compile dependency on it as well.
```gradle
// Common
dependencies {
    modCompileOnly "me.shedaniel:RoughlyEnoughItems-default-plugin:VERSION"
}
```

### List of artifacts
- **me.shedaniel:RoughlyEnoughItems-api**: REI API for Architectury Common
- **me.shedaniel:RoughlyEnoughItems-default-plugin**: REI Default Plugin for Architectury Common
- **me.shedaniel:RoughlyEnoughItems-runtime**: REI Runtime for Architectury Common
- **me.shedaniel:RoughlyEnoughItems-api-fabric**: REI API for Fabric
- **me.shedaniel:RoughlyEnoughItems-default-plugin-fabric**: REI Default Plugin for Fabric
- **me.shedaniel:RoughlyEnoughItems-runtime-fabric**: REI Runtime for Fabric
- **me.shedaniel:RoughlyEnoughItems-api-forge**: REI API for Forge
- **me.shedaniel:RoughlyEnoughItems-default-plugin-forge**: REI Default Plugin for Forge
- **me.shedaniel:RoughlyEnoughItems-runtime-forge**: REI Runtime for Forge
- **me.shedaniel:RoughlyEnoughItems-fabric**: Full REI for Fabric
- **me.shedaniel:RoughlyEnoughItems-forge**: Full REI for Forge