Kyoyu

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

This mod shares .litematic files with other players.
Litematica support. Inspired by Syncmatica.

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

Do not report Kyoyu issues to Syncmatica!

Usage (WIP)

Client Side

1. Install Fabric or (Forge)^[1] to the instance.
2. Add the Kyoyu Mod and its dependency mods to the Mods folder.
3. ! This process will no longer be necessary in future updates !
   Create a kyoyu folder in the schematic folder. (~/[instance]/schematic/kyoyu)
4. Launch!

[1]: 1.16.5 Only

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!

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. ! This process will no longer be necessary in future updates !
   Create a kyoyu folder in the server folder and create a files folder in the kyoyu folder. (~/[server]/kyoyu/files)
4. Start the server!

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!

Dependencies

Loader	Client	Server
Fabric	Malilib, Litematica, Fabric API	Fabric API
Forge	Malilib, Litematica

Versions

Version	Client		｜	Server
	Fabric	Forge	｜	Fabric	Forge	NeoForge	Paper
1.14 - 1.14.4	✅	🚫	｜	✅	✅	🚫	🚫
1.15 - 1.15.2	✅	🚫	｜	✅	✅	🚫	🚫
1.16 - 1.16.5	✅	✅[2]	｜	✅	✅	🚫	🚫
1.17 - 1.17.1	✅	🚫	｜	✅	✅	🚫	🚫
1.18 - 1.18.2	✅	🚫	｜	✅	✅	🚫	🚫
1.19 - 1.19.4	✅	🚫	｜	✅	✅	🚫	⚠️[3]
1.20.1 - 1.20.4	✅	🚫	｜	✅	✅	🚫	⚠️[3]
1.20.5 - 1.20.6	✅	🚫	｜	✅	✅	✅	⚠️[3]
1.21 - 1.21.3	✅	🚫	｜	✅	✅	✅	⚠️[3]
1.21.4	✅	🚫	｜	✅	✅	✅	🚫

[2]: This is only compatible with builds published by Litematica
[3]: It launches, but cannot share the schematic.

Features (WIP)

• [x] Error Handling
• [x] Code Format and Review
• [ ] Client only depend (malilib, litematica)
• [ ] legacy litematica support?
• [ ] Forgematica support?
• [ ] Plugin support?

Network

• [x] Handshake Packet
• [x] FileRequest Packet
• [x] FileResponce Packet
• [x] LoadExplorer Packet
• [x] PlacementMeta Packet
• [x] RemovePlacement Packet

Client

• [x] Kyoyu button on placements menu
• [x] Kyoyu in-memory placement
• [x] Server Kyoyu placements explorer
  • [x] Download
  • [x] Load
  • [x] Material List
  • [x] Remove
• [x] Modify
• [x] Unload
• [x] Relogin compatibility
• [x] on Placement Update Event

Server

• [x] Save KyoyuPlacementMeta
• [x] Restore KyoyuPlacementMeta

Data Types

• [x] Pos
• [x] Mirror
• [x] Rotation
• [x] Ignore Entities
• [x] Placement ON/OFF
• [x] Subregion
  • [x] Pos
  • [x] Mirror
  • [x] Rotation
  • [x] Ignore Entities
  • [x] Placement ON/OFF

Thanks

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

Uses ⭐
🪨 Stonecutter by kikugie
🍤 Unitemplate by topi

Last README Update 2025/1/9 22:19 UTC+9</smal>