phundrak/TranslAAAAAAAAAAAAAAAAAtor
phundrak/TranslAAAAAAAAAAAAAAAAAtor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Meme discord bot inspired by the r/AAAAAAAAAAAAAAAAA subreddit.
4 Commits 1 Branch 0 Tags 188 KiB
Python 95%
Dockerfile 5%
master
Go to file
Lucien Cartier-Tilet 9d9a0b4fa2
removed unused lines in example docker-compose
2019-11-22 12:51:23 +01:00
img initial commit, everything seems to work fine 2019-11-22 12:02:50 +01:00
.gitignore initial commit, everything seems to work fine 2019-11-22 12:02:50 +01:00
docker-compose.yml initial commit, everything seems to work fine 2019-11-22 12:02:50 +01:00
Dockerfile initial commit, everything seems to work fine 2019-11-22 12:02:50 +01:00
LICENSE initial commit, everything seems to work fine 2019-11-22 12:02:50 +01:00
README.md removed unused lines in example docker-compose 2019-11-22 12:51:23 +01:00
README.org removed unused lines in example docker-compose 2019-11-22 12:51:23 +01:00
requirements.txt initial commit, everything seems to work fine 2019-11-22 12:02:50 +01:00
translaaaaaaaaaaaaaaaaator.py fixed link to source 2019-11-22 12:49:24 +01:00

README.md

img

About

TranslAAAAAAAAAAAAAAAAAtor is a meme bot inspired by the subreddit r/AAAAAAAAAAAAAAAAA. What it does is translate a sentence given to it by replacing all characters (except whitespace) into As. That’s it. That’s literally it.

Dependencies

The only dependency of translAAAAAAAAAAAAAAAAAtor is Discord.py which powers the bot itself.

Invite TranslAAAAAAAAAAAAAAAAAtor

Maybe you do not want to build the bot itself, but instead you just want to invite it on your server? I got you covered! You can invite the official instance of TranslAAAAAAAAAAAAAAAAAtor by clicking here!

Be aware though that I cannot ensure 24/7 uptime of TranslAAAAAAAAAAAAAAAAAtor. If you notice it is down, shoot me a tweet (faster), a DM (fast, P'undrak#0001) or an email (slower).

Running the project

First, you will need docker and docker-compose installed on your machine. If they aren’t installed yet, go check Docker’s or your distro’s instruction on how to get them.

To Run This Project, you will only need the docker-compose.yml file from this repository. You can get it by running the following command on your machine:

wget -c https://raw.githubusercontent.com/phundrak/translaaaaaaaaaaaaaaaaator/master/docker-compose.yml

Or you can clone the whole project if you wish.

Due to obvious security reasons, I am not giving away the token of my bot in the source code, and you should not either. This is why this project will try to get it from your environment variables. To do so, edit the docker-compose file to add the environment key `BOTTOKEN`, like so:

version: '3'
services:
  bot:
    image: phundrak/translaaaaaaaaaaaaaaaaator:latest
    command: python translaaaaaaaaaaaaaaaaator.py
    environment:
      - BOT_TOKEN=yourtoken

You can now run the project within a contained environment by running the following command:

docker-compose up

If you wish to have it detached from your terminal, you can add the `-d` switch to the command:

docker-compose up -d

And that’s it! Your bot should be up and running once your container is built, which happens only the first time you launch it. If you want to stop TranslAAAAAAAAAAAAAAAAAtor, simply hit Ctrl-c in your terminal if you haven’t detached the process, or run docker-compose down if you did.

Licence

This project is under the free GPLv3 licence. You can find the complete licence in <LICENCE.md>.

Contributing

Submit a pull request, and I’ll review it when I’ll have time to (this is not a project I will pour a lot of efforts into). Simply be aware that I’d prefer it if your code is written with meaningful variables (I should fix that), comments (I should fix that), and be aware that readability is above all. Also, don’t be an asshole (that’s the project’s Code of Conduct for y’all).