Skip to content

Latest commit

 

History

History
103 lines (77 loc) · 4.84 KB

readme.md

File metadata and controls

103 lines (77 loc) · 4.84 KB
Raw

Hedron

Perform live shows with your three.js creations.

Hedron UI

Features

  • 📥 Import three.js sketches on the fly
  • 🎊 Compose scenes with multiple sketches
  • 🔊 Control parameters using audio, MIDI and BPM based LFO
  • 🕹️ Call functions using audio, MIDI and BPM based sequencer
  • ⚡ Define macros to control multiple variables at once
  • ⏲️ Control timing using MIDI clock input or tap the tempo
  • 🎚️ Create many scenes and crossfade between them
  • ✨ Apply post processing effects
  • 🔍 Preview and compose scenes before displaying them to the audience
  • 💡 Use MIDI Learn to quickly assign controls
  • 🔥 Hot reload your sketches on code changes, without affecting the rest of the scene
  • 🔧 Different UI controls based on value type (e.g. float, boolean, string)
  • ⚙️ Support for multiple MIDI control modes (abs, rel1, rel2, rel3)
  • 📽️ Easily send output picture to external display
  • 💾 Save / load using JSON project files

Hedron in action

Polyop Netgrind @ Halifax Pride Craig Lowe

Getting Started

Install

Download the latest release or build from source.

Load example project

  1. Download the latest example projects zip from the releases page. If you've compiled from source, you'll already have the example projects, found in /example-projects.
  2. In Hedron, choose "Load Existing Project". Select one of the project JSON files included in the example projects folder (logo.json is a good start!).
  3. Play it some music, tap BPM, experiment with the controls
  4. 👽

User Guide

Head to the User Guide to learn how to use Hedron.

Creating Sketches

Head to the Creating Sketches Guide to learn how to create sketches.

Get in touch

Made something awesome in Hedron you'd like to share? Need help or have some cool ideas? Let's talk! Find Alex on Twitter: @funtriangles, or email: [email protected].

Contributing to Hedron

If you are having fun with Hedron, we'd love you to help with development. See the repo issues for what needs doing. We're particularly looking for developers who know about:

How to contribute

  • Fork a branch from dev
  • Make changes
  • Make a pull request to dev

Don't worry too much if the tests aren't passing, we can work on that together. :)

Build From Source

Build from source for the latest features (expect bugs!). This also gives you some extra development features such as setting a default project that will always load on start.

  1. Make sure Node.js and Yarn are installed on your machine. (Hedron 0.6.0 has been tested with Node 12.14.1 and Yarn 1.21.1)
  2. Open terminal and run the commands below.
$ git clone https://github.com/nudibranchrecords/hedron.git
$ cd hedron
$ yarn
$ yarn start

yarn start opens the app in dev mode, you'll probably want to close the dev tools on the right hand side of the window.

Run yarn dist to package up the app for best performance and no dev tools. Once the build is complete, you'll find the app inside /dist.

Note for Windows users: Hedron doesn't seem to play nice inside of Windows Subsystem for Linux (WSL). So just install Node and Yarn natively and work like that. If you do get it working with WSL, please let us know via the issues!

Dev scripts

script description
yarn start Run in dev mode
yarn dist Package the app
yarn lint Run linting
yarn test Run pre deployment tests (including linting)
yarn test:dev Run tests on file changes (does not include linting)

Acknowledgements

Hedron has been created using some amazing open-source libraries. Most notably: