about summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--README.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/README.md b/README.md index 2e271a3..b54d0bf 100644 --- a/README.md +++ b/README.md
@@ -1,11 +1,11 @@
1# yandere 1# yandere
2Simple text substitution Twitter bot in the vein of [chemist](https://github.com/hatkirby/chemist), but without the dependency on [verbly](https://github.com/hatkirby/verbly). Tweets every hour, generating text based off of a data file constructed with a simple syntax. 2Simple text substitution Mastodon bot in the vein of [chemist](https://github.com/hatkirby/chemist), but without the dependency on [verbly](https://github.com/hatkirby/verbly). Posts every hour, generating text based off of a data file constructed with a simple syntax.
3 3
4It uses my Twitter library [libtwitter++](https://github.com/hatkirby/libtwittercpp) to post to Twitter, and [YAMLcpp](https://github.com/jbeder/yaml-cpp) to read a configuration file. 4It uses [mastodonpp](https://schlomp.space/tastytea/mastodonpp) to post to Mastodon, and [YAMLcpp](https://github.com/jbeder/yaml-cpp) to read a configuration file.
5 5
6Examples of `yandere` bots: 6Examples of `yandere` bots:
7 7
8- [@bbbbbbbbbbbaka](https://twitter.com/bbbbbbbbbbbaka) (d-su), which posts inside jokes that no one understands 8- [@baka@beppo.online](https://beppo.online/@baka) (d-su), which posts inside jokes that no one understands
9 9
10## Syntax 10## Syntax
11 11
@@ -81,12 +81,10 @@ There is one "special" group name: `{\n}` is always replaced by a newline.
81 81
82## Configuration 82## Configuration
83 83
84When you run `yandere`, you pass it the path of a configuration file that tells the bot where to look for its datafile, which it calls "forms". As explained above, this datafile should at least have a group named `MAIN`. The bot also reads the details for authenticating with Twitter from this configuration file. This file should have the following format, with the appropriate tokens inserted between the appropriate pairs of double quotes: 84When you run `yandere`, you pass it the path of a configuration file that tells the bot where to look for its datafile, which it calls "forms". As explained above, this datafile should at least have a group named `MAIN`. The bot also reads the details for authenticating with Mastodon from this configuration file. This file should have the following format, with the appropriate tokens inserted between the appropriate pairs of double quotes:
85```yaml 85```yaml
86--- 86---
87 consumer_key: "" 87 mastodon_instance: ""
88 consumer_secret: "" 88 mastodon_token: ""
89 access_key: ""
90 access_secret: ""
91 forms: "data.txt" 89 forms: "data.txt"
92``` 90```