Skip to content

Latest commit

 

History

History
229 lines (168 loc) · 8.21 KB

README.md

File metadata and controls

229 lines (168 loc) · 8.21 KB
Raw

Contributors Forks Stargazers Issues MIT License


Logo

altminder

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
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

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).

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

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

Installation

  1. Clone the repo 
    git clone https://github.com/bitfl0wer/altminder.git
  2. (Optional) Create and activate a venv in the project directory
    Linux and macOS: 
    python -m venv venv
source ./venv/bin/activate
  3. Install pip requirements 
    pip install -r requirements.txt
  4. Start the bot. From the project source (magicaltavern/) type 
    TOKEN=YOURBOTTOKENHERE python -m src.bot

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the AGPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Florian - [email protected]

Project Link: https://github.com/bitfl0wer/altminder

(back to top)

Acknowledgments

(back to top)