greenlight-motion 0.0.0-stage → 0.1.0

package/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+Thank you for helping. A few things to know first.
+
+- **Licence.** The GreenLight Motion Engine is licensed under the [Apache License 2.0](LICENSE). Anything you
+  contribute is licensed under the same terms ("inbound = outbound"); there is no separate agreement to sign.
+- **Sign your commits.** Add a `Signed-off-by: Your Name <you@example.com>` line to each commit
+  (`git commit -s`). It certifies the [Developer Certificate of Origin](https://developercertificate.org/): the
+  contribution is yours to give, or you have the right to submit it under the project's licence.
+- **Where the code comes from.** This repository is published from the GreenLight Dash source on every release.
+  The engine is the same code GreenLight Dash's Video Editor renders with, so a change is checked against the
+  app too before it lands. Accepted pull requests are applied there and come back in the next release.
+- **Tests.** Describe how you checked your change: a project that shows it, a still before and after, the gate
+  you ran. Engine changes need identical pictures for everything they don't mean to change.
+- **Names.** Forks and derived products must use their own name (see [legal/TRADEMARKS.md](legal/TRADEMARKS.md)).
+
+Questions: support@greenlightdash.pro.

package/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/NOTICE

@@ -0,0 +1,23 @@
+GreenLight Motion Engine
+Copyright 2026 WPSOUL
+
+This product includes software developed by WPSOUL (https://greenlightdash.pro/).
+
+Portions of the background shader presets (frontend/src/utils/shaderPresetsLab.js) are ported from the
+`shaders` package (https://shaders.com), Copyright (c) 2026 Shader Effects Inc., MIT License.
+
+The device mockup frames (frontend/src/components/videoEditor/assets/mockupFrames/) are artwork by
+Rafael Fernandez from Wikimedia Commons, licensed CC BY-SA (imac-27.svg: CC BY-SA 3.0,
+https://commons.wikimedia.org/wiki/File:IMac_vector.svg; iphone-17.svg: CC BY-SA 4.0,
+https://commons.wikimedia.org/wiki/File:IPhone_17_Vector.svg). They stay under CC BY-SA, not the Apache
+License.
+
+The third-party libraries inside the engine bundle, with their licences, are listed in
+THIRD_PARTY_LICENSES.md.
+
+Files the engine downloads from the GreenLight CDN when a project uses them (sounds, 3D device presets,
+lighting environments) are not part of this software and are not covered by the Apache License; see
+legal/THIRD_PARTY_ASSETS.md and legal/README.md.
+
+"GreenLight", "GreenLight Dash", "GLEA" and "GreenLight Motion" are trademarks of WPSOUL. The Apache
+License does not grant permission to use them; see legal/TRADEMARKS.md.

package/README.md

@@ -1,3 +1,99 @@
-# Temporary Holding Version
+# GreenLight Motion Engine
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+AI agents make motion-design videos with the engine of the
+[GreenLight Dash](https://greenlightdash.pro/) Video Editor. The output goes beyond HTML animation:
+3D models and lights, a 3D camera with depth of field, layer effects, real transitions, per-character
+text animation, particles, masks, blend modes and motion blur, rendered on WebGPU in the user's own
+browser.
+
+The agent writes the video as data: a `project.json` and its files. The engine turns that into:
+
+- **a page the user double-clicks.** It has a real-time preview, the video's layers on a timeline,
+  the options the agent exposed (headline, colours, product photo…), and **Render MP4** at 30 or
+  60 fps with motion blur. Nothing has to be installed for this.
+- **one self-contained HTML file** to send around or put in a Claude artifact.
+- **an MP4** the agent renders itself.
+
+## Quick start
+
+```bash
+npx greenlight-motion@0.1.0 doctor          # Node 18+, Chrome or Edge, WebGPU, H.264: what's missing and how to fix it
+npx greenlight-motion@0.1.0 init my-video   # a working starter: index.html, project.json, assets/
+# edit my-video/project.json, put pictures / video / sound in my-video/assets/
+npx greenlight-motion@0.1.0 check my-video  # what to fix: missing files, template mistakes, blank frames, broken plugins
+npx greenlight-motion@0.1.0 stills my-video # frames + a labelled contact sheet, to look at
+npx greenlight-motion@0.1.0 render my-video --fps 60 --motion-blur
+npx greenlight-motion@0.1.0 pack my-video   # everything in ONE html file
+npx greenlight-motion@0.1.0 pack my-video --glvideo   # ONE .glvideo: double-clicked, it opens in GreenLight Dash
+```
+
+Also: `trace` (every animated layer's values frame by frame, plus the layer's moments), `set key=value`
+(template values), and `schema effects | transitions | easings | sounds | …` (the machine-readable
+catalog).
+
+## For AI agents
+
+Read **[skill/SKILL.md](skill/SKILL.md)**. It covers the workflow, the project format, templates,
+sound cues, plugins and how to make motion look made rather than generated. The format references
+are in `skill/references/`. To install the skill for Claude Code:
+
+```bash
+mkdir -p ~/.claude/skills && cp -R node_modules/greenlight-motion/skill ~/.claude/skills/greenlight-motion
+```
+
+## In a web page or a Claude artifact
+
+The engine is one classic script, so it runs from a double-clicked file, a CDN or an artifact:
+
+```html
+<div id="app"></div>
+<script src="https://cdn.jsdelivr.net/npm/greenlight-motion@0.1.0/dist/greenlight-motion.js"></script>
+<script>
+  GreenLightMotion.mountPage(document.getElementById('app'), {
+    project: { /* project.json */ },
+    assets: { 'asset:photo.jpg': 'data:image/jpeg;base64,…' },   // ref → data: / blob: / https: URL or Blob
+    theme: 'auto',                                                 // 'dark' (default) | 'light' | 'auto'
+  });
+</script>
+```
+
+Without the page UI (in the browser, through a bundler or the ESM build; Node runs only the CLI):
+
+```js
+import { create } from 'greenlight-motion';           // or the GreenLightMotion global
+const engine = create(document.getElementById('stage'), { assets });
+await engine.load(project);                           // → { missing: [refs nobody provided] }
+const png = await engine.renderFrame(1.5);            // data URL
+const { blob } = await engine.export({ format: 'mp4', fps: 60 });
+```
+
+In a Claude artifact a page can't start a download by itself, so the page saves the MP4 through the
+artifact's `downloads` capability.
+
+## Requirements
+
+- **Viewing and rendering:** desktop Chrome or Edge with WebGPU (Chrome 113+).
+- **The CLI:** Node 18+ and Chrome or Edge on the same machine. It drives the browser through
+  `playwright-core` and downloads nothing.
+
+## GreenLight Dash
+
+A project made here opens in the desktop editor for full editing: the page's **Open in GreenLight
+Dash** imports it as a new project. The editor's **Export for agents** works the other way and gives
+an agent a ready folder. MotionFast templates and effect packages with their own image or video files
+play in GreenLight Dash only. The page shows such layers but leaves them out.
+
+## License
+
+Open source under the [Apache License 2.0](LICENSE): free for any use — making videos, client work, building it
+into your own app, website, service or bot, at any company size. Keep the [LICENSE](LICENSE) and [NOTICE](NOTICE)
+with copies you share. Every effect and transition built into the engine is included, also the ones GreenLight
+Dash lists as PRO. Library sounds and 3D files on the GreenLight CDN have their own terms
+([legal/THIRD_PARTY_ASSETS.md](legal/THIRD_PARTY_ASSETS.md)); PRO templates and workflows from the MCP server are
+separate ([legal/PRO_CONTENT_TERMS.md](legal/PRO_CONTENT_TERMS.md)). The videos you make are yours. More in
+[legal/README.md](legal/README.md). Source and issues: [github.com/wpsoul/greenlight-motion-engine](https://github.com/wpsoul/greenlight-motion-engine);
+contributing: [CONTRIBUTING.md](CONTRIBUTING.md). Questions:
+support@greenlightdash.pro.
+
+© 2026 WPSOUL. GreenLight, GreenLight Dash, GLEA and GreenLight Motion are trademarks of WPSOUL
+([policy](legal/TRADEMARKS.md)).