Neshura/aob-lemmy-bot
Neshura/aob-lemmy-bot
1
0
Fork 0
Code Issues 9 Pull requests Projects 1 Releases 62 Packages Wiki Activity Actions

Update README
All checks were successful
Run Tests on Code / run-tests (push) Successful in 0s
Details

Browse source
This commit is contained in:
Neshura 2023-12-18 14:22:42 +01:00
parent 6e5d8d27fd
commit 57c9891d9b
Signed by: Neshura
GPG key ID: B6983AAA6B9A7A6C
1 changed files with 48 additions and 50 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

98
README.md
View file

@ -1,59 +1,57 @@
# ascendance-of-a-bookworm-bot # ascendance-of-a-bookworm-bot
**secrets.json** **.env**
```json ```bash
{ LEMMY_USERNAME="BotUserName"
"lemmy": { LEMMY_PASSWORD="BotPassword"
"username": "string",
"password": "string"
},
"reddit": {
"app_id": "string",
"app_secret": "string",
"refresh_token": "string",
"redirect_uri": "string"
},
"discord": {}
}
``` ```
*Note: Passwords containing special characters might need to be escaped using '\'*
**config.toml** **config.toml**
```toml ```toml
[urls] instance = "https://lemmy.example.org"
instance = "base URL of Lemmy Instance" status_post_url = "PostUrlForStatusMonitoring"
uptime_kuma = "Uptime Kuma Ping URL" config_reload_seconds = 10800
[settings] protected_communities = [ "community_where_pins_should_stay" ]
config_reload = 360 # Time in Minutes between Config reloads
[[series]]
slug = "example-slug"
parted = false
[series.prepub_community]
name = "communityforprepubs"
[series.prepub_community.pin_settings]
pin_new_post_local = true
pin_new_post_community = true
[series.prepub_community.post_body]
body_type = "Custom"
body_content = """
Custom Text for the Post\n\n\
Can contain new lines and [links](https://join-lemmy.org)"""
[series.volume_community]
name = "communityforvolumes"
[series.volume_community.pin_settings]
pin_new_post_local = false
pin_new_post_community = true
[series.volume_community.post_body]
body_type = "Description"
[[feeds]] [[series]]
id = 0 # incrementor, only used for correctly matching post history data slug = "example-slug-2"
series_slug = "ascendance-of-a-bookworm" # series slug on J-Novel Club parted = true
[series.prepub_community]
[communities] name = "communityforprepubs"
chapter = "aobprepub" # Community for Chapter Posts of the Series [series.prepub_community.pin_settings]
volume = "aoblightnovel" # Community for Volume Posts of the Series pin_new_post_local = false
pin_new_post_community = false
[series.prepub_community.post_body]
[[feeds]] # See previous example body_type = "Custom"
id = 1 body_content = "single line content"
series_slug = "ascendance-of-a-bookworm-short-story-collection" [series.volume_community]
name = "communityforvolumes"
[communities] [series.volume_community.pin_settings]
chapter = "aobprepub" pin_new_post_local = false
volume = "aoblightnovel" pin_new_post_community = false
``` [series.volume_community.post_body]
body_type = "None"
posts.json ```
```json
[
{
"id": number,
"title",
"last_volume_slug": "string",
"last_volume_time": "string",
"last_part_slug": "string",
"last_part_time": "string"
}
]