crashkeys.dev
Source code for my personal quote bot project.
Updated README to reflect new changes to the codebase.
+5
-4
+5
-4
README.md
+5
-4
README.md
···
6
6
7
7
Each subfolder is designated with a specific purpose:
8
8
9
-
- `src/`: This directory contains **every** quote added to the repository in the form of **`.txt`** files. Any `.txt` file within this subdirectory is therefore considered a quote by all of the utilities included in the repository, **regardless of its nesting** into any subdirectories. Files whose names end in **any** other extension are ignored.
10
-
- My personal organization for this folder is to dedicate a unique subfolder to each piece of media or series a set of quotes share in common (e.g. `src/ai-tsf` for the "AI: The Somnium Files" game or `src/zero-escape` for the Zero Escape series).
11
-
- This is entirely arbitrary, so any eventual forks are free to adopt the file structure they prefer, so long as quotes are placed under `src/` and end in `.txt`.
9
+
- `schedule_script.py`: This file is the script meant to be executed on a server to periodically post random quotes sampled from `quotes/` at set time intervals. Currently, it assumes all posts are to be sent to [Bluesky](https://blueskyweb.zendesk.com/hc/en-us/articles/19002666608397-What-is-Bluesky) only. Supports fewer features than the Rust rewrite, but is simpler and more convenient to use at the moment.
10
+
- `src/`: This directory contains the **Rust** source code for the quote bot. It connects to a running Redis server to use as persistent storage for its quote queue and supports some more advanced features, as well. Note that it is still a WIP and lacks polish or a proper CLI at the moment.
11
+
- `quotes/`: This directory contains **every** quote added to the repository in the form of **`.txt`** files. Any `.txt` file within this subdirectory is therefore considered a quote by all of the utilities included in the repository, **regardless of its nesting** into any subdirectories. Files whose names end in **any** other extension are ignored.
12
+
- My personal organization for this folder is to dedicate a unique subfolder to each piece of media or series a set of quotes share in common (e.g. `quotes/ai-tsf` for the "AI: The Somnium Files" game or `quotes/zero-escape` for the Zero Escape series).
13
+
- This is entirely arbitrary, so any eventual forks are free to adopt the file structure they prefer, so long as quotes are placed under `quotes/` and end in `.txt`.
12
14
- `util/`: This directory contains various **utility scripts** to manage the quotes stored in the repository.
13
-
- `schedule_script.py`: This file is the script meant to be executed on a server to periodically post random quotes sampled from `src/` at set time intervals. Currently, it assumes all posts are to be sent to [Bluesky](https://blueskyweb.zendesk.com/hc/en-us/articles/19002666608397-What-is-Bluesky) only.
14
15
15
16
> Note that not all files in this repository are currently documented. This has been a personal, private project for a few years and I have used multiple different tools and platforms with it, meaning some scripts present have been abandoned or remain outdated or obsolete.
16
17