Skip to content

Commit

Permalink
Merge branch 'fabric/1.21' of https://github.com/KessokuTeaTime/Night…
Browse files Browse the repository at this point in the history
…-Auto-Config into fabric/1.21
  • Loading branch information
KrLite committed Jul 10, 2024
2 parents cbe545c + c0204a6 commit 4e34d0d
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
### <p align=right>[`` CurseForge](https://www.curseforge.com/minecraft/mc-mods/night-auto-config)&ensp;[`` Modrinth](https://modrinth.com/mod/night-auto-config)</p>
### <p align=right>[`` JitPack](https://jitpack.io/#KessokuTeaTime/Night-Auto-Config)&emsp;[`` CurseForge](https://www.curseforge.com/minecraft/mc-mods/night-auto-config)&ensp;[`` Modrinth](https://modrinth.com/mod/night-auto-config)</p>

# Night Auto Config

Serialize everything! **Night Auto Config** is a **[Night Config](https://github.com/TheElectronWill/Night-Config)** integration for **[Auto Config (now embedded in Cloth Config).](https://modrinth.com/mod/cloth-config)**

## Implementation

**Night Auto Config** introduces a `NightConfigSerializer` to satisfy **Auto Config**'s requirement of a serializer's implementation. You can choose from all the available config formats of **Night Config,** and use the serializer just as other common serializers, even along with a `PartitioningSerializer`.

It is recommended to use [`JitPack`](https://jitpack.io/#KessokuTeaTime/Night-Auto-Config/1.0.0-fabric1.21) to implement **Night Auto Config** into your project.
It is recommended to use **[JitPack](https://jitpack.io/#KessokuTeaTime/Night-Auto-Config)** to implement **Night Auto Config** into your project.

<details>

Expand All @@ -20,7 +22,7 @@ repositories {
}
dependencies {
implementation include("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version")
modImplementation include("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version")
}
```

Expand All @@ -44,7 +46,7 @@ repositories {
}

dependencies {
implementation("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version")
modImplementation("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version")
include("com.github.KessokuTeaTime:Night-Auto-Config:$project.nightautoconfig_version")
}
```
Expand All @@ -60,6 +62,8 @@ nightautoconfig_version={latest}
> [!NOTE]
> You should replace `{latest}` with the latest [`tag name`](https://github.com/KessokuTeaTime/Night-Auto-Config/tags) of **Night Auto Config.**
## Usage

Here's a brief example:

`MyConfig.java`
Expand Down

0 comments on commit 4e34d0d

Please sign in to comment.