README.md 3.19 KB
Newer Older
Loïc Bersier's avatar
Loïc Bersier committed
1
# Haha Yes
Loïc Bersier's avatar
Loïc Bersier committed
2

Loïc Bersier's avatar
Loïc Bersier committed
3
A multi function discord bot.
Loïc Bersier's avatar
Loïc Bersier committed
4

Loïc Bersier's avatar
Loïc Bersier committed
5
## Getting Started
Loïc Bersier's avatar
Loïc Bersier committed
6

Loïc Bersier's avatar
Loïc Bersier committed
7
These instructions will get you a copy of the project up and running on your local machine
Loïc Bersier's avatar
Loïc Bersier committed
8

Loïc Bersier's avatar
Loïc Bersier committed
9
### Prerequisites
Loïc Bersier's avatar
Loïc Bersier committed
10

Loïc Bersier's avatar
Loïc Bersier committed
11
You need to install the following
Loïc Bersier's avatar
Loïc Bersier committed
12

13 14

* https://github.com/Automattic/node-canvas
15
* sequelize-cli (``npm install -g sequelize-cli``)
16
* mysql
17
* ffmpeg (Optional but recommanded: for all command that require to interact with voice chat and [vid2gif.js](commands/utility/vid2gif.js), [vidshittyfier.js](commands/fun/vidshittyfier.js) and [ytp.js](commands/fun/ytp.js))
18
* handbrake-cli (Optional but recommanded: for [download.js](commands/utility/download.js))
19
* apngasm (Optional: for [nolight.js](commands/images/nolight))
20 21 22
* [Google credentials](https://cloud.google.com/docs/authentication/getting-started) (Optional: for [tts.js](commands/fun/tts/tts.js) and [ttsvc.js](commands/fun/tts/ttsvc.js), without that it will spam error on startup but not important)
* Wine (Optional: required for linux/mac for [dectalk.js](commands/fun/tts/dectalk.js) and [dectalkvc.js](commands/fun/tts/dectalkvc.js))
* xvfb (Optional: for wine if using headless server)
23 24
* waon (Optional: used to convert sound files to midi for [midify.js](commands/fun/midify.js))
* timidity (Optional: used to convert the midi files back to mp3 for [midify.js](commands/fun/midify.js))
Loïc Bersier's avatar
Loïc Bersier committed
25 26

### Installing
Loïc Bersier's avatar
Loïc Bersier committed
27
```
Loïc Bersier's avatar
Loïc Bersier committed
28
git clone https://git.namejeff.xyz/Supositware/Haha-Yes
Loïc Bersier's avatar
Loïc Bersier committed
29
cd discordbot
Loïc Bersier's avatar
Loïc Bersier committed
30
npm install
31 32

sequelize db:migrate
Loïc Bersier's avatar
Loïc Bersier committed
33
```
34

35
If the youtube-dl module didn't install youtube-dl by himself you can go in ``node_modules/youtube-dl/scripts`` and run ``node download.js``
Loïc Bersier's avatar
Loïc Bersier committed
36
Configure [config.json](config-exemple.jsonc) and [config/config.json](config/config-example.json )
37

Loïc Bersier's avatar
Loïc Bersier committed
38 39 40 41 42
To run the bot either use pm2
```
npm install -g pm2
pm2 start index.js --name(insert name)
```
43 44
or with node ``node index.js``

Loïc Bersier's avatar
Loïc Bersier committed
45
If on linux you can also do
46 47

``nohup node index.js &``
Loïc Bersier's avatar
Loïc Bersier committed
48

49 50 51 52
To use [ytp.js](commands/fun/ytp.js)
1. Download the folder 'sounds', 'music', 'resources', 'sources' from [YTPPlus](https://github.com/philosophofee/YTPPlus)
2. Put them in the [asset/ytp](asset/ytp) folder

Loïc Bersier's avatar
Loïc Bersier committed
53 54 55 56 57
To use dectalk on linux you will need
1. Get dectalk 
2. install wine
3. install Xvfb & run `Xvfb :0 -screen 0 1024x768x16 &`

Loïc Bersier's avatar
Loïc Bersier committed
58 59 60 61 62 63 64 65 66
## Built With

* [Discord.JS](https://github.com/discordjs/discord.js) - The discord api used
* [Discord-Akairo](https://github.com/1Computer1/discord-akairo) - The framework used for Discord.JS

## Authors

* **Loïc Bersier**

Loïc Bersier's avatar
Loïc Bersier committed
67 68 69 70
## Donation link

[![Paypal](https://www.paypalobjects.com/en_US/CH/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/paypalme2/supositware/)

Loïc Bersier's avatar
Loïc Bersier committed
71
## License
Loïc Bersier's avatar
Loïc Bersier committed
72

Loïc Bersier's avatar
Loïc Bersier committed
73
This project is licensed under the **GNU Affero General Public License v3.0** License - see the [LICENSE](LICENSE) file for details
Loïc Bersier's avatar
Loïc Bersier committed
74

Loïc Bersier's avatar
Loïc Bersier committed
75
## Acknowledgments
Loïc Bersier's avatar
Loïc Bersier committed
76

Loïc Bersier's avatar
Loïc Bersier committed
77 78
* [discord.JS team](https://github.com/discordjs/discord.js)
* [1computer1](https://github.com/1Computer1/) for discord-akairo & the help command from [hoshi](https://github.com/1Computer1/hoshi)
Loïc Bersier's avatar
Loïc Bersier committed
79
* [Rantionary](https://github.com/RantLang/Rantionary) for there dictionnary.
80
* Tina the Cyclops girl#0064 for inspiring me for making this bot
81
* [Jetbrains](https://www.jetbrains.com/?from=Hahayesdiscordbot) for providing their IDE free of charges! 
82 83

<img src="https://its.gamingti.me/XT8F.svg" width=20%></img>