![Logo](/bitfl0wer/altminder/raw/main/img/altminder2.jpg)
A project that aims to make Discord a tiny bit more accessible for vision impaired users by reminding people to add image descriptions (alt texts) to their images.
Invite to Server
·
Report Bug
·
Request Feature
Table of Contents
altminder aims to improve the Discord experience for blind and low vision users by sending a friendly reminder to include an image description (alt text) to images posted in Discord chats. These reminders are public, but get deleted automatically (after 30s). Image descriptions are absolutely crucial for low vision users, since they are often the only way for vision impaired people to know what an image displays, or, for example, what the text on an an image says. Not including image descriptions with posted images therefore excludes low vision users from fully participating in the community (the Discord server).
- Python
- py-cord 2.4.0
To get a local copy up and running follow these simple example steps.
Install Python 3.9 (3.8+ should be fine, but I can only verify that it works on Python 3.9)
- Python Website
- pip
python -m ensurepip --upgrade
- A Discord Bot Application that is added to your desired server(s), and which's token you possess
- Clone the repo
git clone https://github.com/bitfl0wer/altminder.git
- (Optional) Create and activate a venv in the project directory
Linux and macOS:python -m venv venv source ./venv/bin/activate
- Install pip requirements
pip install -r requirements.txt
- Start the bot. From the project source (magicaltavern/) type
TOKEN=YOURBOTTOKENHERE python -m src.bot
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the AGPL-3.0 License. See LICENSE.txt
for more information.
Florian - florian@pro-weber.com
Project Link: https://github.com/bitfl0wer/altminder