Perform live shows with your three.js creations
Clone or download

readme.md

Hedron

Perform live shows with your three.js creations.

Hedron UI

Features

  • 📥Import three.js sketches without having to recompile
  • 🎊 Place multiple sketches in the same scene
  • 🔊 Control variables using audio, MIDI and BPM based LFO
  • 🕹️ Call functions using audio, MIDI and BPM based sequencer
  • ⚡ Define macros to control multiple variables at once
  • ⏲️ Use MIDI clock input or tap tempo to get BPM
  • 🌇🎚️🌋 Create many scenes and crossfade between them
  • 🔍 Preview and compose scenes before displaying them to the audience
  • 🎛️ Use virtual MIDI banks to get the most out of your controllers
  • 💡 Use MIDI Learn to quickly assign controls
  • ⚙️ Support for multiple MIDI control modes (abs, rel1, rel2, rel3)
  • 📽️ Easily send output picture to external display
  • 💾 Save / load using JSON project files

Getting Started

Install

Download the latest release or build from source.

Load trippy example project

  1. If you haven't got the source code, download the latest example projects zip from the releases page.
  2. Choose "Load Existing Project". Locate the repo directory. Open example-projects/trippy/project.json
  3. An alert will appear. Choose "Locate Sketch Folder" and open /example-projects/trippy/sketches
  4. Play it some music, tap BPM, experiment with the controls
  5. 😎

Please note that if you're trying to do this from the source code, you'll want to run yarn from inside the example-projects directory to install dependencies.

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: alex@funwithtriangles.net.

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

If you're making your own sketches, you'll probably want to build Hedron from source. You'll get lots of extra development benefits this way, such as auto refreshing on save.

  1. Make sure Node.js and Yarn are installed on your machine.
  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 dist:dev Run a production build without packaging. Behaves similarly to yarn start in that it will look for a default project and open Chrome DevTools automatically. However it will not do any sort of live refreshing.
yarn dist:example-projects Install dependencies for example projects, zip them and move them to the dist folder
yarn lint Run linting
yarn test Run pre deployment tests (including linting)
yarn test:dev Run tests on file changes (does not include linting)