An ebooks bot for mastodon and pleroma. Forked from https://github.com/AgathaSorceress/mstdn-ebooks
Go to file
Lynne 1fbaf17e3e allow users to specify custom config.json location 2019-08-07 13:46:57 +10:00
.editorconfig don't create infinite loop threads, finally fixes #17 2019-05-04 16:44:57 +10:00
.gitignore added vim swapfiles to gitignore 2019-02-07 10:27:24 -05:00
Dockerfile Add a Dockerfile. 2018-11-14 00:38:07 -06:00
LICENSE initial commit 2018-10-09 11:11:51 +10:00
README.md added documentation and default value for as of yet unimplemented paired punctuation stripping functionality (#25) 2019-07-01 17:19:52 +10:00
app.json oops forgot to add the app.json 2018-12-05 12:48:33 +10:00
config.json added documentation and default value for as of yet unimplemented paired punctuation stripping functionality (#25) 2019-07-01 17:19:52 +10:00
functions.py allow users to specify custom config.json location 2019-08-07 13:46:57 +10:00
gen.py allow users to specify custom config.json location 2019-08-07 13:46:57 +10:00
main.py allow users to specify custom config.json location 2019-08-07 13:46:57 +10:00
reply.py allow users to specify custom config.json location 2019-08-07 13:46:57 +10:00
requirements.txt fixed typo in requirements 2019-07-01 11:14:45 +10:00

README.md

mstdn-ebooks

Lynnear Edition

This version makes quite a few changes from the original, 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. 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
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.
strip_paired_punctuation false If true, mstdn-ebooks will remove punctuation that commonly appears in pairs, like " and (). This avoids the issue of posts that open a bracket without closing it.