# Tyrell

More human than human

- Python powered
- TOML configured

## Setup

> I'll assume you have Python 3, and Python's `venv` (Python Virtual Environment module)

This requires a Python virtual environment to have the needed python modules

`python3 -m venv env`

Now we need to activate that, so we can install the needed python modules

- Linux: `. env/bin/activate`
- Windows: `.\env\Scripts\activate`

And now to install the `requirements.txt` (Our list of needed python modules)

`pip install -r requirements.txt`

> You may get a notice to upgrade `pip`, but this is safe to ignore (So long as it has no errors installing any of the modules)

That's it, now you're ready to run one of the provided `run` scripts

## Platform Specifics

I've provided `run.sh` and `run.bat`, mostly for convenience

These eventually come down to doing 2 things:

1. Activating a Python virtual environment
2. Calling Python to run `tyrell.py`

### Linux

Under Linux, `sudo` is required for the "keyboard" module, which is needed for hooking keyboard events (oddly enough I use "pyautogui" to send keyevents (keyup, keydown, press (down then up)))

As such, I've provided a `run.sh`, to be used like below (for ease of use, this will activate the python virtual environment, then calls python to run `tyrell.py`)

```bash
sudo ./run.sh
```

### Windows

Under Windows, I've simply provided a `run.bat` for ease of use

> This simply activates the python virtual environment, then calls python to run `tyrell.py` (all for you in a Windows Batch file/script)

```powershell
.\run.bat
```