Anon/YandereLewdBot
Archived
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Spelling

Browse Source
This commit is contained in:
Anon 2022-08-31 20:17:09 -07:00
parent bb96f3126d
commit 47cb04298f
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -30,7 +30,7 @@ cp -vn default/cfg.py src/
```
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.
The ./run.sh file will automatically activate and deactivate the python virtual environment. You may want add a symlink to `/usr/local/bin` for convenience.
```
sudo ln -s "$(pwd)/run.sh" "/usr/local/bin/yandereLewdBot"
@ -78,7 +78,7 @@ To begin posting:
- 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 `#nsfw #lewd #yandere`
- 'nsfw' posts will be set to sensitive and marked as `#nsfw #lewd #yandere`
- Make sure you are in the bot's root directory (the directory with `run.sh`)
- Checksum all the files you added with the following command:
- `find "./rsc" -type f -exec md5sum -b '{}' \; > "./md5/master_file.txt"`

10
docs/configuration.md
View File

@ -65,7 +65,7 @@ This is the main configuration setting for the bot.
**`atomic_saving:`** If set to `True`, when the bot blacklists a file it will create a temporary copy of the file(s) that it is writing to. It will write to the temp file, then write over the old file. This is basically a paranoid saving option in case your server loses power unexpectedly while the bot is writing data. Generally speaking setting this option to `True` is probably unnecessary and will result in excessive writes to the disk.
**`sync_save:`** If set to`True` the bot will synchronize data to the disk immediately when it writes to a blacklist file. Generally speaking this should be set to `True` in case the server looses power unexpectedly. It should be set to `False` you are posting a lot of images at once. You should also be aware that if `atomic_saving` is enabled, it will syncronize all writes to and from the temp file which is probobly excessive.
**`sync_save:`** If set to`True` the bot will synchronize data to the disk immediately when it writes to a blacklist file. Generally speaking this should be set to `True` in case the server looses power unexpectedly. It should be set to `False` you are posting a lot of images at once. You should also be aware that if `atomic_saving` is enabled, it will synchronize all writes to and from the temp file which is probably excessive.
**`tmp_dir:`** The temporary directory to use if `atomic_saving` is set to `True`. The default location is `/var/tmp`.
@ -105,14 +105,14 @@ Below is an explanation of each keyword:
* **`name:`** String value. The name of the profile. This is mainly used to help you identify what profile is being applied to posts. This information is printed by the bot, but is otherwise unused.
* **`path:`** String value. This should be a Unix path with wildcards. The bot will configure posts accordingly by using [Unix filename pattern matching](https://docs.python.org/3/library/fnmatch.html) implemented in the `fnmatch` python library.
* **`path:`** String value. This should be a Unix path with wild cards. The bot will configure posts accordingly by using [Unix filename pattern matching](https://docs.python.org/3/library/fnmatch.html) implemented in the `fnmatch` python library.
* **`message:`** A tuple of strings. The message. Each string in the tuple will be placed on a new line.
* **`spoiler:`** Boolean value. Mark the media as sensitive. Use for nsfw or spoilers.
## Setting Up Profiles in a Single Line
At the top of the default configuration file are the following three helper functions to make setting up posts more intuative.
At the top of the default configuration file are the following three helper functions to make setting up posts more intuitive.
>**`setup_profile(name, path, spoiler, *message)`**
**`setup_nsfw_profiles(name, path, *message)`**
**`setup_safe_profiles(name, path, *message)`**
@ -123,7 +123,7 @@ Returns a post setting dictionary that contains all of the information about a s
* **`name:`** The name of the profile.
* **`path:`** A Unix path with wildcards.
* **`path:`** A Unix path with wild cards.
* **`spoiler:`** Mark the media as sensitive. Use for nsfw or spoilers.
@ -136,4 +136,4 @@ Returns a post setting dictionary that contains all of the information about a s
Returns a post_setting dictionary that contains all of the information about a single **nsfw** profile.
**`setup_safe_profiles(name, path, *message)`**
Returns a post_setting dictionary that contains all of the information about a single **safe** profile.
Returns a post_setting dictionary that contains all of the information about a single **safe** profile.