https://github.com/slickml/afk-bot

AFK-Bot🤖: A bot for the away from keyboard times
https://github.com/slickml/afk-bot

afk afk-bot

Last synced: 3 months ago
JSON representation

AFK-Bot🤖: A bot for the away from keyboard times

• Host: GitHub
• URL: https://github.com/slickml/afk-bot
• Owner: slickml
• License: mit
• Created: 2022-11-11T00:17:19.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2025-11-19T17:42:29.000Z (7 months ago)
• Last Synced: 2025-12-23T09:51:09.884Z (6 months ago)
• Topics: afk, afk-bot
• Language: Python
• Homepage: https://github.com/slickml/afk-bot
• Size: 281 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


[![build](https://github.com/slickml/afk-bot/actions/workflows/ci.yml/badge.svg)](https://github.com/slickml/afk-bot/actions/workflows/ci.yml)

[![codecov](https://codecov.io/gh/slickml/afk-bot/graph/badge.svg?token=Z7XP51MB4K)](https://codecov.io/gh/slickml/afk-bot)

[![license](https://img.shields.io/github/license/slickml/afk-bot)](https://github.com/slickml/afk-bot/blob/master/LICENSE/)

[![downloads](https://pepy.tech/badge/afk-bot)](https://pepy.tech/project/afk-bot)

![pypi_version](https://img.shields.io/pypi/v/afk-bot)

![python_version](https://img.shields.io/pypi/pyversions/afk-bot)

[![slack_invite](https://img.shields.io/badge/slickml-slack-purple?logo=slack)](https://www.slickml.com/slack-invite)

![twitter_url](https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Ftwitter.com%2FSlickML)





  

    

  





AFK-Bot🤖: A bot for the away from keyboard times





## 🧠 Philosophy

We strongly believe that all developers should have full access to their resources (i.e. `sudo` access or permission to deactivate screens saver, ...). `afk-bot` 🤖 is a simple bot that moves the mouse cursor (every 1 second by default and it can be customized); so, your status never goes `Idle` and your screen never gets locked 😂 ...

## 🛠 Installation

To begin with, you need to have a [Python version >=3.8](https://www.python.org) installed and to install the library

from [PyPI](https://pypi.org/project/afk-bot/) simply run 🏃‍♀️ :

```

$ pip install afk-bot

```

## 📌 Quick Start

`afk-bot` is a `command-line` based bot and you can simply run it in any `terminal` 🏃‍♀️ :

```

$ afk-bot                     <- runs the bot and the mouse cursor moves every 1 second by default

$ afk-bot -t  <- you can customize the interval with -t or --time

$ afk-bot --help              <- shows the options 

```

To `exit`, simply press `CTRL+C` keys. 

## 📣 Common Issues

  - Mac users should note that the accessibility to `Apple Events Server (AEServer)` should be turned on. Simply follow the steps 🏃‍♀️ :

    ```

    System Preferences > Security & Privacy > Choose Privacy Tab > Select Accessibility from Left Pane > Enable AEServer

    ```

  - Some Linux users might need to export the environment variable `DISPLAY`. Simply run 🏃‍♀️ :

    ```

    $ export DISPLAY=:0

    ```

## 🧑‍💻🤝 Contributing

If you think more features should be added, please open up an issue an. PRs are more than welcome 🙏 . You can find the details of the development process in our SlickML🧞 [Contributing](CONTRIBUTING.md) guidelines. We strongly believe that reading and following these guidelines will help us make the contribution process easy and effective for everyone involved 🚀🌙 .

## ❓ 🆘 📲 Need Help?

Please join our [Slack Channel](https://www.slickml.com/slack-invite) to interact directly with the core team and our small community. This is a good place to discuss your questions and ideas or in general ask for help 👨‍👩‍👧 👫 👨‍👩‍👦 .