plugin-helper/README.md

plugin-helper

plugin-helper is an early Python CLI for managing Beat Saber plugins in a mounted Windows BSManager install.

The first implementation focuses on safe local workflows:

• discover BSManager instances
• scan existing Plugins/ and Libs/ files
• read checked-in registry and per-version lockfiles
• generate a machine-readable install plan from local release assets
• apply exactly that plan with backups and install state
• uninstall only files recorded in install state
• back up UserData separately

Default BSManager instance root:

/home/pleb/Windows/Users/pleb/BSManager/BSInstances

Override with --instances-root or PLUGIN_HELPER_INSTANCES_ROOT.

Quick Start

python -m plugin_helper instances
python -m plugin_helper scan --instance 1.40.8
python -m plugin_helper plan --instance 1.40.8 --state-dir .state

Install assets are currently expected to already exist locally, usually under:

.state/instances/<instance>/downloads/

Future milestones will add GitHub release discovery and download.