Skip to content

Commit

Permalink
Awesome readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ZeroDiscord committed Nov 17, 2021
1 parent 1bb835c commit ecc2402
Show file tree
Hide file tree
Showing 2 changed files with 74 additions and 30 deletions.
103 changes: 74 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,83 @@
# Welcomer <img src="https://raw.githubusercontent.com/MartinHeinz/MartinHeinz/master/wave.gif" width="30px">
**A welcomer bot for discord written in discord.js v12 very simple to use with code and deployment instructions!**
## **This Welcomer bot was created by 0_0#6666**

### To deploy the bot follow the instructions documented below:
- If you want a simple welcomer obtain a token from [here](https://discord.com/developers)
#### __Note__: Make sure to enable privilleged gateway intents! (Member Intents In The Portal)
![alt text](https://zerosnap.000webhostapp.com/2faykzzg.gif)
#### - Replace it in [Index.js](https://github.com/ZeroDiscord/Welcomer/blob/main/Index.js) make sure its between the **(" ")**
![alt text](https://zerosnap.000webhostapp.com/64os6q5i.gif)
#### - Make a channel named welcome in your server and invite the bot after hosting it!
![alt text](http://zerosnap.000webhostapp.com/jc6q9d85.png)
- Host via **__Glitch__** or **__repl.it__** from links below!
# Links
- 🔗 [Youtube Channel](https://www.youtube.com/channel/UCF9E-xef9jL9QgziZRDHKKQ)
**A discord welcomer bot developed in discord.js v13 that is very simple to use and comes with code and deployment instructions!**
## Links
- ### This Welcomer Bot Was Created by [ZeroSync](https://youtube.com/c/ZeroSync/)
- [Youtube Channel](https://www.youtube.com/c/ZeroSync)
- [Support Server Link](https://discord.gg/ARu4hr6hJw)
# Copyright
Copyright 2021 © All RIghts are Reserved | If you are using any part of code please give me credits for the same. Thanks
## Licensed Under
### Creative Commons Zero v1.0 Universal
[View the license here](https://github.com/ZeroDiscord/Welcomer/blob/master/LICENSE)
#### Copyright 2021 © All Rights are Reserved

# License
**Creative Commons Zero v1.0 Universal**
[View the license here](https://github.com/ZeroDiscord/Welcomer/blob/main/LICENSE)
## Hosting

**NOTE FOR GLITCH HOSTERS
``This bot dies if there is no member joins in a 5 minute interval. If you would like to prevent this DM me on discord 0_0#6666``**
``Hosting on repl.it may cause some errors join support server to obtain help``
> ⚠ This bot needs a [Node.js v16+](https://nodejs.org/en/blog/release/v16.0.0/) runtime to function since discord.js version 13 requires said node version to function.
# Host On Repl.it
[![Use on Repl.it](https://repl.it/badge/github/ZeroDiscord/EconomyBot)](https://repl.it/github/ZeroDiscord/Welcomer)
# Host On Glitch
[Click Here to Host On Glitch](https://glitch.com/edit/#!/import/git?url=https://github.com/ZeroDiscord/Welcomer/)
### [Host On Repl.it](https://repl.it/github/ZeroDiscord/Welcomer)
### [Remix On Glitch](https://glitch.com/edit/#!/import/github/ZeroDiscord/Welcomer)

# Dependencies
**Aliter**

### Step 1: Install the Dependencies:
Linux
```sh
apt install nodejs npm -y
curl -sL https://deb.nodesource.com/setup_16.x -o nodesource_setup.sh
chmod 777 nodesource_setup.sh
./nodesource_setup.sh
apt install nodejs -y
npm install

```
Windows
```sh
# https://nodejs.org/en/blog/release/v16.0.0/ get node.js
npm install
```

### Step 2: Obtain a Bot Token From [Here](https://discord.com/developers) <br> <br>
<b>


### Step 3 : Replace the Token in [config.json](https://github.com/ZeroDiscord/Welcomer/blob/master/config.json) <br>
#### That's all! We Are Done! Now Simply host the Bot!

### Run with node
```sh
node index.js
```
### Run with pm2
```sh
npm install -g pm2@latest
pm2 start --name "Welcomer" index.js --watch
```

#### __Note__: Make sure to enable privilleged gateway intents! (Member Intent & Message Content Intent In The Developer Portal)
![alt text](https://zerosnap.000webhostapp.com/x42roq0e.gif)


# Features
### Custom Channel For Welcoming Per Server
<br>

![](https://zerosnap.000webhostapp.com/1xsi7h07.gif)

### Custom background image for welcomer per server
<br>

![](https://zerosnap.000webhostapp.com/lfyl5e1w.gif)

### Hassle Free Testing ( Now no more alts! )

![](https://zerosnap.000webhostapp.com/pnb6y14a.gif)


# Core Dependencies
- Discord.js v13.x
- Canvas (for image welcomer) v1.4
- KeyV - Customisable database ( sqlite by default can be connected to any type of database )
- Canvas - For crafting the welcome message
- Canvas - Constuctor - Making my work easy :P
- Weird-to-normal-chars - To Adjust the fonts present around discord to our available fonts in image.
## Need help? Join the [Support Server](https://discord.gg/ARu4hr6hJw)

### © Zero | 0_0#6666 - 2020
### © Zero | 0_0#6666 - 2021
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
"canvas-constructor": "^5.0.1",
"discord.js": "^13.3.1",
"keyv": "^4.0.4",
"moment": "^2.29.1",
"weird-to-normal-chars": "^1.8.0"
},
"devDependencies": {
Expand Down

0 comments on commit ecc2402

Please sign in to comment.