Skip to content

Commit

Permalink
Merge pull request #29 from tanmaypardeshi/Cray'sReadMeUpdates
Browse files Browse the repository at this point in the history
Cray's read me updates
  • Loading branch information
ExtremeMachine12 authored Oct 21, 2023
2 parents 8ee2cab + 4f9374f commit 00d4dbf
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ When a user runs command !rank, it shows the user their own rank, XP and level o

<hr />

<h4>Interactive Greetings: Elevating the Welcome Message with Important Links</h4>
This feature guarantees that whenever a new member joins, they are greeted with a warm and inclusive welcome message that not only extends a friendly reception but also provides them with all the necessary and significant links to get started and navigate the guild effectively.
<p align="left"><img width=65% src="https://github.com/tanmaypardeshi/CSC-510-Project2-TeachersPetBot/assets/144291380/ddfeec14-211a-4a74-aed1-7f66f0d13d88"></p>


<a name="instrun"></a>
<h2> Installation and Running </h2>
Expand Down
22 changes: 22 additions & 0 deletions docs/expansion_WelcomeMessage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# About !expansion_Welcome Message
This feature ensures that every new member is greeted with a comprehensive welcome message, including all the important links.

# Location of Code
The code that implements the above mentioned gits functionality is located [here](https://github.com/tanmaypardeshi/CSC-510-Project2-TeachersPetBot/src/bot.py).

# Code Description
## Functions

- def on_member_join(member):
is the start of a function in a Discord bot. It's an event handler that gets triggered when a new member joins a server, allowing you to specify actions the bot should take in response, such as sending a welcome message or performing other tasks related to the new member.

# How to run it? (Small Example)
When a new member joins our server, they'll receive a warm welcome along with a collection of important links, enhancing their user experience and simplifying their journey.

### Discord Bot Welcome Message and Important Links

This code defines a Discord bot event handler that triggers when a new member joins a server. It sends a welcoming message to the new member and dynamically fetches important links from the 'important-links' channel, incorporating them into the message. This enhances the user experience by providing immediate access to essential resources and information upon joining the server.

Successful execution will show the welcome messaage with important links.

<p align="left"><img width=65% src="https://github.com/tanmaypardeshi/CSC-510-Project2-TeachersPetBot/assets/144291380/ddfeec14-211a-4a74-aed1-7f66f0d13d88"></p>

0 comments on commit 00d4dbf

Please sign in to comment.