IDeletedSystem64/anitrox
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Announce the end of the project

Browse source
This commit is contained in:
Sophie Marie 2024-01-30 11:39:43 -06:00
parent 53eb34b264
commit 3c88b53039
Signed by: IDeletedSystem64
GPG key ID: 33A12B0480AFC8E9
1 changed files with 38 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -1,17 +1,39 @@
# the Anitrox project was formally discontinued on January 30th, 2024.
Anitrox was shut down on October 23rd, 2023. Development is now permenantly ceased and support is no longer available.
You will no longer be able to make merge requests, or open bug reports on the bot.
## Building on from here.
You can still fork the bot, and do whatever you'd like with it. We'll be shifting from the GPLv2 license to the MIT license with this change.
## Why now?
I've been becoming increasingly frustrated and unhappy with Discord as a service and platform, and have no desire in putting any more time into something for a platform I quite despise at this point. If you look at the last commits, There hasn't even *been* any active development for on going on months at this point. I've also been shifting my focus on programming towards other things, which has also been contributing to the lack of further development.
# Thank you.
Thank you to everyone who contributed to the bot, weather you contributed with code, a bug report or helped work out an issue, **thank you.**
#
## 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%">
# Anitrox Development Branch (anitrox_dev)
This is the development branch, Where all the work happens. Be careful as some features may bite, or be removed without notice!
# Dependencies to get started
To begin, you will need to satisfy the following dependencies:
Node.JS: 16.6.0
npm: 6.14
# Dependencies for development
Visual Studio Code (Recommended)
ESLint
# Let's get this ~~party~~ bot started!
For first time start up, You will need to run ``npm install`` to install the needed npm packages.
Afterwards fill out the ``.env.example`` and ``config-example.json`` and then rename them to ``.env`` and ``config.json``, then just run ``node start.js`` (or ``./start.js`` on Linux)!
<br>
⚠️ If you don't specify the Owner ID, Some commands such as the bot controls will be unusable!
# Support
Support is available on the [Discord Server!](discord.gg/5nQtMNpf43), or @ me on [Twitter!](twitter.com/IDeleteSystem64) [Mastodon!](glaceon.social/@IDeletedSystem64)