Skip to content
This repository has been archived by the owner on Nov 11, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tupperbox authored Jan 12, 2021
1 parent 4456bd7 commit 608bef2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,16 @@
# This is the open-source fork of the public [Tupperbox bot](https://discord.com/oauth2/authorize?client_id=431544605209788416&scope=bot&permissions=536996928).
This fork is not currently being worked on. Pull requests or issues opened on this fork may not be looked at for a while. In the future more features are planned to be brought to this fork for those of you hosting your own versions of Tupperbox.
If you have an issue with the [live version of Tupperbox](https://discord.com/oauth2/authorize?client_id=431544605209788416&scope=bot&permissions=536996928) then please join the [support server](https://discord.com/invite/rHxMbt2) for help.

# Tupperbox
A Discord bot written in [eris](https://github.com/abalabahaha/eris) for proxying user messages through webhooks to emulate users having multiple Discord accounts.

* [Click here to invite the bot to your server!](https://discord.com/oauth2/authorize?client_id=431544605209788416&scope=bot&permissions=536996928)
* [Click here to invite the public bot to your server!](https://discord.com/oauth2/authorize?client_id=431544605209788416&scope=bot&permissions=536996928)

* [Click here to join our support server!](https://discord.com/invite/rHxMbt2)

# Local Installation
Tupperbox requires Node.js (must be at least v14), PostgreSQL (v11, preferably v12) and Redis (stable, currently v6.0.8). You can download Node.js [here](https://nodejs.org/en/download/), PostgreSQL [here](https://www.postgresql.org/download/) and Redis [here (Linux)](https://redis.io/download) or [here (Windows)](https://www.memurai.com/).
The self-hosted version of Tupperbox requires Node.js (must be at least v14), PostgreSQL (v11, preferably v12) and Redis (stable, currently v6.0.8). You can download Node.js [here](https://nodejs.org/en/download/), PostgreSQL [here](https://www.postgresql.org/download/) and Redis [here (Linux)](https://redis.io/download) or [here (Windows)](https://www.memurai.com/).

Once Node.js is installed, run `npm install` from the bot directory to install the bot's dependencies. (Note: you may have to run `npm -g install windows-build-tools` first if on Windows)

Expand All @@ -21,7 +25,3 @@ The bot expects a file in the same directory named `.env` with its configuration
* `BOT_INVITE` is the bot's user ID, used in the `tul!invite` command. `SUPPORT_INVITE` is the invite ID (**not invite link**) to the bot's support server, used in the `tul!feedback` command. <br> Remove either of these to remove the respective bot commands.

* Leave `REDISURL` alone unless you change the port Redis runs on or you host it on another machine.

# Upgrading from JSON storage

The previous version of the bot used JSON as a database. <br> If you would like to upgrade, install PostgreSQL and Redis, switch to the rewrite branch, and on startup the bot will prompt you to import your JSON databases to the Postgres server you've configured automatically. (Make a backup of these files first - it will delete them!)

0 comments on commit 608bef2

Please sign in to comment.