Installation

English · 한국어

---

Installation

Requirements

• Obsidian Desktop on Windows with Bluetooth LE support (for scale features)
• Acaia Pearl S scale
• Mobile installs work too, but only the record-keeping features are available — see Home

macOS/Linux support depends on @stoprocent/noble platform compatibility and is not tested yet.

Install from release zip

1. Download cubicj-brewing.zip from the latest release
2. Extract the zip. You should see:

   main.js
   manifest.json
   styles.css
   noble/
   

3. Copy all contents into <your-vault>/.obsidian/plugins/cubicj-brewing/
4. Restart Obsidian → Settings → Community plugins → enable CubicJ Brewing

The noble/ folder contains the native BLE addon. Without it the plugin still loads, but scale connection is unavailable — do not omit it.

Build from source

git clone https://github.com/cubicj/CubicJ-Brewing.git
cd CubicJ-Brewing
npm install
npm run build

npm run build runs tests, typecheck, and the production esbuild bundle. Copy main.js, manifest.json, and styles.css into the plugin folder along with a noble/ folder containing the @stoprocent/noble native dependencies.

Development scripts

npm run dev          # watch mode, repo-local only
npm run build        # test → typecheck → production build
npm run test         # vitest (single run)
npm run test:watch   # vitest (watch mode)
npm run check        # typecheck only
npm run lint         # eslint

Updating

Replace the plugin folder contents with the new release zip contents and restart Obsidian. Your data is stored in the vault (not the plugin folder), so updates never touch your records — see Getting Started.