Dave/README.md

# Dave

A Mastodon Bot written in Python that posts random Scooter quotes every time you run it.

[@dave@cyber.ms](https://cyber.ms/@Dave)

Big thanks to [Ramses](https://corteximplant.com/@revengeday) for helping me and making it even better! :3

---

## Requirements

- Python3
- pyYAML
- Mastodon.py

---

## Installation

1. **Clone the repository**:

    ```sh
    git clone https://git.cyberwa.re/dalfuss/Dave.git
    ```

2. **Navigate to the project directory**:

    ```sh
    cd Dave
    ```

3. **Create Mastodon App and enter Credentials**:
	- Go to your Mastodon Settings -> Development
	- Klick "New Application"
	- Enter an Application Name
	- Scroll down to "Scopes" and check "write:statuses"
	- Submit
	- Klick on your new Application and copy your access token
	- In your Terminal enter  

    ```sh
    nano mastodon.yml
    ```

	- Replace the placeholders   
	
    ```yaml
    url: https://INSTANCE.URL # <-- Your instance URL here, e.g https://corteximplant.com
    token: APP_TOKEN_HERE # <-- Your application token here
    ```

4. **Create .venv so you don't mess up your global Python**:

    ```sh
    sudo apt install virtualenv
    virtualenv .venv
    ```

5. **Switch to your Virtual Env and install the requirements**:

    ```sh
    source .venv/bin/activate

    pip install -r requirements.txt
    ```

6. Now you can either run it manually with
    ```sh
    python bot.py
    ```

7. Or create a cronjob to run it on a timer (use [Crontab.guru](https://crontab.guru/) if you need help :3)

    ```sh
    contab -e

    # This will run the script every 3 hours
    0 */3 * * * /path/to/Dave/.venv/bin/python /path/to/Dave/wicked.py
    ```

## Contributing

Want to add more Scooter lines?Just send a pull request. (Or don't and add them manually to your `lyrics.yml`)

## Contact

Got questions? Hit me up anywhere listed on [dalfuss.link](https://dalfuss.link/) :3