VRFamo

This is best viewed on our documentation website https://vrfamo.com/Discord-Bot/

(sorry this looks like a wall of text) Introduction

Welcome to the VRFamo Bot documentation. This guide will explain all of the options with the bot and how to use them we suggest taking a read before running the /setup command Click me to invite the bot to a server Note: The bot will require certain permissions to function correctly. Ensure it has the necessary roles and permissions in your server.

All of these features can be enabled or disabled during the setup process using the /setup command, which can be re-run at any time to update the configuration. 🎂 Birthday Features

Manage and celebrate birthdays across all servers where the bot is present.

This command allows users to set their birthday, which will be celebrated automatically by the bot. These will sync between other servers where the bot is active. If a user has been set up on another server it will also work in your server.

/set-birthday - Set your own birthday (DD/MM format: Day/Month)

This command can be re-run to update the date if you would like Birthdays are announced automatically in the channel you pick during the set up

Blacklist Features

Protect your server by detecting and managing blacklisted users.

This feature uses a list of known users who have been removed from the VRFamo Server for various reasons it does not automatically ban them however it will send a notification to the log channel you set, this notification will provide a brief description as to why they were added to the blacklist.

/check-blacklist - Check for blacklisted users in this server (Admin only) Auto Ban/Detect

When a blacklisted user joins, you will be notified in the logs channel Any users with administrator permissions can use the ban button on the notification

Adding to the Blacklist

To get some one added to the blacklist you can either log a ticket on the VRFamo Server with evidence of their misbehavior or message me directly about it on Discord (Snowy708) Note: The blacklist is maintained by the VRFamo Staff team and is subject to change. Users may be added or removed based on their behavior.

If you believe a user has been mistakenly blacklisted, please contact a member of the VRFamo Staff team for review.

Verification Features

This feature is to help mitigate against server raids and keep bots away from the server.

/preview_verification_messages - Preview the DMs sent to users (Admin only)

/notify-unverified - Send DMs to unverified users (Owner only, one-time)

This is to aid in the setup of the verification system

/assign-nonverified - Assign all people without the verified (@verified) role the non-verified role (@not verified) (Admin only)

/verify - Assign yourself the verified role (@verified)

We recommend setting up a dedicated verification channel where new members can run the /verify command to gain access to the rest of the server. While also restricting their access to all other channels until they are verified.(at least not letting them message in any channels) Note: Make sure to set up the roles and channels properly during the setup process to ensure smooth operation of the verification system. Reaction Roles

This will allow users to assign themselves roles by reacting to a specific message.

/setup_reaction_roles <message_id> <add_role> [remove_role]

/list_reaction_roles - List all reaction roles set up in this server

/remove_reaction_role - Remove a specific reaction role (you will need to use the /list_reaction_roles command to find the index)

The bot will have to have a role above the roles you want it to assign/remove within the role hierarchy for this to work properly Note: You can set up multiple reaction roles on the same message by re-running the command with different emojis and roles. (the maximum number of reactions per server has been limited to 15 to prevent spam i may change this in the future)

You may need developer mode enabled within discord to get the message ID

Text-to-Speech (TTS)

This feature lets the bot read messages aloud in a voice channel.

/join-tts - Join your voice channel and start reading messages from the current text channel

/leave-tts - Leave the voice channel and stop text-to-speech

/tts-voice - Change the voice style (10 different options)

TTS only reads messages in the text channel where you ran /join-tts Messages with attachments or links are skipped There is a word filter to prevent inappropriate content being read aloud

Note: Make sure the bot has permission to connect and speak in the voice channel for TTS to work properly.

Please contact Snowy708 for new phrases to be added to the filter

Counting Game

A little fun counting game where users count as high as they can

/setup_counting - Set the counting channel (Admin only)

Once set up this runs itself, there are two game modes: Normal and Forgiveness

Normal mode will reset the count to 1 on the first wrong number

Forgiveness mode will give you 3 chances before resetting fully, each strike you will go back 10

Users count up from 1 in the designated channel Note: To change the counting channel, re-run /setup_counting

Ticket System

A support ticket system using threads inside a channel.

/ticket-setup [role2] [role3] - Configure the ticket system (Admin only)

Role 1 is mandatory, roles 2 and 3 are optional

/ticket - Open a support ticket and choose the support team

/close - Close your ticket thread

Tickets are created as private threads and only visible to you and the support team Support roles get added to the thread automatically Use /close inside the thread once the issue is resolved

Note: Once the setup command is run, it will leave a message in that channel to guide users on how to open a ticket. I would suggest copying this message and customising it for your server, then sending it in that channel yourself

General Commands

Additional commands for bot configuration and management.

/setup - Reconfigure bot settings (Admin only)

/view_config - View current configuration to see what features are enabled or disabled Suggestions for Improvements

If you have any suggestions for new features or improvements, feel free to reach out on the VRFamo Discord server or contact me directly on Discord (Snowy708).