Giter Club home page Giter Club logo

hedron's Introduction

Hedron

Perform live shows with your three.js creations.

Hedron UI

Features

  • πŸ“₯Import three.js sketches without having to recompile
  • πŸŒ‡ Layer up 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
  • πŸŽ›οΈ Use virtual MIDI banks to get the most out of your controller
  • πŸ’‘ 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

A compiled version is not currently available to download, so you'll need to download the source and compile yourself.

  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.

Load trippy example project

  1. Choose "Load Existing Project". Locate the repo directory. Open example-projects/trippy/project.json
  2. An alert will appear. Choose "Locate Sketch Folder" and open /example-projects/trippy/sketches
  3. 😎

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.

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
  • Ensure tests are passing
  • Make a pull request to dev

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 lint Run linting
yarn test Run pre deployment tests (including linting)
yarn test:dev Run tests on file changes (does not include linting)

hedron's People

Contributors

funwithtriangles avatar

Watchers

Jose Leal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.