Skip to content

Commit 0e7d8a4

Browse files
Update README [skip ci]
1 parent 2d15bbd commit 0e7d8a4

File tree

1 file changed

+2
-22
lines changed

1 file changed

+2
-22
lines changed

README.md

Lines changed: 2 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,3 @@
1-
# Essential Ad Mod
1+
# Essential Partner Mod Integration
22

3-
## Release Process
4-
1. Bump `version` in `build.gradle.kts`.
5-
2. Push `vX.X.X` tag.
6-
3. Update changelog in documentation repo, inform partners of the new version.
7-
8-
## Overrides
9-
10-
There are a number of ways to test new configurations for the ad mod.
11-
12-
The `essential.ad.api` JVM property sets the endpoint to use for the Essential API. For example,
13-
`-Dessential.ad.api=https://api.lon-dev.modcore.dev` can be used to use the dev API, which uses
14-
the `develop` branch of the configuration repository.
15-
16-
The configuration from the configuration repository (the `partner/modal` folder) can be placed
17-
into the `.minecraft/config/essentialad/override/` folder, and they will override the configuration
18-
loaded from the API.
19-
20-
The entire API response can be overridden by placing a `data.override.json` file in
21-
the `.minecraft/config/essentialad/` folder. This allows adding extra partner mods for testing.
22-
Use the current [production](https://api.essential.gg/v1/mod-partner) or
23-
[staging](https://api.lon-dev.modcore.dev/v1/mod-partner) API response as a starting point.
3+
(TODO insert wiki link)

0 commit comments

Comments
 (0)