YandereLewdBot/README.md

# Readme
Yandere Lewd Bot is a customizable, no frills image-posting bot for Pleroma.

A live example can be viewed at [Neckbeard.xyz](https://neckbeard.xyz/YandereLewdBot).

Currently the bot will only run on Linux. I believe it should run on most distros but I have only tested it on Arch and Raspbian.

## Usage
```text
usage: main.py [--dry-run] [--debug] [-w WAIT] [-t TIME] [-d DATE] [-c CONFIG]
               [-o] [-h]

A bot for posting on Mastodon

optional arguments:
  --dry-run             Will not login or post to Plemora
  --debug               Same as --dry-run
  -w WAIT, --wait WAIT  Wait before posting first image (seconds)
  -t TIME, --time TIME  Wait for time before posting first image
  -d DATE, --date DATE  Wait for date before posting first image
  -c CONFIG, --config CONFIG
                        Set custom config file (Default: cfg)
  -o, --output-hashes   Output list of hashes
  -h, --help            Show this help message and exit

  TIME   %I:%M%p    03:58PM
  DATE   %m/%d/%Y   11/26/2021
```

## About
Yandere Lewd Bot is designed to be simple to understand (from a technical perspective) and easy to modify/extend. Yandere Lewd Bot relies on GNU formatted hash files to configure and organize posts (from the GNU coreutils package):  
(ex. `26d00a6ee5ae8fa3d58ee44b32b8992f *./rsc/nsfw/image.jpg`)

The bot is still in development and can easily be crashed by writing a poorly configured `cfg.py` file, or messing with the hash files it uses to configure posts.

## Installing
To setup the python3 environment (for Arch Linux) run the following commands:  
```
sudo pacman -Syu
sudo pacman -S --needed python git
git clone 'https://github.com/YandereLewdBot/YandereLewdBot.git'
cd yandereLewdBot/
python -m venv venv
source ./venv/bin/activate
pip install --upgrade pip
pip install -r requierements.txt
deactivate
cp ./bin/cfg_default.py ./bin/cfg.py
<chmod.txt xargs -i chmod +x '{}'
./run.sh -h
```
If everything worked correctly you should see usage information on Yandere Lewd Bot.

The ./run.sh file will automatically activate and deactive the python virtual environment. You may want add a symlink to `/usr/local/bin` for convienence.

```
sudo ln -s "$(pwd)/run.sh" "/usr/local/bin/yandereLewdBot"
yandereLewdBot -h
```

For Debian or Ubuntu based distros I believe you need to change python with python3 for the package and command name `¯\_(ツ)_/¯`
## Generating your OAuth Tokens
Before you can begin posting from the bot, you must first create an account on the instance of your choice, and then generate your OAuth tokens.

To generate your tokens, run the following commands and follow the interactive prompts.
```
source ./venv/bin/activate
./bin/create_app.py
# Follow the interactive prompts.
deactivate
```

**NOTE:** Yandere Lewd Bot only requieres write permissions. When prompted you should accept the default permission unless extending the bot's default functionality.

If you did everything correctly you should see `Success! :)` at the end of the terminal, as well as your credentials in the format below:
```text
settings_server = OrderedDict([
        "app_name":       "app",
        "api_base_url":   "https://neckbeard.xyz",
        "client_id":      "Long String of Text",
        "client_secret":  "Long String of Text",
        "access_token":   "Long String of Text"
])

settings_reminder = "09/20/2020 02:58PM"

settings_encrypt = {
        "encrypt":        False,
        "salt":           "",
}
```
If you used encryption, everything in the `settings_server` dictionary will be encrypted and you will have to enter your password every time you start the bot. Your `settings_encrypt` will look like this:
```text
settings_encrypt = {
        "encrypt":        True,
        "salt":           "A Short String of Text",
}
```

Copy and paste these values from the terminal into your `bin/cfg.py` file. **Make sure you paste over or delete the placeholder values with the same names.**
## Posting
To begin posting:

- Make sure you already have a Pleroma account set up .
- Generate your OAuth tokens following the guide above.
- Put some images in the rsc/ folder (organize by safe and nsfw posts).
	- 'safe' posts will be marked with `#yandere`
	- 'nsfw' posts will be spoilered and marked as `#yandere #nsfw`
- cd into the root directory (the directory with `run.sh`)
- Start the bot with `./run.sh`
	- Enter your password if you encrypted your OAuth tokens.
	- If you symlinked the file in the [Installing](##installing) section you can simply run `yandereLewdBot` instead of changing directories and starting the bot with `./run.sh`
- If everything worked correctly, you should see your first image posted to your account.
- Hit Ctrl+C to stop the bot.
- When you start the bot again, it will begin posting from where it last left off.
	- It accomplishes this by writing to a `md5/blacklist.txt` file. If you see this file, it worked correctly.
- Keep in mind that the bot's default visibility setting is set to unlisted for testing. You may want to update it to public.
- Read [docs/configuration.md](configuration.md) to customize the bot for your purposes.

# Useful Tips and Commands
## Quickly Sum the Entire rsc/ Folder
To quickly sum everything in the `rsc/` folder, run the following commands:
```
cd yandereLewdBot/
find "./rsc" -type f -exec md5sum -b {} \; > "./md5/master_file.txt"
```
## Installing Screen
Most likely,  you will want this bot to run over a long period of time. It is probobly best to install the `screen` package for Linux so you don't have to have a terminal window constantly open (especially if you are running it from a remote machine such as a Raspberry Pi or server).
```
sudo pacman -Syu
sudo pacman -S --needed screen

# Screen cheatsheet
# To create a new screen session named 'yandereLewdBot'
screen -S yandereLewdBot
# To detach from the screen session
Ctrl+a d
# To reconnect to the screen session
screen -r yandereLewdBot
# List screen sessions
screen -ls
# Kill the screen session
Ctrl+a k y
# Scroll back
Ctrl+a ESC Page Up
# End scroll back
ESC
```
## A More Useful rsc/ Folder Structure
A more advanced (and useful) way of organizing images in the `rsc/` folder is by date added, group (such as a character name like Yuno Gasai), and safe/nsfw profiles. To do this, the following folder structure would be used: `rsc/year.month.day/character/safe_or_nsfw/image.png`

To configure this in the `settings_post` section, use the following for safe/nsfw repectivly:
```
setup_safe_profile("Yuno.safe", "./rsc/*/Yuno/safe/*", "#Yuno_Gasai #yandere")
setup_nsfw_profile("Yuno.nsfw", "./rsc/*/Yuno/nsfw/*", "#Yuno_Gasai #nsfw #yandere")
```
Notice the wildcard character `'*'` is used in place of year.month.day. This will match any folder in the resource folder, and all of our folders will be in order of when we added them.
## A Master Blacklist
The default configuration file has the following settings below (these files will not exist by default. The bot will simply ignore blacklist hash files that it can't open). The _r stands for read and the _w stands for write. This will ensure that the master_blacklist.txt is always read, but is never written to. This is intended for the user to manually add GNU formatted hashes to master_blacklist.txt in case they want to make especially sure that hashes and paths that are matched in the list are never uploaded accidentally.
```
"master_blacklist_r":	("./md5/blacklist.txt", "./md5/master_blacklist.txt"),
"master_blacklist_w":	("./md5/blacklist.txt",),
```
## Quickly Create Configuration Files
Configuration files for Yandere Lewd Bot are just python files. Because of this we can easily create multiple configurations by importing the main configuration file, and overriding the values we need. This is useful for creating holiday and debug configurations without needing to create a new configuration file from scratch.
```
# Name: alt.py
# Post to an alt account using the exact same settings as the main configuration file
# Run with the following command: ./run.sh -c alt

# cfg.py is the default configuration. You should set this to whatever you are overriding.
from cfg import *

settings_server = OrderedDict([
	("app_name",		"generate from ./bin/create_app.py"),
	("api_base_url",	"generate from ./bin/create_app.py"),
	("client_id",		"generate from ./bin/create_app.py"),
	("client_secret",	"generate from ./bin/create_app.py"),
	("access_token",	"generate from ./bin/create_app.py")
])

settings_reminder = "generate from ./bin/create_app.py"

settings_encrypt = {
	"encrypt":	False,
	"salt":	"generate from ./bin/create_app.py"
}

settings_behavior["master_blacklist_r"] = ("./md5/blacklist_alt.txt", "./md5/master_blacklist.txt")
settings_behavior["master_blacklist_w"] = ("./md5/blacklist_alt.txt",)

# Uncommenting the below might be useful if your alt is used for debugging and testing
# settings_behavior["master_list"] = ("master_file_alt.txt",)
# settings_behavior["visibility"] = "private"
# settings_behavior["debug"] = True
# settings_behavior["master_blacklist_w"] = tuple()
```

```
# Name: xmas.py
# An xmas themed config file!
# Run with the following command: ./run.sh -c xmas

# cfg.py is the default configuration. You should set this to whatever you are overriding.
from cfg import *

settings_behavior["master_list"] = ("./md5/event_xmas.txt",)
settings_behavior["master_blacklist_r"] = ("./md5/blacklist_xmas.txt", "master_blacklist.txt")
settings_behavior["master_blacklist_w"] = ("./md5/blacklist_xmas.txt",)

# Prepend '#Merry #Christmas' to the beginning of the first line in each post
for setting in settings_post:
	if len(setting["message"]) and issubclass(type(setting["message"][0]), str):
		new_msg = "#Merry #Christmas {}".format(setting["message"][0])
		setting["message"] = (new_msg,) + setting["message"][1:]
```