Want to build a feature? Awesome!

Making your own module is pretty easy. Here's a quick guide to get you started.

1. Get the Code

First, you'll need to get the project on your computer. You can do this with Git.

git clone https://github.com/veriepicc/Serenity-Bloxd.git
cd Serenity-Bloxd
npm install

2. Start the Builder

Run this command in your terminal. It will watch for any changes you make and automatically rebuild the script.

npm run watch

3. Create a Module

Modules are just little bits of code that add features. They all live in the src/modules/ folder. Just create a new .js file in a category folder (like visual or combat). Here is a basic example:

const MyAwesomeModule = {
    name: 'MyAwesomeModule',
    category: 'Utility',
    description: 'This is what my new feature does!',
    enabled: false, 

    onEnable(manager) {
        console.log('My module is on!');
    },

    onDisable(manager) {
        console.log('My module is off!');
    }
};

export default MyAwesomeModule;

Don't forget to add your new module to the list in src/ModuleManager.js so it shows up in the game!

4. Share Your Creation

When you're done, you can send us your new feature on our GitHub page by opening a Pull Request. We'd love to see what you make!