https://github.com/devuuuxd/vibesync

Vc Status is a simple library for managing custom statuses in Discord Voice Channels. Easily set and update your channel statuses to keep your server engaging and organized.
https://github.com/devuuuxd/vibesync

Last synced: about 13 hours ago
JSON representation

Vc Status is a simple library for managing custom statuses in Discord Voice Channels. Easily set and update your channel statuses to keep your server engaging and organized.

• Host: GitHub
• URL: https://github.com/devuuuxd/vibesync
• Owner: devuuuxd
• License: mit
• Created: 2024-08-27T17:12:57.000Z (28 days ago)
• Default Branch: main
• Last Pushed: 2024-08-28T17:05:02.000Z (27 days ago)
• Last Synced: 2024-09-24T12:03:52.835Z (about 16 hours ago)
• Language: JavaScript
• Size: 15.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# VibeSync

`VibeSync` is a Node.js library designed to update the status of a Discord voice channel. This library simplifies the process of setting custom statuses for voice channels using the Discord API.

## Installation

To install `VibeSync`, run:

```bash

npm install VibeSync

```

# Usage

## Importing and Setup

First, you need to import the VCStatus class and initialize it with your Discord bot client.

```js

const { Client, GatewayIntentBits } = require('discord.js');

const { VibeSync } = require('VibeSync');

const client = new Client({

    intents: [

        GatewayIntentBits.Guilds,

        GatewayIntentBits.GuildVoiceStates,

        GatewayIntentBits.GuildMessages,

        GatewayIntentBits.MessageContent

    ]

});

const vcStatus = new VibeSync(client);

```

## Updating Voice Channel Status

Use the `updateVoiceChannel` method to set a custom status for a specific voice channel.

```js

    const channelId = 'CHANNEL_ID_HERE';  

    const status = 'CUSTOM_STATUS_HERE';

    vcStatus.setVoiceStatus(channelId, status)

        .then(() => console.log('Voice channel status updated successfully'))

        .catch(err => console.error('Failed to update voice channel status:', err));

```

# Example

## Here’s a complete example demonstrating how to use `VibeSync`:

```js

const { Client, GatewayIntentBits } = require('discord.js');

const { VibeSync } = require('VibeSync');

const client = new Client({

    intents: [

        GatewayIntentBits.Guilds,

        GatewayIntentBits.GuildVoiceStates,

        GatewayIntentBits.GuildMessages,

        GatewayIntentBits.MessageContent

    ]

});

const vcStatus = new VibeSync(client);

client.once('ready', () => {

    console.log(`Logged in as ${client.user.tag}!`);

    const channelId = 'CHANNEL_ID_HERE';  

    const status = 'CUSTOM_STATUS_HERE';

    const channel = client.channels.cache.get(channelId);

    if (!channel) {

        console.error('Voice channel not found');

        return;

    }

    vcStatus.setVoiceStatus(channelId, status)

        .then(() => console.log('Voice channel status updated successfully'))

        .catch(err => console.error('Failed to update voice channel status:', err));

});

client.login('TOKEN_HERE');

```

# Error Handling

## The updateVoiceChannel method handles errors by differentiating between:

- API Errors: Errors received from the Discord API.

- No Response: Cases where no response is received from the API.

- Request Setup Errors: Issues with setting up the request.

- Errors are logged with color-coded messages using chalk.

  

# Contributing

## Feel free to contribute to `VibeSync` by submitting issues or pull requests. Your contributions are welcome!

# License

## `VibeSync` is licensed under the MIT License. See the LICENSE file for more information.

### Feel free to adjust the examples and instructions according to your specific requirements. Let me know if you need any changes or additional details!