Skip to content

Latest commit

 

History

History
46 lines (40 loc) · 1.45 KB

README.md

File metadata and controls

46 lines (40 loc) · 1.45 KB
Raw

Kodtrol

Kodtrol screenshot Above is a screenshot of a demo song project, LOOK MUM NO COMPUTER - GRANDMA'S MONEY
Other demos:

⚠️ Note: this software is still in alpha stage. Use at your own risk; expect breaking changes without prior notice.

Features roadmap (in no particular order)

  • Open Fixture Library integration
  • OSC/MSC/Serial outputs
  • MIDI timecode sync
  • Helpers Hub (where users can post their script helpers and share them)
  • Manual and docs on kodtrol.com

Local development / run from source

Requirements

  • Node.js: ^18.0.0
  • npm: ^9.0.0
  • Linux only: libasound2-dev package

Clone the repository and cd into it.
Then:

npm install
npm run build:addons
npm run watch:renderer

And in another terminal, run:

npm start

Note that when starting the app the first time, you won't have an active project preloaded yet. Just go to File > Create project... to create one. If all goes well, you should see the Welcome Screen allowing you to create a new project or open an existing one.

Local release build

Make sure you have installed the requirements from Local development above, then:

npm install
npm run build:addons
npm run build-and-dist

The build will be generated in the dist folder.