pleroma-ebooks/README.md

# mstdn-ebooks

**Lynnear Edition**

This version makes quite a few changes from [the original](https://github.com/Jess3Jane/mastodon-ebooks), such as:
- Unicode support
- Non-Markov stuff
- Stores toots in a sqlite database rather than a text file
  - Doesn't unecessarily redownload all toots every time
  
## Install/usage guide
An installation and usage guide is available [here](https://cloud.lynnesbian.space/s/jozbRi69t4TpD95). It's primarily targeted at Linux, but it should be possible on BSD, macOS, etc. I've also put some effort into providing steps for Windows, but I can't make any guarantees as to its effectiveness.

## Compatibility
| Software  | Downloading statuses | Posting | Replying                                                    |
|-----------|----------------------|---------|-------------------------------------------------------------|
| Mastodon  | Yes                  | Yes     | Yes                                                         |
| Pleroma   | Yes                  | Yes     | [No](https://git.pleroma.social/pleroma/pleroma/issues/416) |
| Misskey   | Yes                  | No      | No                                                          |
| diaspora* | No                   | No      | No                                                          |
| Others    | Probably             | No      | No                                                          |

## Configuration
Configuring mstdn-ebooks is accomplished by editing `config.json`.

| Setting | Default | Meaning |
|--------------------|------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| site | https://botsin.space | The instance your bot will log in to and post from. |
| cw | null | The content warning (aka subject) mstdn-ebooks will apply to non-error posts. |
| instance_blacklist | ["bofa.lol", "witches.town", "knzk.me"] | If your bot is following someone from a blacklisted instance, it will skip over them and not download their posts. This is useful for ensuring that mstdn-ebooks doesn't download posts from dead instances, without you having to unfollow the user(s) from them. |
| learn_from_cw | false |  If true, mstdn-ebooks will learn from CW'd posts. |
| mention_handling | 1 |  0: Never use mentions. 1: Only generate fake mentions in the middle of posts, never at the start. 2: Use mentions as normal (old behaviour). |
| max_thread_length | 15 | The maximum number of bot posts in a thread before it stops replying. A thread can be 10 or 10000 posts long, but the bot will stop after it has posted `max_thread_length` times. |
Oops! Wrong Name! 2018-10-10 19:27:49 -07:00			`# mstdn-ebooks`
WIP heroku support 2018-12-04 18:45:03 -08:00
initial commit 2018-10-08 18:11:51 -07:00			`Lynnear Edition`

link back the original source code 2018-10-10 19:27:32 -07:00			`This version makes quite a few changes from [the original](https://github.com/Jess3Jane/mastodon-ebooks), such as:`
initial commit 2018-10-08 18:11:51 -07:00			`- Unicode support`
			`- Non-Markov stuff`
Update README.md better, more descriptive readme 2018-10-10 19:24:58 -07:00			`- Stores toots in a sqlite database rather than a text file`
			`- Doesn't unecessarily redownload all toots every time`

			`## Install/usage guide`
better description for the guide 2018-11-25 21:47:34 -08:00			`An installation and usage guide is available [here](https://cloud.lynnesbian.space/s/jozbRi69t4TpD95). It's primarily targeted at Linux, but it should be possible on BSD, macOS, etc. I've also put some effort into providing steps for Windows, but I can't make any guarantees as to its effectiveness.`
initial commit 2018-10-08 18:11:51 -07:00
added compatibility table 2019-06-30 18:23:06 -07:00			`## Compatibility`
			`\| Software \| Downloading statuses \| Posting \| Replying \|`
			`\|-----------\|----------------------\|---------\|-------------------------------------------------------------\|`
			`\| Mastodon \| Yes \| Yes \| Yes \|`
			`\| Pleroma \| Yes \| Yes \| [No](https://git.pleroma.social/pleroma/pleroma/issues/416) \|`
			`\| Misskey \| Yes \| No \| No \|`
			`\| diaspora* \| No \| No \| No \|`
			`\| Others \| Probably \| No \| No \|`

add an option to avoid creating fake mentions 2019-04-28 21:21:46 -07:00			`## Configuration`
			Configuring mstdn-ebooks is accomplished by editing `config.json`.

			`\| Setting \| Default \| Meaning \|`
			`\|--------------------\|------------------------------\|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\|`
			`\| site \| https://botsin.space \| The instance your bot will log in to and post from. \|`
			`\| cw \| null \| The content warning (aka subject) mstdn-ebooks will apply to non-error posts. \|`
updated blacklist and max_thread_length definitions in readme 2019-07-01 00:05:13 -07:00			`\| instance_blacklist \| ["bofa.lol", "witches.town", "knzk.me"] \| If your bot is following someone from a blacklisted instance, it will skip over them and not download their posts. This is useful for ensuring that mstdn-ebooks doesn't download posts from dead instances, without you having to unfollow the user(s) from them. \|`
add an option to avoid creating fake mentions 2019-04-28 21:21:46 -07:00			`\| learn_from_cw \| false \| If true, mstdn-ebooks will learn from CW'd posts. \|`
			`\| mention_handling \| 1 \| 0: Never use mentions. 1: Only generate fake mentions in the middle of posts, never at the start. 2: Use mentions as normal (old behaviour). \|`
updated blacklist and max_thread_length definitions in readme 2019-07-01 00:05:13 -07:00			\| max_thread_length \| 15 \| The maximum number of bot posts in a thread before it stops replying. A thread can be 10 or 10000 posts long, but the bot will stop after it has posted `max_thread_length` times. \|