Upstream/mcstructs-viafier
1
0
Fork 0
mirror of https://github.com/ViaVersion/mcstructs-viafier.git synced 2025-01-04 18:28:00 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Nassim Jahnke 2024-12-10 10:06:17 +01:00
parent f7d323b198
commit 3dee74c23c
No known key found for this signature in database
GPG Key ID: EF6771C01F6EF02F
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,13 +1,26 @@
Replaces mcstruct's inbuilt nbt library with ViaNBT. Replaces mcstruct's inbuilt nbt library with ViaNBT.
## Setup ## Setup
```bash ```bash
git submodule update --init git submodule update --init
``` ```
Then you can run the Python script to apply the automated updates. Then you can run the Python script to apply the automated updates.
```bash ```bash
py mcstructs.py py mcstructs.py
cd MCStructs cd MCStructs
gradlew test -x checkstyleMain gradlew test -x checkstyleMain
``` ```
## Dependency
We wouldn't necessarily recommend depending on this given the hacky replacements
and specific needs, but this is published to our maven repository at: https://repo.viaversion.com
```kotlin
implementation("com.viaversion.mcstructs:text:5-<mcstructs version>")
```
The prefix is the current major version of ViaVersion, followed by the mcstructs version.