# pyrobloxbot

**pyrobloxbot** is an open-source package for making Roblox bots that interact with the game strictly through the keyboard.

It simplifies this process by providing features like:
- Methods for most actions your character can make, like movement, chatting, resetting, etc
- Methods to navigate through game ui elements through the keyboard only, to avoid needing the mouse which is unreliable
- Methods to join games, join users and join private servers
- Highly customizable bots, by changing different options to fit your use case
- A global failsafe to avoid your bot going rogue
- Support for multi account bots

```{include} guides/basic/installation.md
```

## Have a question?

Don't hesitate to ask!

You can check the [FAQ](faq.md), [open an issue](https://github.com/Mews/pyrobloxbot/issues/new?labels=question), or contact me on discord (mews75)!

## Got an idea?

All feature requests are welcome!

You can submit them on github by [opening an issue](https://github.com/mews/pyrobloxbot/issues/new?template=feature.yml) and using the feature template.

---

Also, feel free to share anything you make with me through my discord (mews75)!

# Sections

```{toctree}
:maxdepth: 2
:caption: Getting Started

guides/basic/installation
guides/basic/starting
api_references/api_references
faq
```

```{toctree}
:maxdepth: 2
:caption: Usage Guides

guides/usage/keybinds
guides/usage/options
guides/usage/image_recognition
guides/usage/ui_nav
guides/usage/joining_games
```

```{toctree}
:maxdepth: 2
:caption: Advanced Usage

guides/advanced/inventory
guides/advanced/multi-account
```

```{toctree}
:maxdepth: 1
:caption: Usage Examples
:titlesonly:

guides/examples/anti-afk
guides/examples/playtime-rewards-bot
guides/examples/macros
guides/examples/factory-raid
```