Merge pull request #2 from hexxone/custom

Merge custom branch into master

.github/workflows/main.yml

@@ -0,0 +1,24 @@
+name: Automatic JsDoc pages
+
+on:
+  push:
+    branches:
+      - custom
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Build
+        uses: andstor/jsdoc-action@v1
+        with:
+          config_file: jsdoc.json
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
+          publish_dir: ./docs

.gitignore

@@ -0,0 +1,120 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+*.wasm
+*.wasm.map
+*.asm.js

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "src/wasc-worker"]
+	path = src/wasc-worker
+	url = https://github.com/hexxone/wasc-worker.git
+[submodule "src/three.ts"]
+	path = src/three.ts
+	url = https://github.com/hexxone/three.ts
+[submodule "src/worker-loader-fork"]
+	path = src/worker-loader-fork
+	url = https://github.com/hexxone/worker-loader-fork.git

README.md

@@ -0,0 +1,41 @@
+# [we_utils](https://github.com/hexxone/we_utils)
+
+## A collection of utilities, mostly usefull when creating Wallpaper-Engine Web-Wallpapers with TypeScript & Webpack
+
+I created this repository since I was previously copying back-and-forth lots of code between projects.
+Keeping track of this stuff manually is annoying...
+
+## [Documentation](https://hexxone.github.io/we_utils)
+
+## TODO
+
+- fix RenamerPlugin in Prod (Terser Compression)
+
+### Dependencies / Libraries
+
+- [TypeScript](https://www.typescriptlang.org/) for typization
+- [three.js](https://threejs.org/) & Examples for webgl rendering
+- [WebAssembly](https://webassembly.org/) for more efficient processing
+- [AssemblyScript](https://www.assemblyscript.org/) for compiling "ASC" -> "WASM"
+- [wasc-worker](https://github.com/hexxone/wasc-worker) for ez AssemblyScript workers
+- [cookieconsent](https://github.com/osano/cookieconsent) thanks to EU laws
+
+### Features / Contents
+
+- OfflineWorker
+- AssemblyScript Webpack Builder
+- AssemblyScript WebAssembly Module Loader
+- CComponent & CSettings Helpers
+- Wallpaper Engine Audio Supplier (WEAS)
+- "document.ready" shorthand
+- ReloadHelper for displaying a loading bar
+- Smallog Logging & Filtering
+- WarnHelper for Seizure warnings
+- Wallpaper Engine iCUE Library (WEICUE)
+- Wallpaper Engine Wallpaper Adapter (WEWWA)
+- Stats.js definition file
+
+### Used by
+
+- [AudiOrbits](https://github.com/hexxone/audiorbits)
+- [ReactiveInk](https://github.com/hexxone/ReactiveInk)