Skip to content

Commit

Permalink
update maven info in the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IchHabeHunger54 committed Jan 7, 2025
1 parent 3482ac2 commit 68fe086
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,32 @@ To get started, add Bibliocraft as a dependency for your mod in your `build.grad

```groovy
repositories {
// We currently do not host Bibliocraft on our own maven, this will change soon!
maven { url 'https://cursemaven.com' }
// Bibliocraft is hosted on the MinecraftschurliMods maven.
maven {
url 'https://minecraftschurli.ddns.net/repository/maven-public'
}
}
dependencies {
// At compile time, depend only on the API JAR. TODO actually make this an API jar.
compileOnly "curse.maven:bibliocraft-legacy-1122260:${bc_version}"
// At compile time, depend only on the API JAR.
compileOnly "com.github.minecraftschurlimods:bibliocraft:${mc_version}-${bc_version}:api"
// At runtime, use the full JAR.
runtimeOnly "curse.maven:bibliocraft-legacy-1122260:${bc_version}"
runtimeOnly "com.github.minecraftschurlimods:bibliocraft:${mc_version}-${bc_version}"
}
```

Get the latest version on CurseForge. Please refer to the [CurseMaven documentation](https://www.cursemaven.com) on how to find the latest artifact.
The format of the `bc_version` variable is `major.minor.patch`, e.g. `1.0.0`. Please get the latest version number on CurseForge, Modrinth, or by browsing the maven yourself.

Next, add the dependency block in your `neoforge.mods.toml` file. Note: It is crucial that your mod is set to load `BEFORE` Bibliocraft, to ensure that your event handlers will be fired early enough.

```toml
[[dependencies.${mod_id}]]
modId="bibliocraft"
type="optional"
versionRange="[1.1.0,)"
# Bibliocraft bumps the minor version whenever a breaking API change occurs,
# or when addons are expected to update (e.g. when a new wooden block is added).
# As such, we can allow any patch of the current minor version.
versionRange="[1.3.0,1.4)"
ordering="BEFORE"
side="BOTH"
```
Expand Down

0 comments on commit 68fe086

Please sign in to comment.