Merge pull request #6 from dahegyi/0.7

0.7
dahegyi · Oct 29, 2023 · a5bb3f6 · a5bb3f6
2 parents 3d1e0ad + a165e8b
commit a5bb3f6
Show file tree

Hide file tree

Showing 30 changed files with 7,562 additions and 2,843 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,28 @@
+{
+  "parser": "vue-eslint-parser",
+  "parserOptions": {
+    "ecmaVersion": 2020,
+    "sourceType": "module"
+  },
+  "env": {
+    "browser": true,
+    "es2020": true,
+    "node": true
+  },
+  "extends": [
+    "plugin:vue/vue3-recommended",
+    "eslint:recommended",
+    "plugin:prettier/recommended"
+  ],
+  "plugins": ["prettier"],
+  "rules": {
+    "prettier/prettier": "error"
+  },
+  "ignorePatterns": [
+    "node_modules/*",
+    ".next/*",
+    ".out/*",
+    "!.prettierrc.js",
+    "src/external/*"
+  ]
+}
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -0,0 +1,4 @@
+{
+  "**/*.{js,vue}": ["eslint --fix"],
+  "**/*.{css,scss,vue}": ["stylelint --fix"]
+}
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,3 @@
+{
+  "singleQuote": false
+}
diff --git a/.stylelintrc b/.stylelintrc
@@ -0,0 +1,13 @@
+{
+  "extends": ["stylelint-config-idiomatic-order"],
+  "overrides": [
+    {
+      "files": ["**/*.scss"],
+      "customSyntax": "postcss-scss"
+    },
+    {
+      "files": ["**/*.vue"],
+      "customSyntax": "postcss-html"
+    }
+  ]
+}
diff --git a/README.md b/README.md
@@ -1,29 +1,37 @@
 # hydra+
 
-[![Deploy to Firebase Hosting on merge](https://github.com/dahegyi/hydra-plus/actions/workflows/firebase-hosting-merge.yml/badge.svg)](https://github.com/dahegyi/hydra-plus/actions/workflows/firebase-hosting-merge.yml)
+hydra+ is a double-screen visual editing environment for [hydra synth](https://github.com/hydra-synth/hydra-synth), designed for ease of use and to project live visuals without revealing any code.
 
-A double-screen visual editing environment for [hydra](https://github.com/hydra-synth/hydra-synth).
+### 👉 [Live demo available here](https://hydra-plus.web.app)
 
-[Live demo](https://hydra-plus.web.app)
+**For now, the project is only tested on Chrome on desktop.**
+
+If you have any questions, suggestions, or just want to report a bug, please use the **Issues** / **Discussions** tabs here on Github.
 
 ---
 
-The project uses Vue 3 with Vite.
+### usable key combos:
+
+- hide/show GUI: `Escape`
+- undo: `Ctrl/Cmd + Z`
+- redo: `Ctrl/Cmd + Y` or `Ctrl/Cmd + Shift + Z`
 
-To run the application, install dependencies with
+### known issues:
 
-```
-npm install
-```
+- initSreen() doesn't work properly in visualizer
 
-and run the application with
+### planned features:
 
-```
-npm run dev
-```
+- audio settings modal
+- transition on updates
+- hover info boxes for sources & effects
+- UI for arrays
+- MIDI integration
+- import / export configs
+- built-in extra shaders + option to add new ones from the GUI
+- [1.0] customizable colors for GUI
+- [1.0] implementation of backend server where files and configs can be saved
 
-or build the application with
+---
 
-```
-npm run build
-```
+The project uses Vue 3 with Vuex and Vite. Commands to run and build the program are left the way they are by default (`npm i`, `npm run dev`, `npm run build`).
diff --git a/favicon.ico b/favicon.ico
diff --git a/index.html b/index.html
@@ -1,10 +1,10 @@
-<!DOCTYPE html>
+<!doctype html>
 <html lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>hydra+</title>
-    <script src="https://unpkg.com/hydra-synth"></script>
+    <script type="module" src="./src/external/hydra-three.min.js"></script>
   </head>
   <body>
     <div id="app"></div>
@@ -20,7 +20,9 @@
       }
       gtag("js", new Date());
 
-      gtag("config", "G-G2BSQDGS76");
+      gtag("config", "G-G2BSQDGS76", {
+        storage: "none",
+      });
     </script>
   </body>
 </html>