To get started, first set up your own Red Discord Bot. Then, run these commands:
[p]repo add coffee-cogs https://github.com/coffeebank/coffee-cogs
[p]cog install coffee-cogs hellohook
This cog does not store any End User Data.
Create your own welcome bot with a custom profile picture! Set the welcome message to be regular text and/or an embed. Comes with usernames, user avatars, pings/mentions, server member counts, and leave messages. Send invite-based welcome messsages, and assign custom roles when new members join with the invite!
To get started, first set up your own Red Discord Bot. Then, run these commands:
[p]repo add coffee-cogs https://github.com/coffeebank/coffee-cogs
[p]cog install coffee-cogs hellohook
This cog does not store any End User Data.
Create your own welcome bot with a custom profile picture! Set the welcome message to be regular text and/or an embed. Comes with usernames, user avatars, pings/mentions, server member counts, and leave messages. Send different welcome messsages based on the invite url! Create different 'bots' using webhooks.
Adding a color is required if you're using embeds.
You can use #222222 as a default. If you don't, Discohook returns null in the JSON, which breaks compatibility. This is a workaround.
When you are done on Discohook:
Then, use the command [p]hellohook setgreet
or [p]hellohook setleave
, and paste the JSON in.
Disclaimer: Discohook is a website that makes creating webhooks easy. Not affiliated with this cog. Image from Unsplash.
https://&&DISPLAYNAME&&
Clyde
)https://&&GLOBALNAME&&
Clyde
)https://&&SERVERCOUNT&&
https://&&SERVERCOUNTORD&&
https://&&USERAVATAR&&
https://&&USERMENTION&&
<@1234567890123456>
-> @Clyde
)https://&&USERNAME&&
clydeuser
)Adding https:// in front is required.
Discohook will not export the needed JSON if it says "Invalid URL" (even though the bot will make them valid at runtime), so this is a workaround.
https://&&USERNAME1234&&
- (2024-04-01) Discord has created a new username system Clyde#1234
)After you save them into the bot, when a new user joins, the variables will be replaced with the new user's info.
Life was once peaceful in the land of Cats. As the land grew, the Cats community decided to run its own bot, named the Cat Lord. The Cat Lord welcomed every cat that passed through its gates.
Then, one day, the land of Dogs found the Cat Lord a very helpful bot. However, the Dogs were not large enough yet to justify running its own bot. Yet, it would be a bad idea all the same to welcome new dogs with a bot named "The Cat Lord".
An agreement was made, and Hellohook was born.
Despite being a single bot, the welcome messages can finally be unique between both lands.
The Cat Lord lives on. The Dog Lord is born.
All live in harmony forevermore.
First, check your Red Bot console, and see if they match any of the errors below:
As of Red 3.5, you may have run into an error No module named requests
. Shut down your Red bot, then run pip install requests
before redbot #####
to start it back up.
For any other module/package, run pip install PACKAGENAMEHERE
.
Afterwards, re-set your hellohook greet/leave message (even with no changes) to force an update.
As of 17 August 2023, this has been patched, but may happen again in the future, and with different modules/packages. If it does, please let me know in the Support Discord or file a GitHub bug report.
If it says send() got an unexpected keyword argument '####'
, please let me know in the Support Discord or file a GitHub bug report.
As of 10 June 2022, this has been patched, but may happen again in the future.
This feature is not recommended. Hellohook does not officially support this feature, since it may be against Discord's ToS.
But, Hellohook is open-source, so you are free to customize the bot by forking the code.
In the code, find the marker MM101, and add the code below:
# (MM101) Add custom parameters here
greetMessageJson["username"] = userObj.display_name
greetMessageJson["avatar_url"] = userObj.display_avatar.url
Hellohook is flexible, but may not be flexible enough for everyone's needs. Hellohook is open-source and encourages you to customize by making tweaks.
master
branch.hellohook
folder here[p]cog uninstall hellohook
[p]repo add coffee-cogs2 https://github.com/USERNAME/coffee-cogs
[p]cog install coffee-cogs2 hellohook
[p]cog update hellohook