kyoyu

Kyoyu

> 共有 -> Kyōyū [kʲo̞ːjɯ̟ː]
> ≒ Sharing

Discord server is now open!

This mod shares Schematics with other players.
Litematica and Forgematica support. Inspired by Syncmatica.

This project is still a work in progress, so feel free to send your feature requests or report any issues on GitHub!
Just keep in mind that not everything may be implemented 😄

<font color=#ff223a>Do not report Kyoyu issues to Syncmatica!</font>

<video src="https://github.com/user-attachments/assets/74d1d7f8-9d13-4886-aa26-96ae8849e093" controls="true"></video>

Usage (WIP)

Client Side

1. Install Fabric, Forge, or NeoForge to the instance.
2. Add the Kyoyu Mod and its dependency mods to the Mods folder.
3. Launch!

<font color=#F9AA00>It is possible to join a server without Kyoyu installed using a client with Kyoyu, but you will not be able to use Kyoyu's features!</font>

Server Side

1. Install Fabric, Forge, NeoForge, or Paper to the server.
2. Add the Kyoyu Mod and its dependency mods to the Mods folder.
3. Start the server!

<font color=#F9AA00>It is possible to join a server with Kyoyu installed using a Vanilla client or an instance without Kyoyu, but you will not be able to use Kyoyu's features!</font>

Config

Documentation

Dependencies

| Loader | Client | Server | |---------------|---------------------------------|------------| | Fabric | Malilib, Litematica, Fabric API | Fabric API | | Forge | MaFgLib, Forgematica | | | NeoForge | MaFgLib, Forgematica | |

Versions

| Version | Client | | |｜| Server | | | | |----------------:|:------:|:------:|:-----:|--|:------:|:------:|:------:|:-----:| | | Fabric
<font size="-1">Litematica</font> | Forge
<font size="-1">Forgematica</font> | NeoForge
<font size="-1">Forgematica</font> |｜| Fabric | Forge | NeoForge | Paper | | 1.14 - 1.14.4 | ✅ | ❌ | ❌ |｜| ✅ | ✅ | ❌ | ❌ | | 1.15 - 1.15.2 | ✅ | ❌ | ❌ |｜| ✅ | ✅ | ❌ | ❌ | | 1.16 - 1.16.5 | ✅ | ✅ | ❌ |｜| ✅ | ✅ | ❌ | ❌ | | 1.17 - 1.17.1 | ✅ | ✅ | ❌ |｜| ✅ | ✅ | ❌ | ❌ | | 1.18 - 1.18.2 | ✅ | ✅ | ❌ |｜| ✅ | ✅ | ❌ | ❌ | | 1.19 - 1.19.2 | ✅ | ✅ | ❌ |｜| ✅ | ✅ | ❌ | ❌ | | 1.19.3 - 1.19.4 | ✅ | ✅ | ❌ |｜| ✅ | ✅ | ❌ | ⚠️^[3]| | 1.20 - 1.20.1 | ✅ | ✅ | ❌ |｜| ✅ | ✅ | ❌ | ⚠️^[3]| | 1.20.2 | ✅ | ❌ | ❌ |｜| ✅ | ✅ | ❌ | ⚠️^[3]| | 1.20.3 - 1.20.4 | ✅ | ❌ | ⚠️^[1] |｜| ✅ | ❌ | ⚠️^[1]| ⚠️^[3]| | 1.20.5 - 1.20.6 | ✅ | ❌ | ⚠️^[2] |｜| ✅ | ❌ | ⚠️^[1] | ⚠️^[3]| | 1.21 - 1.21.1 | ✅ | ❌ | ⚠️^[2] |｜| ✅ | ❌ | ⚠️^[1] | ⚠️^[3]| | 1.21.2 - 1.21.3 | ✅ | ❌ | ⚠️^[2] |｜| ✅ | ❌ | ⚠️^[1] | ⚠️^[3]| | 1.21.4 | ✅ | ❌ | ⚠️^[2] |｜| ✅ | ❌ | ⚠️^[1] | ⚠️^[3]|

[1]: Doesn't work
[2]: Cannot join the server
[3]: It launches, but cannot share the schematic

Roadmap (WIP)

• [ ] legacy litematica (Ornithe) support
• [x] Forgematica support
• [ ] Paper plugin support (retry)
• [ ] Client only depend (malilib, litematica)
• [ ] GUI improvements
• [x] Merged jars

Thanks

Inspirations 🔖
⛓️ Syncmatica by nnnik, kpzip, and sakura-ryoko

Uses ⭐
🍤 Unitemplate by topi-banana
🪨 Stonecutter by kikugie
🏗️ Architectury Loom by architectury
🇾 yamlang by Fallen-Breath
🇬 Gson by google

Last README Update 2025/04/02 00:43 UTC+9