waifu-collective
/
toolbox
2
1
Fork 0
Code Issues 2 Pull Requests Releases Wiki Activity

chore: add changelog to the CAI dumper

This commit is contained in:
11b 2022-12-21 16:24:35 -03:00
parent e612386424
commit d6e05e6e5b
1 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
extras/characterai-dumper/README.md
View File

@ -5,15 +5,15 @@ This userscript allows you to download your saved messages with any bot you've e
## How to use
- Install a userscript manager.
- Personally I tested this with [Violentmonkey](https://violentmonkey.github.io/get-it/) on Firefox, but I think Greasemonkey and Tampermonkey should work as well.
- Personally I tested this with [Violentmonkey](https://violentmonkey.github.io/get-it/) on Firefox, but I think Greasemonkey and Tampermonkey should work as well.
- Install the userscript [from here](https://git.fuwafuwa.moe/waifu-collective/toolbox/raw/branch/master/extras/characterai-dumper/characterai-dumper.user.js).
- Now, while you're talking to a character, click on "View Saved Chats" to go to their histories page:
![Where to find "View Saved Chats"](./example-images/01.png)
![Where to find "View Saved Chats"](./example-images/01.png)
- After a few seconds, a `Download` link should pop up next to the "Your past conversations with so-and-so" header:
![What the download link looks like](./example-images/02.png)
![What the download link looks like](./example-images/02.png)
- Clicking on the link will download a `.json` file containing the bot's basic info (name, description, greeting) and all the interactions you've ever had with it.
- If you're a bot creator, you can also head over into the Character Editor to download a bot's definitions:
![Where to find the definitions download](./example-images/03.png)
![Where to find the definitions download](./example-images/03.png)
---
@ -33,10 +33,24 @@ And you'll reach the page that should show the `Download` link.
**NOTE 2:** The script attempts to anonymize the dumped data (it scrubs known sensitive fields and attempts to replace any instances of your name within messages), but if you're paranoid, you should open the downloaded JSON and search for your username/email/display name just to make sure.
## Changelog
- **v1.3:**
- Implemented support for downloading a character's definitions from the Character Editor page.
- Fixed a bug where the `Download` link was not showing up on some bots that had trailing whitespace in their names (e.g. `2B `).
- **v1.2:**
- Fixed a bug where the user's display name was not being redacted inside messages.
- **v1.1:**
- File was renamed so userscript managers pick up that it's a userscript and offer to install automatically.
- If you installed v1.0, you need to manually uninstall and re-install from the new link.
- **v1.0:**
- Initial release.
## Troubleshooting
If the `Download` link doesn't show up after a few seconds and you're on the proper page, check the DevTools console for errors.
The most probable causes of breakage are:
- You have some browser extension which stopped the userscript from loading its external dependencies properly; or
- CharacterAI changed their API around in ways the script didn't expect, and I'll need to release an update.