40 lines
1.7 KiB
Markdown
40 lines
1.7 KiB
Markdown
# Anitrox
|
|
Your new favorite bot!
|
|
|
|
## Get started!
|
|
To get started, You'll need Node.JS and NPM
|
|
|
|
You can get these through either your Linux distributions package manager, or if you are on Windows, by [clicking here.](https://nodejs.org/en/)
|
|
|
|
## Install those dependencies!
|
|
|
|
Run ``npm install`` and wait for it to download dependencies\
|
|
*For development: ESLint extension in your editor of choice*
|
|
|
|
## Configure yo bot!
|
|
|
|
Get or make your Discord bot token from [The Discord developer portal](https://discord.com/developers/applications), and rename ``.env.example`` to ``.env``. Set the ``TOKEN=""`` to the token you got from Discord
|
|
|
|
Then grab your Discord User ID and put it in ``OWNERID=""``, This tells the bot who owns it
|
|
|
|
⚠️ **WARNING**: This gives access to the bots controls, such as restart/shutdown, and eval! Make sure you use your own ID and not somebody elses.
|
|
|
|
## Get this party started!
|
|
|
|
Run ``npm start`` to start the bot!
|
|
|
|
|
|
<img src="https://i.pinimg.com/originals/ba/e4/de/bae4de2fa4f778f874c84928b8e19203.png" alt="Pinkie Pie blasting a party cannon" height="auto" width="50%">
|
|
|
|
# But I don't want to self host!
|
|
|
|
No worries! You can add the bot to your server by [clicking here!](https://discord.com/oauth2/authorize?client_id=576805923964715018&scope=bot&permissions=8)
|
|
|
|
## Need help, or support?
|
|
You can join the Anitrox support server by [clicking here!](https://discord.gg/u2J9FmBfPy), Mentioning me on Twitter or Mastodon (@IDeletedSystem64@glaceon.social). If it's to report a bug, Please open a GitHub issue.
|
|
|
|
|
|
# Contributing
|
|
You are more than welcome to contribute to Anitrox, such as adding features, squashing bugs and suggesting new things for the bot!
|
|
|
|
⚠️ **WARNING**: Using stolen code or AI generated code will result in your PR being closed. |