Skip to content
This repository has been archived by the owner on Jun 16, 2021. It is now read-only.

Nukestye/Zodiac

Repository files navigation

Zodiac bot

Issues License Version

Information

This is my first discord bot, therefore be wary of any issues that may arise from my code. Also, be sure to let me know about those issues.

Zodiac Discord Bot is used for mainly moderation. Its current features are as follows:

Moderation Commands Explanation
Ban Bans mentioned user and gives a report to the report channel.
Kick Kicks mentioned user and gives a report to the report channel.
Lock Locks & unlocks the channel to only read-only, Only those who have staff role are allowed to type.
Poll Starts a poll with two options with @everyone.
Add Role Adds mentioned role to mentioned user if not assigned.
Remove Role Removes mentioned role from a mentioned user.
Ticket System A way to contact @Staff users. Provides a channel where the issue can be discussed.
Clear Clears x number of messages in the channel.
Mute & Unmute Mutes mentioned user if not muted. Unmute mentioned user if muted.
Announcement Makes an announcement in the channel mentioned with a @everyone.
There are some public commands included, such as Youtube search, memes, avater and info.

Installation

The process of installing and hosting the bot is simple.

Please make sure you have the required Dependencies installed, npm install to install any that you do not have.

[Step 1:]

     Clone the repo into a new folder, and open command line and type npm install.

[Step 2:]

     Fill out the credentials in config.json.

[Step 3:]

     Run the command line inside the folder and type the following command: node main.js
The bot should launch, if not then retrace your steps to see if you missed any credentials. If not then please open up an Issue where I'll help you fix your setup.