Note
This project is not officially endorsed by The Insomniacs.

🎩 About 🎩

Clothier is a Figura API that allows you to access Manic and Sanguine data like the world's Blood Moon status or your Sanity value.

🛠️ Installation 🛠️

Client

• Download the GSServerNet script and put it in your Figura avatar's folder.
• Download the Clothier script and put it in the same folder.

Server

• Download the GSServerNet datapack and put it in your world's datapacks folder.
• Download the Clothier datapack and put it in the same folder.

📘 Usage 📘

Important
You must enable Chat Messages in your Figura Settings tab in order for GSServerNet to work.

Start by importing the API into your avatar's script file.

script.lua

local clothier = require("Clothier")

Using the clothier variable you can:

• Run a function when all Manic and Sanguine data has been initialized.

clothier.event.init(function()
    print(clothier.sanity())
    print(clothier.is_blood_moon())
end)

• Run a function every time your Sanity value changes.

clothier.event.sanity_change(function(value)
    print("Your current Sanity is: " .. value)
end)

• Get your current Sanity value.

print(clothier.sanity())

Note
Sanity values are represented as integers from -10 to 10, with -10 being max Lunacy, and 10 being max Sanity.

• Run a function every time the world's Blood Moon status changes.

clothier.event.blood_moon_change(function(state)
    print("The world's Blood Moon state is: " .. tostring(state))
end)

• Get the world's Blood Moon status.

print(clothier.is_blood_moon())