Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updated README file and add structured table of content + add each co… #39

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
699 changes: 661 additions & 38 deletions README.md

Large diffs are not rendered by default.

127 changes: 127 additions & 0 deletions commands/FUN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@
# Fun Commands

This section contains a set of fun commands that allow you to enjoy various activities with the bot. These commands are designed to add some entertainment and humor to your server.

## Table of Contents

- [tweet](#tweet)
- [dadjoke](#dadjoke)
- [photo](#photo)
- [advice](#advice)
- [bigtxt](#bigtxt)

---

## tweet

**Description:** You can tweet as someone else to troll others.

**Usage:**

/tweet account:{account} text:{text}


**Parameters:**
- `account` (required): Enter the tweeter user's account.
- `text` (required): The content of your tweet.

**Functionality:**
- Allows you to create a tweet with a specified Twitter account and text.
- Generates an image of the tweet using the provided information.
- Embeds the tweet image in a message and replies to the user.

**Examples:**
1. `/tweet account:Brainy text:This is a hilarious tweet!`
- This command creates a tweet from the "Brainy" account with the text "This is a hilarious tweet!" and displays the tweet image.

---

## dadjoke

**Description:** Get a dad joke from a funny bot :)

**Usage:**

/dadjoke


**Functionality:**
- Retrieves a random dad joke from a collection of jokes.
- Creates a message embed with the dad joke and additional information.
- Replies to the user with the dad joke and bot information.

**Examples:**
1. `/dadjoke`
- This command retrieves and provides a random dad joke from the bot.

---

## photo

**Description:** Get a photo from pixels.com

**Usage:**

/photo [query:{search query}]


**Parameters:**
- `query` (optional): The search query (e.g., "nature," "ocean," "tigers," "pears," etc.). If not provided, the default query is "nature."

**Functionality:**
- Retrieves a photo from pixels.com based on the provided or default search query.
- Creates a message embed with the photo and additional information.
- Replies to the user with the photo and bot information.

**Examples:**
1. `/photo`
- This command retrieves and provides a random photo from pixels.com with the default search query, "nature."

2. `/photo query:tigers`
- This command retrieves and provides a random photo of tigers from pixels.com.

---

## advice

**Description:** Get an advice from a wise bot :)

**Usage:**

/advice


**Functionality:**
- Generates a random piece of advice from the wise bot.
- Creates a message embed with the advice and additional information.
- Replies to the user with the advice and bot information.

**Examples:**
1. `/advice`
- This command generates and provides a random piece of advice.

---

## bigtxt

**Description:** Write Big Text

**Usage:**

/bigtxt text:{text}


**Parameters:**
- `text` (required): The word or text you want to display in big text format.

**Functionality:**
- Converts the provided `text` into a big text format by replacing each character with a corresponding emoji.
- The big text is then displayed as reactions.

**Examples:**
1. `/bigtxt text: hello`
- This command converts the word "hello" into big text format using emojis and displays it as reactions.

---

Feel free to explore and have fun with these commands. They are designed to add some entertainment to your server and provide a good laugh!
82 changes: 82 additions & 0 deletions commands/GENERAL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# General Commands

This section contains a set of general commands that provide various functionalities in a Discord server. These commands serve different purposes, including checking the bot's ping, creating interactive polls, and managing the GDG Algiers spot.

## Table of Contents

- [ping](#ping)
- [poll](#poll)
- [is_spot_open](#is_spot_open)
- [open_spot](#open_spot)

---

## ping

**Description:** Get the bot's ping.

**Usage:**

/ping

**Functionality:**
- Provides information about the bot's API latency and message latency, helping users determine the bot's responsiveness.

**Examples:**
1. `/ping`
- This command retrieves and provides information about the bot's latency.

---

## poll

**Description:** Create a poll where members can vote.

**Usage:**

/poll question="Your question" options="Option 1, Option 2, ..."

**Functionality:**
- Allows users to create polls with questions and multiple options, enabling members to vote and interact with the poll using buttons.

**Examples:**
1. `/poll question="What's your favorite color?" options="Red,Blue,Green"`
- This command creates a poll with the question "What's your favorite color?" and options "Red," "Blue," and "Green."

---

## is_spot_open

**Description:** Check if the GDG Algiers spot is open.

**Usage:**

/is_spot_open

**Functionality:**
- Provides information about the current status of the GDG Algiers spot, indicating whether it's open or closed.

**Examples:**
1. `/is_spot_open`
- This command checks and provides the current status of the GDG Algiers spot.

---

## open_spot

**Description:** Open or close the GDG Algiers spot.

**Usage:**

/open_spot

**Functionality:**
- Allows authorized users to toggle the status of the GDG Algiers spot between open and closed, with interactive buttons for easy control.

**Examples:**
1. `/open_spot`
- This command allows authorized users to change the status of the GDG Algiers spot.

---

These general commands provide various functionalities in your Discord server, enhancing interaction and management.
30 changes: 30 additions & 0 deletions commands/HELP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Help Commands

This section contains a set of commands related to providing help and information to users in your Discord server. The "help" command is a key feature in this category, allowing users to access information about available commands.

## Table of Contents

- [help](#help)

---

## help

**Description:** Display a list of available commands for this user.

**Usage:**

/help

**Functionality:**
- Generates a list of available commands organized by categories.
- Displays standard commands from categories like "fun," "general," and more.
- Includes additional commands for users with specific roles, such as "Lead," "moderator," "Co-Manager," or "owner."

**Examples:**
1. `/help`
- This command displays a list of available commands based on categories and user roles.

---

The "help" command provides a helpful overview of available commands, making it easier for users to discover and access the bot
36 changes: 36 additions & 0 deletions commands/MODS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Mods Commands

This section contains a set of commands specifically designed for moderators and administrators in your Discord server. These commands provide advanced functionality for managing and maintaining your server.

## Table of Contents

- [announce](#announce)

---

## announce

**Description:** Announce a message in a specific channel.

**Usage:**

/announce channel_name:{channel_name}

**Parameters:**
- `channel_name` (required): Name of the channel where you want to make the announcement. (Available channel types: Text and News)

**Functionality:**
- Allows moderators and administrators to make announcements in a specific channel.
- Moderators can specify the target channel for the announcement.
- The announcement can include text content and images attached in a single message.
- Generates an embed with the attached image and the specified text.
- Sends the announcement to the specified channel with GDG Algiers branding.
- Notifies the user once the announcement is successful.

**Examples:**
1. `/announce channel_name:general`
- This command announces a message in the "general" channel.

---

The "announce" command empowers moderators and administrators to efficiently make announcements in designated channels, enhancing server communication and information sharing.
76 changes: 76 additions & 0 deletions commands/OWNER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Owner Commands

This section contains a set of commands exclusively available to the owners or administrators of the Discord bot. These commands provide powerful tools for managing and controlling the bot's behavior.

## Table of Contents

- [embed](#embed)
- [say](#say)
- [shutdown](#shutdown)

---

## embed

**Description:** The bot will say anything you want, but within embeds.

**Usage:**

/embed args:{text}

**Parameters:**
- `args` (required): The text you want the bot to say within an embed.

**Functionality:**
- Exclusive to bot owners, this command allows you to create an embed with the specified text content.
- The embed is displayed in the channel, with customization options such as color and title.
- Enhances the visual presentation of messages within the server.

**Examples:**
1. `/embed args:This is an important announcement!`
- This command creates an embed with the text "This is an important announcement!" for the bot owners to share in the server.

---

## say

**Description:** The bot will say anything you want.

**Usage:**

/say args:{text}

**Parameters:**
- `args` (required): The text you want the bot to say.

**Functionality:**
- Reserved for bot owners, this command enables you to make the bot send a message with the specified text content.
- The bot repeats the provided text in the server channel.
- A useful tool for administrators to communicate important messages.

**Examples:**
1. `/say args:Hello, everyone!`
- This command makes the bot say "Hello, everyone!" in the server channel for the bot owners.

---

## shutdown

**Description:** Shutting down. Bye! :wave:

**Usage:**

/shutdown

**Functionality:**
- Exclusively available to bot owners, this command initiates the shutdown process for the bot.
- The bot replies with a farewell message and proceeds to shut down.
- An essential command for administrators to control the bot's operation.

**Examples:**
1. `/shutdown`
- This command triggers the bot's shutdown process with a farewell message for the bot owners.

---

These owner commands provide powerful tools for the administrators or owners to manage the bot, send customized messages, and control the bot's operation within the server.
Loading