Merge pull request #12 from NotMyWing/evangelion-rebuilds

Rebuild of Evangelion

Author: NotMyWing

.luarc.json

@@ -0,0 +1,5 @@
+{
+  "workspace.ignoreDir": [
+    "src/lua/entities/gmod_wire_expression2"
+  ]
+}

NOTICE

@@ -1,27 +1,24 @@
 # The Moonpanel
 
-Puzzle panels, written in moon language. As inspired by The Witness, a game by Thekla Inc.
-Initially written for Starfall/StarfallEx, now a separate addon.
+A Garry's Mod addon for Witness-style puzzle panels. It is written in
+MoonScript and compiled to Lua.
 
-If you don't understand the puzzle mechanics, then perhaps you should play The Witness.
+The project started as a Starfall/StarfallEx experiment and grew into its own
+addon. The Witness is the obvious inspiration. [You should play The Witness](https://store.steampowered.com/app/210970/The_Witness/).
 
-## Getting Started
+## Development
 
-TBA.
-
-## Build and package
-
-Install Node.js, npm, LuaJIT, and LuaRocks. Install MoonScript through
-LuaRocks, then install the project dependencies and run the test suite:
+Install Node.js, LuaJIT, LuaRocks, and MoonScript. Then install the Node
+dependencies and run the tests:
 
 ```sh
 luarocks install moonscript
 npm ci
 npm test
 ```
 
-`npm test` compiles the addon into `dest/`, runs the Lua and LuaJIT tests,
-and checks a temporary GMA package.
+`npm test` rebuilds `dest/`, runs the Lua and LuaJIT suites, and smoke-tests a
+temporary GMA package.
 
 Create the distributable files with:
 
@@ -31,49 +28,44 @@ npm run package:zip
 npm run verify:package
 ```
 
-The GMA, ZIP, and manifest are written to `artifacts/`. The GMA writer is
-implemented in Node and does not require Garry's Mod or `gmad`. To also check
-the archive with an installed official `gmad`, set `MOONPANEL_GMAD` when
-running `npm run verify:package`.
+The GMA, ZIP, and manifest go in `artifacts/`. The GMA writer is implemented
+in Node, so it does not need Garry's Mod or `gmad`. If `gmad` is installed,
+set `MOONPANEL_GMAD` when running `npm run verify:package` to check the archive
+with it too.
 
-For live development, use `npm run watch`. It updates files in place using
-atomic writes. If generated output is stale, `npm run rebuild` removes and
-recreates `dest/` before building.
+For live development, use `npm run watch`. It rebuilds generated files in
+place. If `dest/` gets stale, run `npm run rebuild`.
 
-## Built With
+## Tools
 
 * [Node.js](https://nodejs.org/)
 * [LuaJIT](https://luajit.org/)
 * [LuaRocks](https://luarocks.org/)
 * [Moonscript](https://moonscript.org)
 
-## Contributing
-
-TBA.
-
-## Authors
+## People
 
 * **NotMyWing** - [NotMyWing](https://github.com/NotMyWing)
 
-## License
+## Code and assets
 
-Moonpanel source code is licensed under the Apache License, Version 2.0, as
-declared in `package.json`. Redistributions and derivatives must retain the
-copyright, license, and attribution notices, and modified files must identify
-their changes. See [`LICENSE`](LICENSE) and [`NOTICE`](NOTICE).
+Moonpanel's code is Apache 2.0; see [`LICENSE`](LICENSE).
 
-All The Witness-derived visual assets, audio assets, and other original game
-content are strictly credited to Thekla, Inc. They remain the property of
-Thekla, Inc. and are not relicensed under the Apache License.
+Some code and assets came from other projects. See
+[`THIRD_PARTY_NOTICES.md`](THIRD_PARTY_NOTICES.md) for the list. The Witness
+assets belong to Thekla and are not relicensed here.
 
-## Acknowledgments
+## Credits
 
-* **Thekla, Inc. and Jonathan Blow** - *The Witness, its puzzle language, original visual and audio assets, and the primary inspiration for this project.*
-* [TheFifthMatt](https://windmill.thefifthmatt.com/) - *The existence of The Windmill inspired this project and its later dedicated importer.*
-* [Tyler Schrock](https://github.com/Tschrock) - *The Windmill importer.*
-* [Soojin Nam](https://github.com/sjnam/lua-dancing-links) - *Lua Dancing Links*
-* [thegrb93 and contributors](https://github.com/thegrb93/StarfallEx/) - *StarfallEX and the panel rendering codebase*
-* [BytewaveMLP](https://github.com/BytewaveMLP) - *Buildscript*
+* **Thekla, Inc. and Jonathan Blow** — The Witness and the puzzle language that
+  started this whole thing.
+* [TheFifthMatt](https://windmill.thefifthmatt.com/) — The Windmill.
+* [Tyler Schrock](https://github.com/Tschrock) — The Windmill importer.
+* [thegrb93 and contributors](https://github.com/thegrb93/StarfallEx/) — The
+  StarfallEx panel code this grew out of.
+* [WireMod contributors](https://github.com/wiremod/wire) — The editor-presence
+  animation we adapted.
+* [BytewaveMLP](https://github.com/BytewaveMLP) — Buildscript work.
 
 ## WireMod and Expression 2
 

README.md

@@ -0,0 +1,19 @@
+# Third-party notices
+
+## WireMod
+
+Moonpanel's editor-presence animation is based on WireMod's Expression 2
+"in editor" animation. Moonpanel swaps the gears for clue sprites.
+
+- Copyright the WireMod contributors
+- Source: https://github.com/wiremod/wire/blob/master/lua/wire/stools/expression2.lua
+- License: Apache License 2.0
+
+## The Witness
+
+Moonpanel is inspired by The Witness's puzzle language and presentation.
+The Witness is by Thekla, Inc. and Jonathan Blow. Its original code, art,
+audio, and other assets are not part of Moonpanel's Apache License 2.0.
+
+- Website: https://the-witness.net/
+- Rights holder: Thekla, Inc.

THIRD_PARTY_NOTICES.md

@@ -15,8 +15,7 @@ WireMod is optional. Moonpanel works without it.
 | --- | --- |
 | `Powered` | Whether the panel is powered. |
 | `Solved` | Whether the panel is solved. With erasers, this changes after the eraser feedback finishes. |
-| `Errored` | Whether the most recent terminal evaluation reported an error. |
-| `Success` | Legacy numeric success output. It follows the historical eraser delay. |
+| `Errored` | Whether the most recent terminal evaluation failed; with erasers, it latches after feedback. |
 | `SolvedPulse` | One pulse for a successful terminal evaluation. |
 | `FailedPulse` | One pulse for an unsuccessful terminal evaluation. |
 | `AbortedPulse` | One pulse when an active trace is aborted. |
@@ -32,8 +31,7 @@ saves.
 WireMod loads the optional Moonpanel E2 extension, which provides:
 
 `moonpanelPowered`, `moonpanelSolved`, `moonpanelErrored`, `moonpanelPath`,
-`moonpanelRevision`, `moonpanelWidth`, `moonpanelHeight`, `moonpanelCell`,
-`moonpanelData`, and owner-checked `moonpanelReset`.
+`moonpanelRevision`, `moonpanelWidth`, `moonpanelHeight`, and owner-checked
+`moonpanelReset`.
 
-`moonpanelData` is limited to 8192 characters. `moonpanelReset` clears the
-current run without changing the puzzle layout.
+`moonpanelReset` clears the current run without changing the puzzle layout.

docs/WIREMOD.md

@@ -23,6 +23,10 @@ const MODEL_GLOBS = [
 	'src/models/**/*',
 ];
 
+const STATIC_DATA_GLOBS = [
+	'src/data_static/**/*',
+];
+
 const METADATA_GLOBS = [
 	'src/addon.json',
 ];
@@ -114,7 +118,7 @@ function moon() {
 		.pipe(compileMoonscript())
 		.pipe(optimizeLua())
 		.pipe(discourageLuaMod())
-		// .pipe(minifyLua())
+		.pipe(minifyLua())
 		.pipe(atomicDest('dest'));
 }
 moon.description = "Compiles moonscript files.";
@@ -167,6 +171,16 @@ function model() {
 }
 model.description = "Copies model files.";
 
+/**
+ * Copies immutable addon-shipped data. Garry's Mod mounts this through GAME;
+ * it is deliberately kept separate from the writable DATA realm.
+ */
+function staticData() {
+	return gulp.src(STATIC_DATA_GLOBS, { base: 'src', since: gulp.lastRun(staticData) })
+		.pipe(atomicDest('dest'));
+}
+staticData.description = "Copies immutable static data files.";
+
 /**
  * Copies metadata files.
  */
@@ -195,7 +209,7 @@ packageZip.description = "Packages the compiled addon as a zip.";
 /**
  * Generates and moves assets.
  */
-const assets = gulp.parallel(materials, sound, model, metadata);
+const assets = gulp.parallel(materials, sound, model, staticData, metadata);
 assets.description = "Generates and copies assets.";
 
 /**
@@ -207,6 +221,7 @@ function watchAssets() {
 			...MATERIAL_GLOBS,
 			...SOUND_GLOBS,
 			...MODEL_GLOBS,
+			...STATIC_DATA_GLOBS,
 			...METADATA_GLOBS,
 		]
 		, assets
@@ -237,6 +252,7 @@ rebuild.description = "Deletes the output tree, then performs a clean build.";
 
 exports.clean = clean;
 exports.materials = materials;
+exports.staticData = staticData;
 exports.assets = assets;
 exports.watchAssets = watchAssets;
 exports.packageZip = packageZip;

gulpfile.js

@@ -18,16 +18,16 @@
     "rebuild": "gulp rebuild",
     "watch": "gulp watch",
     "clean": "gulp clean",
-    "package:gma": "npm run build && node tools/gma.js create --input dest --output artifacts/moonpanel.gma --manifest artifacts/moonpanel.manifest.json",
-    "package:zip": "npm run build && gulp packageZip",
+    "package:gma": "npm run rebuild && node tools/gma.js create --input dest --output artifacts/moonpanel.gma --manifest artifacts/moonpanel.manifest.json",
+    "package:zip": "npm run rebuild && gulp packageZip",
     "verify:package": "node tools/package_smoke.js --require-gma --gma artifacts/moonpanel.gma --manifest artifacts/moonpanel.manifest.json",
-    "test": "npm run build && node tools/sanity.js && node tools/package_smoke.js --temporary"
+    "test": "npm run rebuild && node tools/sanity.js && node tools/package_smoke.js --temporary"
   },
   "devDependencies": {
     "del": "^6.0.0",
     "gulp": "^4.0.2",
     "gulp-zip": "^5.0.2",
-    "luamin": "^1.0.4",
+    "lua-format": "^1.6.1-b",
     "through2": "^4.0.2"
   }
 }

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"title": "The Moonpanel",
-	"description": "Moonpanel source code is licensed under Apache-2.0. The Witness-derived assets remain the property of Thekla, Inc. Credits: Thekla, Inc. and Jonathan Blow; TheFifthMatt for the inspiration behind this project and its later Windmill importer; Tyler Schrock for the Windmill importer.",
+	"description": "Moonpanel source code is licensed under Apache-2.0. The Witness-derived assets remain the property of Thekla, Inc. Credits: Thekla, Inc. and Jonathan Blow; TheFifthMatt for the inspiration behind this project and its later Windmill importer; Tyler Schrock for the Windmill importer; the WireMod contributors for the adapted editor-presence animation.",
 	"type": "tool",
 	"tags": [],
 	"ignore": [