Oxibooru Resonite Screenshot Archive

A tool to archive Screenshots from your Resonite Inventory to Oxibooru.

Froox Example	Phil Example

Note

UserIds have been stripped from the above screenshot.

How to use

Prerequisites

• A Resonite Account
• Bun.sh
  • Might need adjustment if you want to use Node.js with TS.
• A working instance of Oxibooru (Szurubooru might work as well, but wasn't tested.)
  • What is a Booru/Imageboard?
  • Script can be modified, if you only want to have a file export or use a different software.

Install

Note

If you plan on working on the script you should install it with dev-dependencies: bun install

1. Install the required dependencies with bun install --production.
2. Rename dist.env to .env
3. Add logins and tokens to .env
4. Adjust photoLocation in config.json file

Warning

deleteSourcePictures should only be set to true, if you are sure all screenshots have been exported.

Usage

You can run the script by running bun start.

When you made sure it ran smoothly and all pictures are in the booru, you can re-run it with deleteSourcePictures set to true.

Note

The script will skip screenshots that are already added.

Honorable mentions

This project was inspired by yoshs' bash implementation and a great help to deal with Resonite's bson implementation. Also thankies goes out to JayKub for helping otu with coding. I'm new to typescript!. Please don't hurt meeee!

Why

Resonite inventory records have more metadata, then Steam-Screenshots or File-Exports. This allows for extra information, like session names, attendees, camera settings and camera man. All this info can be used nicely inside an Imageboard, like Oxibooru.

Limitations

We can only do as much as Data provides. One major downside to this is, that the default Resonite cameras include all the users that are in a session. This makes it still somewhat hard to browse for pictures about yourself - cause you are in every session, when you take the pictures. Maybe there will be a camera one day that only adds the users that are in a picture.

Design Choices

Split Design

The script is intentionally split in two parts to make tit easy to fork this project and use your own self-hosted booru or export to some file-format - without the need to reinvent the wheel.

No npm package?

First and foremost this script was created for me, myself and I, to fit my weird requirements and power-user needs. If there is any interest by users we can make the resonite api parts into a package. But as it stands right now, there is no interest on my end yet.

No Resonite multiple and nested folder support

I decided to scrap the idea of importing multiple and nested folders. All pictures are tagged with all the information already.

A Booru as storage

It was considered to maybe run Immich, but that is more useful for IRL pictures. I use both for other projects felt a booru is the best way to store pictures like this, because Since there is a lot of information the screenshots can be sorted by.

ToDo-List

• Support for oxibooru categories
• Remove tags, that are only used once
  • Limit Timestamp to Hours
  • texture_asset
• Get usernames from Resonite API and add as tags
• Split code into modular system to support more export methods
• Support for saved image-grabbers/slurpers
• Oxibooru specific
  • Support for oxibooru pools and group meets together some way.
  • Consolidate tags in Oxibooru
    • UserIds with usernames
    • session with and without prefix
  • Make "safety"-level more configurable
  • Add exported data to Oxibooru's description field.