baaahs · xian · Oct 6, 2022 · Oct 7, 2022 · Oct 7, 2022 · Oct 7, 2022
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,82 @@
+version: 2
+jobs:
+  build:
+    branches:
+      ignore: gh-pages
+
+    docker:
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      - image: cimg/openjdk:18.0.2-node
+
+    resource_class: medium+
+
+    working_directory: ~/repo
+
+    environment:
+      NO_GPU: "true"
+
+    steps:
+      - checkout
+
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "build.gradle.kts" }}
+            - v1-dependencies-
+
+      - run:
+          name: Prefetch Dependencies
+          command: |
+            ./gradlew model -PisProduction
+
+      - save_cache:
+          paths:
+            - ~/.gradle
+          key: v1-dependencies-{{ checksum "build.gradle.kts" }}
+
+      - run:
+          name: Build
+          command: |
+            ./gradlew build -PisProduction -xjsBrowserTest --stacktrace --no-daemon --no-parallel --info
+
+      - add_ssh_keys:
+          fingerprints:
+            - "e6:55:46:24:0b:66:40:62:f9:72:10:00:de:41:37:e6"
+
+      - run:
+          name: Save test results
+          command: |
+            mkdir -p build/test-results-circleci
+            find . -type f -regex ".*/build/test-results/.*xml" -exec cp {} build/test-results-circleci/ \;
+          when: always
+
+      - store_test_results:
+          path: build/test-results
+
+      - store_artifacts:
+          path: build/processedResources/js/main
+
+      - store_artifacts:
+          path: build/reports
+
+      - run:
+          name: Deploy to gh-pages
+          command: |
+            if [ "${CIRCLE_BRANCH}" == "main" ]; then
+              mkdir -p build/gh-pages/.circleci
+              cp .circleci/gh-pages-config.yml build/gh-pages/.circleci/config.yml
+
+              cp -r build/dist/js/productionExecutable/* build/gh-pages
+
+              # don't ignore files starting with _
+              touch build/gh-pages/.nojekyll
+
+              echo "Build ${CIRCLE_BUILD_NUM:-unknown} at `date`." > build/gh-pages/BUILT.txt
+
+              git config --global user.email "[email protected]"
+              git config --global user.name "CI Builder"
+
+              mkdir -p deploy/node_modules
+              npm install --prefix deploy --silent [email protected]
+              `npm bin --prefix deploy`/gh-pages --dotfiles --message "Auto deploy" --dist build/gh-pages
+            fi
diff --git a/.circleci/gh-pages-config.yml b/.circleci/gh-pages-config.yml
@@ -0,0 +1,5 @@
+version: 2
+jobs:
+  build:
+    branches:
+      ignore: gh-pages # prevent gh-pages from triggering circleci
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,5 @@
 build
 .idea
+.gradle
+node_modules
+.DS_Store
diff --git a/CMakeLists.txt b/CMakeLists.txt
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,91 @@
+# BAAAHS Code of Conduct
+
+## 1. Purpose
+
+A primary goal of BAAAHS (Big-Ass Amazingly Awesome Homosexual Sheep) is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe and welcoming environment for all, regardless of age, gender, sexual orientation, sexual position (top, bottom, versatile), ability, ethnicity, socioeconomic status, technical ability, fashion-sense, and religion (or lack thereof).
+
+This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
+
+We invite all those who participate in BAAAHS to help us create safe and positive experiences for everyone.
+
+## 2. Open Culture Citizenship
+
+A supplemental goal of this Code of Conduct is to increase open culture citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
+
+Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
+
+If you see someone who is making an extra effort to ensure our community is welcoming, friendly, and encourages all participants to contribute to the fullest extent, we want to know.
+
+## 3. Expected Behavior
+
+The following behaviors are expected and requested of all community members:
+
+  * Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
+  * Exercise consideration and respect in your speech and actions.
+  * Attempt collaboration before conflict.
+  * Refrain from demeaning, discriminatory, or harassing behavior and speech.
+  * Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
+  * Remember that community event venues may be shared with members of the public; please be respectful to all patrons of these locations.
+
+## 4. Unacceptable Behavior
+
+The following behaviors are considered harassment and are unacceptable within our community:
+
+  * Violence, threats of violence or violent language directed against another person.
+  * Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
+  * Posting or displaying violent material.
+  * Posting or threatening to post other people's personally identifying information ("doxing").
+  * Personal insults, particularly those related to gender, sexual orientation, sexual position, race, religion, or disability.
+  * Inappropriate photography or recording.
+  * Inappropriate physical contact. You should have someone's consent before touching them.
+  * Unwelcome sexual attention. This includes, inappropriate touching, groping, and unwelcomed sexual advances without consent.
+  * Deliberate intimidation, stalking or following (online or in person).
+  * Advocating for, or encouraging, any of the above behavior.
+  * Sustained disruption of community events, including talks, presentations, and parties.
+
+## 5. Weapons Policy
+
+No weapons will be allowed at BAAAHS events, community spaces, or in other spaces covered by the scope of this Code of Conduct. Weapons include but are not limited to guns, explosives, and large knives such as those used for hunting or display, as well as any other item used for the purpose of causing injury or harm to others. Anyone seen in possession of one of these items will be asked to leave immediately, and will only be allowed to return without the weapon. Community members are further expected to comply with all state and local laws on this matter.
+
+## 6. Consequences of Unacceptable Behavior
+
+Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
+
+Anyone asked to stop unacceptable behavior is expected to comply immediately.
+
+If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
+
+## 7. Reporting Guidelines
+
+If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. Use our email: [email protected]
+
+Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.
+
+## 8. Addressing Grievances
+
+If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify [email protected] with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
+
+
+## 9. Scope
+
+We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues--online and in-person--as well as in all one-on-one communications pertaining to community business.
+
+This code of conduct and its related procedures also applies to unacceptable behavior occurring outside the scope of community activities when such behavior has the potential to adversely affect the safety and well-being of community members.
+
+## 10. Contact info
+
+[email protected]
+
+## 11. License and attribution
+
+The BAAAHS Code of Conduct is a fork of the Citizen Code of Conduct. The Citizen Code of Conduct is distributed by [Stumptown Syndicate](http://stumptownsyndicate.org) under a [Creative Commons Attribution-ShareAlike license](http://creativecommons.org/licenses/by-sa/3.0/).
+
+Portions of text derived from the [Django Code of Conduct](https://www.djangoproject.com/conduct/) and the [Geek Feminism Anti-Harassment Policy](http://geekfeminism.wikia.com/wiki/Conference_anti-harassment/Policy).
+
+_Revision 2.3. Posted 6 March 2017._
+
+_Revision 2.2. Posted 4 February 2016._
+
+_Revision 2.1. Posted 23 June 2014._
+
+_Revision 2.0, adopted by the [Stumptown Syndicate](http://stumptownsyndicate.org) board on 10 January 2013. Posted 17 March 2013._
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013-2019 BAAAHS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,6 +1,151 @@
-# BAAAHS Simulator 2
+# Sparkle Motion
+
+[![CircleCI:main](https://circleci.com/gh/baaahs/sparklemotion.svg?style=svg)](https://circleci.com/gh/baaahs/sparklemotion)
+
+Sparkle Motion is the system used to control the lights on [BAAAHS](http://baaahs.org), but it's
+designed so it could be applied to pretty much any lighting project. It includes a browser-based
+light show designer and performance interface, 3D light mapping, IP-based control protocol, and
+custom LED control hardware and firmware. We designed it all pretty much from scratch, because
+we're nerds. We hope you'll have some fun with it and maybe find it useful.
+
+| ![SparkleMotionDemo-20220308](https://user-images.githubusercontent.com/40298/157351650-5b3338b7-757a-4e76-bfe2-743a06bb2891.gif) | <img src="/brc-2019.gif" alt="BAAAHS at BRC 2019" width="400"> |
+| --- | --- |
+| The Sparkle Motion [Simulator](https://baaahs.github.io/sparklemotion) | BAAAHS at Black Rock City, 2019 |
+
+
+> **tl;dr:**
+>
+> Shows are built out of small scripts called shaders, which are written in
+> [GLSL](https://www.khronos.org/opengl/wiki/Core_Language_(GLSL)). Lots of [awesome](http://glslsandbox.com/)
+> [free](https://www.shadertoy.com/) shaders and [dev](https://github.com/radixzz/awesome-glsl)
+> [tools](https://shaderfrog.com/) already exist on the internet. In the show designer, you can create or
+> import shaders, and attach them to buttons or sliders in a customizable performance UI. Shaders can be
+> combined in interesting ways to create new effects. You can make shows reactive to the environment by
+> connecting external sensor data—like a beat detector, midi controller, sound spectral analysis, or a
+> webcam—to shader variables.
+>
+> Sparkle Motion can control LED strips using
+> [sACN](https://artisticlicenceintegration.com/technology-brief/technology-resource/sacn-and-art-net/)
+> or our custom IP protocol, and Sharpy-style moving heads
+> over DMX, but it could be extended to control pretty much any kind of device. Lights can be mapped to a
+> 3D model using computer vision. Individual lighting fixtures, or groups of fixtures, can be controlled
+> separately. All types of lights are controlled using the same language and idioms.
+>
+> On the hardware side, Sparkle Motion includes specs for an ESP32-based controller which you could build
+> (or [buy from us](mailto:[email protected])!) managing WS2812-family LEDs, which is controlled over
+> Ethernet or WiFi.
+
+----
+
+## Show Designer
+
+A _show_ is a collection of shaders, attached to UI elements, which can be arbitrarily combined and made reactive to the
+environment using sensors,
+
+(more TK)
+
+## Scene Configuration
+
+Sparkle Motion shows may be designed with a specific model and display fixtures in mind, but most shows can be applied to any model and fixtures.
+
+To facilitate this, Sparkle Motion separates configuration of scene elements (the physical model and fixtures) from visuals and the performance interface.
+
+| Term | Definition |
+| --- | --- |
+| **Driver** | A pluggable software component that can talk to specific types of display controller hardware, e.g. Brains, WLED, or DMX USB dongles. |
+| **Controller** | A physical component directly connected to display hardware, e.g. a Sparkle Motion Brain, a WLED controller, or a DMX USB dongle. One or more fixtures may be associated with a controller. |
+| **Fixture** | A physical display device, e.g. a moving head, a pixel array surface (a.k.a. panel), an LED bar, etc. |
+| **Scene/Stage?** | The collection of fixtures under control of Sparkle Motion, which may be identified as model entities, or anonymous. |
+| **Geometry** | The physical shape of a pixel array fixture. |
+| **Model** | A 3-dimensional model to which fixtures may be mapped. Models may be composed of OBJ files and explicitly placed entities. |
+| **Entity** | An object within the model, e.g. a sheep panel or eye. |
+
+Note that in some cases a single controller may control multiple fixtures. Commonly, a physical DMX USB dongle may have
+multiple moving heads attached. It's possible (but less common) for a single brain or WLED controller to be attached to
+multiple physical lighting fixtures.
+
+Also, it's possible for a DMX controller to manage multiple DMX universes, e.g. in the case of a WLED controller
+managing more than 170 pixels.
+
+ERD:
+
+Driver <->* Controller <->* Fixture <->? Entity *<--> Model
+
+A fixture may be *identified* or *anomnymous*.
+
+Identified fixtures are associated with an entity in the model, and therefore have a known position and geometry.
+
+Anonymous fixtures are mostly for stuff like bikers-by. They are randomly placed within the model. Pixel arrays are assumed to be linear.
+
+## Mapper
+
+Sparkle Morton's mapper lets you detect arbitrarily-placed lights on a 2D or 3D model using just a camera
+connected to a laptop.
+
+(more TK)
+
+## Hardware
+
+(more TK)
+
+[More here](brain/sw/README.md).
+
+## Simulator
+
+The entire system can be run within a web browser in simulation mode. Every component is modeled in software
+so you can see how it will behave in the real world.
+
+
+-->
+
+## Old Documentation
+* [Show API](show_api.md) (outdated)
+* [API docs](https://baaahs.github.io/sparklemotion/doc/sparklemotion/) (outdated)
+
+## Prerequisites
+
+1. Install [Java](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)
+    - If using an arm64 mac, DMX device support for the native build of sparklemotion requires an x86 jdk which can be
+      downloaded [here](https://jdk.java.net/archive/).
+    - Make sure to pick a JDK < version 20 as [gradle does not currently
+      support
+it](https://youtrack.jetbrains.com/issue/KT-57669/Add-Java-20-to-JvmTarget).
+1. Open as a gradle project with [IntelliJ](https://www.jetbrains.com/idea/download/)
 
 ## Running from source
 
-* Open as a gradle project with [IntelliJ](https://www.jetbrains.com/idea/download/)
-* Open `src/jsMain/resources/index.html` using "Open in Browser -> Chrome" from IntelliJ context menu
+### Simulator Mode
+
+In simulator mode, most of Sparkle Motion runs within a web browser.
+
+Run this in a shell window; a browser window will open with the simulator:
+
+    ./gradlew --continuous jsRun
+
+### Production Mode
+
+In production mode, Sparkle Motion runs in a JVM process and talks to real hardware.
+
+To start it, run:
+
+    ./gradlew run
+
+If you don't have a Brain running locally, do this too:
+
+    ./gradlew runBrainJvm
+
+When running in this mode you should be able to access the UI at http://localhost:8004 
+
+### Builds the production (minified) js package
+
+To build the production minified js package run:
+
+```
+./gradlew jsBrowserWebpack
+```
+
+## CI & Deployment
+
+Continuous build here: https://circleci.com/gh/baaahs/sparklemotion
+
+Passing builds are automatically deployed here: https://baaahs.github.io/sparklemotion