Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 3.26 KB

README.md

File metadata and controls

40 lines (27 loc) · 3.26 KB

Fabric Server Administration Mod

About

This mod (Sewing Machine Utilities) is just something I've been working on in my free time. I <3 coding & Minecraft

Sewing Machine is a server-side mod for server administration, built for the Fabric loader. A sewing machine stitches fabric the same way this mod sews Minecraft chunk protection together, thus the mod name "SewingMachine". The original intent of the mod was simply to provide chunk claiming, but I had a lot of fun playing around with what I could extend in a server mod, and added many other quality of life features.

  • Current versions require a MySQL database, but SQLite is planned for the future.
  • Fabric API is also required

Using the Mod

Understanding what each property in the config.json file does may be difficult to infer simply from looking at the config. JSON doesn't offer room for comments, so the properties are instead documented on Curse.

Additional documentation can also be found on the Curse page

In-game Guides

This mod adds the ability to hand out pre-written books via Sign interaction. Custom books can be implemented by adding to the "books.json" example in the repo's root directory. This file is not generated by the mod, and must be added to your /config/sewing-machine folder

If you have an IDE or Text Editor that supports the JSON Schema, there is also an included schema books_schema.json

Server-side Translations

Minecraft supports translations via translation keys, however the server is unable to define new translation keys to the client ..so I improvised. The server keeps track of connected clients languages, and from that bit of information I was able to create language files that, when read, are sent as Literals to each player. Because of this issue, adding translations was an after though, and some messages may be missing from the translations files.

If you want to add a translation, submit a PR.

Downloading

To get the latest version of the mod, you can download from one of the following sources