Haha-Yes/README.md

55 lines
1.3 KiB
Markdown
Raw Normal View History

2019-01-02 21:58:12 +01:00
# Haha Yes
2019-01-02 10:32:07 +01:00
2019-01-02 21:58:12 +01:00
A multi function discord bot.
2019-01-02 10:32:07 +01:00
2019-01-02 21:58:12 +01:00
## Getting Started
2019-01-02 10:32:07 +01:00
2019-01-02 21:58:12 +01:00
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
2019-01-02 10:32:07 +01:00
2019-01-02 21:58:12 +01:00
### Prerequisites
2019-01-02 10:32:07 +01:00
2019-01-02 21:58:12 +01:00
You need to install the following
2019-01-02 10:32:07 +01:00
2019-01-02 21:58:12 +01:00
```
https://github.com/Automattic/node-canvas
```
### Installing
2019-01-02 10:32:07 +01:00
```
git clone https://gitlab.com/loicbersier/discordbot
2019-01-02 21:58:12 +01:00
cd discordbot
2019-01-02 10:32:07 +01:00
npm init -y
npm install
```
2019-01-02 21:58:12 +01:00
To run the bot either use pm2
```
npm install -g pm2
pm2 start index.js --name(insert name)
```
or node
```
node index.js
```
2019-03-09 23:54:22 +01:00
If on linux you can also do
```
nohup node index.js &
```
2019-01-02 21:58:12 +01:00
## 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**
## License
2019-01-02 10:32:07 +01:00
2019-02-06 03:31:15 +01:00
This project is licensed under the **GNU Affero General Public License v3.0** License - see the [LICENSE](LICENSE) file for details
2019-01-02 10:32:07 +01:00
2019-01-02 21:58:12 +01:00
## Acknowledgments
2019-01-02 10:32:07 +01:00
2019-03-09 23:44:35 +01:00
* [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)
2019-01-02 21:58:12 +01:00
* Tina the Cyclops girl#0064 for inspiring me for making this bot