Go to file
Kris Anderson 641a38250c
docs: add repo-root CLAUDE.md as AI agent entry point
slopsmith-desktop had no CLAUDE.md, so an AI agent landing in this
repo had no obvious starting point — README.md is install-focused
(Windows/macOS/Linux download instructions) and wouldn't lead an
agent to docs/. Adding a brief root-level guide that:

- Orients the agent on what this repo is vs the sister
  byrongamatos/slopsmith repo (audio engine + Electron shell here;
  library + chart parsing + visualization there)
- Indexes docs/ contents
- Cross-links the slopsmith-side docs that describe what consumes
  the IPC surface this engine exposes
- Captures the threading invariants, build-flag list, common
  gotchas (audio rebuild lock, ELECTRON_RUN_AS_NODE, port 18000)
  in one place rather than scattered across CLAUDE.md fragments
  in the dev workspace

Modelled on slopsmith/CLAUDE.md's style — technical-but-
conversational, ATX headings, file paths in backticks, link-heavy.
Keeps the new audio-engine-architecture.md as the canonical deep-
dive; this file is a navigation hub.

Signed-off-by: Kris Anderson <topkoa@gmail.com>
(cherry picked from commit caac6aa9ea8354a489ee557a54193415fe416c9a)
2026-06-17 23:41:27 -07:00
.claude/skills Clean release snapshot 2026-06-16 18:48:12 +02:00
.devcontainer ci: repoint desktop build off the deleted slopsmith org 2026-06-17 00:47:43 +02:00
.github/workflows Remove FUNDING.yml (no Sponsor button / funding surface) 2026-06-17 11:52:46 +02:00
.packages Clean release snapshot 2026-06-16 18:48:12 +02:00
.specify Clean release snapshot 2026-06-16 18:48:12 +02:00
cmake Clean release snapshot 2026-06-16 18:48:12 +02:00
docs docs: add audio engine architecture overview 2026-06-17 23:41:27 -07:00
JUCE@9971c75b2c Clean release snapshot 2026-06-16 18:48:12 +02:00
resources Remove corrupt mesa_cab.wav IR (HTML, never a valid WAV) 2026-06-17 11:57:54 +02:00
scripts build: bundle loosefolder + strum-fighter plugins 2026-06-17 09:50:10 +02:00
src Repoint dead slopsmith URLs -> got-feedback 2026-06-17 11:02:09 +02:00
tests Clean release snapshot 2026-06-16 18:48:12 +02:00
.build-config.json ci: host soundfonts on the public feedback-soundfonts repo 2026-06-17 01:09:38 +02:00
.gitignore Clean release snapshot 2026-06-16 18:48:12 +02:00
.gitmodules Clean release snapshot 2026-06-16 18:48:12 +02:00
CLAUDE.md docs: add repo-root CLAUDE.md as AI agent entry point 2026-06-17 23:41:27 -07:00
CMakeLists.txt Clean release snapshot 2026-06-16 18:48:12 +02:00
CONTRIBUTORS.md Clean release snapshot 2026-06-16 18:48:12 +02:00
LICENSE Clean release snapshot 2026-06-16 18:48:12 +02:00
package.json Clean release snapshot 2026-06-16 18:48:12 +02:00
README.md ci: repoint desktop build off the deleted slopsmith org 2026-06-17 00:47:43 +02:00
THIRD_PARTY_LICENSES.md Clean release snapshot 2026-06-16 18:48:12 +02:00
tsconfig.json Clean release snapshot 2026-06-16 18:48:12 +02:00
WINDOWS_BUILD_REQUIREMENTS.md Repoint dead slopsmith URLs -> got-feedback 2026-06-17 11:02:09 +02:00

Slopsmith Desktop

Standalone cross-platform desktop app that wraps Slopsmith with integrated VST hosting, amp modeling, audio I/O, and full plugin support.

Install

Prebuilt installers for the latest tagged release are published on the GitHub Releases page.

Platform Download Notes
Windows 10/11 (x64) Slopsmith.Setup.<version>.exe NSIS installer. On first run Windows SmartScreen may warn — click More info → Run anyway.
macOS 12+ (Apple Silicon) Slopsmith-<version>-arm64.dmg Signed & notarized. Intel Macs are not currently published — build from source.
Linux (x86_64) Slopsmith-<version>.AppImage chmod +x then run. Portable, no install step.
Debian / Ubuntu (x86_64) slopsmith-desktop_<version>_amd64.deb sudo apt install ./slopsmith-desktop_<version>_amd64.deb

First launch may take a minute or two while ML model caches populate in the app cache directory. Subsequent launches are fast.

There is currently no Homebrew, winget, Chocolatey, Scoop, Flatpak, or Snap distribution — download directly from Releases. The app does not yet ship an auto-updater; check Releases periodically for new versions.