woomy/README.md

22 lines
1.1 KiB
Markdown
Raw Normal View History

2020-01-25 10:02:43 +00:00
# Woomy
2020-03-09 23:11:53 +00:00
Woomy is a all-purpose discord bot built off the [guidebot](https://github.com/AnIdiotsGuide/guidebot) base and coded in node.js using discord.js.
2020-01-25 10:02:43 +00:00
# How to use
The easiest way to use Woomy is to invite it to your server with [this link.](https://discordapp.com/oauth2/authorize?client_id=435961704145485835&permissions=2134240503&scope=bot) It is hosted 24/7 and automatically updates itself when a new release is made available, making sure you always get the newest features.
2020-03-09 23:11:53 +00:00
You can also self-host! Some modificatiomns to the code will need to be made before Woomy will run on your machine, but anyone who can read errors will figure out what needs to be changed pretty quickly :P
2020-01-25 10:02:43 +00:00
# Requirements
- git
2020-03-09 01:11:33 +00:00
- node.js v12.0.0 or higher
2020-01-25 10:02:43 +00:00
- node-gyp build tools
2020-03-09 23:11:53 +00:00
- ffmpeg (or ffmpeg-static)
2020-01-25 10:02:43 +00:00
# Installation
- Clone Woomy to your machine
- Run `npm i` in Woomy's directory
- Open config.js in your code editor and insert all the required information
# Contributing
2020-03-09 23:11:53 +00:00
If you wish to contribute to Woomy, please fork the repository and open a pull request. Any contribution is appreciated <3