plusbots
v1.3.1
Published
```markdown # PlusBots Documentation
Downloads
6
Readme
# PlusBots Documentation
`PlusBots` is a custom client management library designed to facilitate the running and management of Discord bots using the `discord.js` library. This library is compatible with all versions of `discord.js`.
## Requirements
- Node.js
- discord.js
- fs module
## Installation
1. Install Node.js if not already installed.
2. Install `discord.js` and `fs` using npm:
```bash
npm install discord.js fs
Usage
1. Import the library and create an instance
const PlusBots = require('plusBots');
const { Client } = require('discord.js');
// Function to create a new bot client
function createPlusClientFunction(token, options) {
const client = new Client(options);
client.login(token);
return client;
}
const plusBots = new PlusBots(createPlusClientFunction);
2. Add a new client
To add a new client using a token:
plusBots.addPlusClient('YOUR_DISCORD_BOT_TOKEN');
3. Start all clients
To start all added clients:
plusBots.startPlusBots();
4. Stop a specific client
To stop a specific client:
plusBots.stopPlusBot('YOUR_DISCORD_BOT_TOKEN');
5. Stop all clients
To stop all running clients:
plusBots.stopAllClients();
6. Restart a specific client
To restart a specific client:
plusBots.restartPlusBot('YOUR_DISCORD_BOT_TOKEN');
7. Restart all clients
To restart all clients:
plusBots.restartAllClients();
8. Update client creation function
To update the client creation function and apply it to an existing client:
function newCreatePlusClientFunction(token, options) {
const client = new Client(options);
client.login(token);
return client;
}
plusBots.updatePlusClient('YOUR_DISCORD_BOT_TOKEN', newCreatePlusClientFunction);
9. Get a list of clients
To get the list of current clients:
const clients = plusBots.getClients();
console.log(`Number of clients: ${clients.count}`);
Log File
All operations are logged in the bot.log
file.
Notes
- Compatible with all versions of
discord.js
. - Additional settings can be provided via
clientOptions
specified for each client upon creation.