1.0.4 • Published 11 months ago

makima-anticrash v1.0.4

Weekly downloads
-
License
MIT
Repository
-
Last release
11 months ago

Makima AntiCrash System

Makima

Overview

Welcome to the Makima AntiCrash System, a powerful anti-crash solution for your Discord bots, inspired by the enigmatic Makima from Chainsaw Man. This package provides robust error handling and logging to ensure the stability of your bot.

Features

  • Error Handling: Catches unhandled rejections and exceptions.
  • Customizable Logging: Enable or disable console and webhook logging.
  • Makima-Themed Embeds: Stylish embeds with a unique Makima aesthetic.
  • Test Capabilities: Easily trigger test errors and warnings.

Installation

To get started with the Makima AntiCrash System, install it using npm:

npm install makima-anticrash

Usage

Basic Setup

To integrate the Makima AntiCrash System with your Discord bot, use the following code snippet:

const { Client } = require('discord.js');
const MakimaAntiCrash = require('makima-anticrash');

const client = new Client();
const webhookUrl = 'YOUR_WEBHOOK_URL'; // Replace with your actual webhook URL

new MakimaAntiCrash(client, webhookUrl, {
    disableConsoleLogging: false,
    disableWebhookLogging: false,
    embedColor: 0xFF5733, // Custom error embed color
    testEmbedColor: 0x00FF00, // Custom test embed color
    errorTitle: "💥 Critical Error",
    warningTitle: "⚠️ Warning",
    testTitle: "Makima's Embrace",
    testDescription: "Makima's protective aura shields you from chaos.",
    footerText: "Makima's gaze pierces through chaos...",
    testFooterText: "Your eternal contract is sealed..."
});

client.login('YOUR_BOT_TOKEN'); // Replace with your actual bot token

Configuration Options

You can customize the behavior of the Makima AntiCrash System using the following options:

  • webhookUrl: (String) URL of the webhook for logging errors.
  • disableConsoleLogging: (Boolean) Set to true to disable console logging.
  • disableWebhookLogging: (Boolean) Set to true to disable webhook logging.
  • embedColor: (Number) Custom color for error embeds.
  • testEmbedColor: (Number) Custom color for the test embed.
  • errorTitle: (String) Title for error embeds.
  • warningTitle: (String) Title for warning logs.
  • testTitle: (String) Title for the test embed.
  • testDescription: (String) Description for the test embed.
  • footerText: (String) Footer text for error embeds.
  • testFooterText: (String) Footer text for the test embed.

Example Commands

Triggering a Test Error

const makimaAntiCrash = new MakimaAntiCrash(client, webhookUrl);
makimaAntiCrash.triggerTestError();

Triggering a Test Warning

const makimaAntiCrash = new MakimaAntiCrash(client, webhookUrl);
makimaAntiCrash.triggerTestWarning();

Advanced Usage

The package also provides methods for manual error and warning triggering. This can be useful for testing or simulating conditions that might cause your bot to crash.

// Trigger a test error
makimaAntiCrash.triggerTestError();

// Trigger a test warning
makimaAntiCrash.triggerTestWarning();

Contributing

Contributions are welcome Please fork the repository and submit a pull request with your changes. For major changes, please open an issue to discuss what you would like to change.

License

Distributed under the MIT License. See LICENSE for more information.

Contact

  • Author: bre4d77

Feel free to reach out if you have any questions or need assistance with the Makima AntiCrash System!

1.0.4

11 months ago

1.0.2

11 months ago

1.0.1

11 months ago

1.0.0

11 months ago