libmykitty
v1.1.0
Published
Library of utility functions for interacting with the Bondage Club mod api.
Readme
${{\color{HotPink}\Large{\textsf{LibMyKitty}}}}$
It gives you a quick setup, so you don't have to start completely from scratch. Think of it like an outline, it's there to help you get started a little faster. It's a great way to get building your own addon.
Installation
npm install libmykitty
// or
yarn add libmykitty
// or
pnpm add libmykittyLibMyKitty provides a set of tools to help mod developers create and manage their modifications. Here's a summary of its key features:
Mod Initialization: The
initMyKittyfunction allows developers to easily register their mod with the game, ensuring it's recognized and can function correctly. Without needing to install the bondage-club-mod-sdk.Event Handling: Functions like
AtLoginenable developers to execute code when specific events occur, such as when a player logs in.Communication: The library provides sending data between players and the server through functions like
sendModEventandregisterModListener, allowing for the exchange of custom messages.Data Management: The
createModStorageManagertool provides a structured way to store and manage mod data, including saving and synchronizing information.Error Reporting: The
CreateWebhookfeature allows developers to receive error notifications, which can help in identifying and fixing issues.Character Interaction: Functions like
getCharacterandisAddonPlayerprovide ways to interact with and identify characters within the game environment.Asynchronous Operations: The
waitForandwaitForElementfunctions allow developers to pause code execution until certain conditions are met, ensuring smooth gameplay.
View Quickstart.md for more information on how to get started.
If you are looking for something more documented, check out wiki/Wiki.md
