Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ jobs:
- run: npm run test:catalogue
- run: npm run check:assets
- run: npm run check:templates
- run: npm run check:demos
- run: npm run typecheck
- run: npm test
- run: npm run build
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ jobs:
- run: npm run test:catalogue
- run: npm run check:assets
- run: npm run check:templates
- run: npm run check:demos
- run: npm run typecheck
- run: npm test
- run: npm run test:headless
Expand Down
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,17 @@ Keep the original Factory, Festival and Service numerical examples unchanged unl

Open the starter in the app, apply and calculate both alternatives, inspect the input differences and results, then exercise Undo and JSON download/reopen. When changing layout, capture and inspect the actual preview and alternative layouts. See the [template guide](docs/TEMPLATES.md) and [browser checks](docs/QUALITY.md) for the complete flow and `npm run test:templates` setup. Do not imply physical transport, inventory assembly or real-business calibration through the scenery or copy.

## Update demo copy

The watch page's visible text, accessible labels and English caption cues live in `src/ui/messages/watch.ts`. `scripts/watch-page.html` contains its structural markup. Regenerate the static HTML and WebVTT files after editing the messages:

```sh
npm run demos:export
npm run check:demos
```

CI and the Pages build verify that the committed output matches the message source. The watch page requires no runtime script. Review timing and actual playback when changing caption cues or media.

## Publication checks

Set up the optional local hooks with `npm run setup:hooks`. They check staged files before a commit and outgoing commit/tag contents before a push. Existing custom hooks are preserved; integrate these checks into a custom setup when needed. Setup enables repository-local `user.useConfigOnly`, so configure your intended Git identity. A GitHub noreply address keeps your contact address private.
Expand Down
132 changes: 62 additions & 70 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion THIRD_PARTY_NOTICES.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The current miniature worlds use the sourced model adaptations listed below. Lin

React, React DOM, scheduler and Three.js use the MIT license. Lucide uses ISC and retains MIT notices for icons derived from Feather. Their installed license texts are reproduced below. The headless engine bundle contains Loopset code and no third-party runtime dependency.

The demonstration film is rendered with HyperFrames and GSAP; these production tools are not added to the application runtime. Its motion and synthesized score use [Cinetic](https://github.com/Leonxlnx/cinetic) (MIT, copyright 2026 Leonxlnx), and its generated effects and audio analysis use [Earshot](https://github.com/Leonxlnx/earshot) (MIT, copyright 2026 Leon Lin). Their reference-film footage and audio are not included. The film uses the same DM Sans font, Lucide-derived cube mark and attributed facility artwork as the product. See the [media notes](docs/media/README.md) for the recording and editing scope.
The demonstration films are rendered with HyperFrames and GSAP; these production tools are not part of the application runtime. Motion recipes are adapted from [video-shotcraft](https://github.com/Vincentwei1021/video-shotcraft), Apache 2.0; its [license](docs/media/VIDEO-SHOTCRAFT-LICENSE.txt) is retained. Audio analysis uses [Earshot](https://github.com/Leonxlnx/earshot) (MIT, copyright 2026 Leon Lin). Music is Cat Walk by Arulo under the [Mixkit Stock Music Free License](https://mixkit.co/license/#musicFree); effects use the [Mixkit Sound Effects Free License](https://mixkit.co/license/#sfxFree). Stock audio is incorporated into the finished films, not distributed as standalone source files. Reference-film footage and audio are not included. The films use the product's DM Sans font, cube mark and attributed facility artwork. See the [media notes](docs/media/README.md) for exact sources and recording scope.

## Installed npm package inventory

Expand Down
4 changes: 3 additions & 1 deletion docs/DEPLOYMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ npm run test:headless
npm run preview
```

The English video tour and walkthrough are served at `watch/`; their MP4, poster and caption files live under `media/`. Video loading is user-initiated. Hosts must serve MP4 as `video/mp4` and WebVTT as `text/vtt`, and allow same-origin media playback.

`dist/` is the complete static application. Simulations run in the browser; no account, paid API, application backend or database server is required. To serve the built files on loopback:

```sh
Expand All @@ -28,7 +30,7 @@ Serve over HTTPS with correct JavaScript worker, font, image and model MIME type
An illustrative production header policy is:

```text
Content-Security-Policy: default-src 'none'; script-src 'self' 'wasm-unsafe-eval'; worker-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data: blob:; font-src 'self'; connect-src 'self'; object-src 'none'; base-uri 'none'; form-action 'none'; frame-ancestors 'none'
Content-Security-Policy: default-src 'none'; script-src 'self' 'wasm-unsafe-eval'; worker-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data: blob:; media-src 'self'; font-src 'self'; connect-src 'self'; object-src 'none'; base-uri 'none'; form-action 'none'; frame-ancestors 'none'
X-Content-Type-Options: nosniff
Referrer-Policy: no-referrer
Permissions-Policy: camera=(), microphone=(), geolocation=()
Expand Down
2 changes: 2 additions & 0 deletions docs/UX_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Use **Build facility** for visual arrangement, **Define process** for connected

Start with a process question: which arrival rate, processing time, team or waiting policy do you want to test? Use **Scenario settings** and **Properties** for common edits. **Tools → Model editor** provides the full model without requiring a second workflow.

**Tools → A little guidance → Watch the video demos** opens the English quick tour and full walkthrough in a new tab, leaving the current project open.

**How it works** in the world opens the optional three-step guide: change one thing, run the changed plan, compare and keep it. On a phone, select a world object and use **Edit selected step** below the scene. Scenario settings links directly to arrivals and related team controls.

The team’s base availability is visible in Properties. Installed capacity, cost and shifts have their own disclosures. A capacity note explains when the base team cannot staff every parallel station; shared use and calendar overrides remain separate limits. Short duration readouts retain the exact editable value when focused.
Expand Down
26 changes: 16 additions & 10 deletions docs/media/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,25 @@
# Loopset demonstration
# Loopset demos and media

[Watch the 67-second demo](loopset-demo.mp4) · [Animated preview](loopset-demo.gif) · [English captions](loopset-demo.vtt)
[Watch both demos](https://berkebasbay.github.io/loopset/watch/) · [30-second English MP4](../../public/media/loopset-demo-short.mp4) · [55-second English MP4](../../public/media/loopset-demo.mp4)

The film uses the actual RC14 interface in one synthetic Little Factory project. It opens a template, places a shelf, changes packing stations and team capacity, runs comparisons, then saves and reuses the setup.
The films combine actual Loopset footage with editorial cards and screen text. Service Studio, Festival Gate and Little Factory lead the collection. The full film also illustrates building from an empty site and saving/reusing a personal template; those graphic sections are not recordings of every corresponding UI action.

One extra packing station leaves output unchanged until its team capacity is increased deliberately: 40 → 40 → 77 completed orders, with modeled resource cost $74 → $74 → $96. Mean waiting changes from 14.5 to 1.4 minutes. Each plan uses the same 80 modeled arrivals, one-hour duration and seed 4207. This is one synthetic case, not a business forecast; resource cost is not total operating cost. Placing a shelf changes the layout, not the calculation.
The recorded Service Studio edit changes shared specialist availability from 2 to 3, then uses the real **Run & compare** action. With the same 106 arrivals, one modeled hour and seed 4207, completed requests change from 66 to 86, average waiting from 9.5 to 5.2 minutes, and modeled resource cost from $85 to $115. Station counts, installed capacity and the break calendar stay unchanged. These rounded outcomes describe one synthetic example, not a business forecast.

The MP4 is 1920×1080 at 60 fps with English screen text, music and effects. Native browser footage was captured at 25 fps; the camera and typography animate at 60 fps. Editorial crops, shortened pauses and held comparison frames make the real actions and results readable. No UI controls or intermediate numerical results are reconstructed. The animated preview is a silent excerpt from the same film.
Both MP4s are 1920×1080 at 60 fps with English text, music and effects. Native application images were recorded at high resolution using fixed-step browser time; this is not a real-time hardware performance benchmark. Crops and translated annotations improve readability without replacing the underlying controls or numerical results. Captions and a text walkthrough are available on the watch page. The JPEG posters are frames from these films.

Produced with [HyperFrames](https://github.com/heygen-com/hyperframes), [Cinetic](https://github.com/Leonxlnx/cinetic) and [Earshot](https://github.com/Leonxlnx/earshot). The soundtrack is an original synthesized arrangement with code-generated effects; it contains no sampled reference-film music or voiceover. DM Sans, GSAP and the underlying artwork retain their own licences: see [third-party notices](../../THIRD_PARTY_NOTICES.md) and [asset provenance](../NVIDIA_ASSETS.md).
## Film credits

## Interface screenshots
- Rendering and animation: [HyperFrames](https://github.com/heygen-com/hyperframes) and [GSAP](https://github.com/greensock/GSAP). Audio analysis: [Earshot](https://github.com/Leonxlnx/earshot).
- Motion recipe adaptation: [video-shotcraft](https://github.com/Vincentwei1021/video-shotcraft), revision `5a2e98daade313c4f376120f38427eb19a108e8c`, Apache 2.0. Its [license](VIDEO-SHOTCRAFT-LICENSE.txt) is retained. Reference-film pictures and audio are not included.
- Music: **Cat Walk — Arulo**, from [Mixkit](https://assets.mixkit.co/music/371/371.mp3), under the [Mixkit Stock Music Free License](https://mixkit.co/license/#musicFree).
- Effects: Fast small sweep transition (166), Quick switch click (2582), Cinematic whoosh deep impact (1143), and Paper slide (1530), under the [Mixkit Sound Effects Free License](https://mixkit.co/license/#sfxFree).
- Font, cube mark and facility artwork: the same attributed assets used by the product. See [third-party notices](../../THIRD_PARTY_NOTICES.md) and [asset provenance](../NVIDIA_ASSETS.md).

Stock music and effects are incorporated into the films; their standalone source files are not distributed here. The code's MIT license does not replace the media contributors' separate terms.

`loopset-facility.png` and `loopset-templates.png` capture the RC14 facility workspace and template gallery. The Little Factory layout uses the unchanged Factory numerical process with 57 independently editable objects. Its source project is [`examples/facility.json`](../../examples/facility.json). The video adds one shelf, keeping 58 layout objects through the experiment. Local-origin footers are excluded from the media.
## Interface screenshots

`loopset-insights.png` shows recorded outcomes from the same synthetic process. `loopset-compare.png` shows its deliberate station/team comparison, 40 → 77 completed orders. These are browser captures with real inputs and calculated values; the examples are not calibrated business forecasts.
The PNG screenshots in this directory document the RC14 workspace, template gallery and recorded-result surfaces. `loopset-facility.png` uses the enhanced Little Factory layout; its source is [`examples/facility.json`](../../examples/facility.json). `loopset-compare.png` shows that Factory's separate station/team experiment, 40 → 77 completed orders; it is not the Service Studio comparison in the current films.

The PNG previews in `public/previews/` show real rendered example worlds, and `public/previews/templates/` contains the twelve current starter scenes. The social card uses the Little Factory starter preview in an editorial layout. NVIDIA CC BY 4.0 models, Quaternius/Poly Haven CC0 material and the fonts retain the creator/source/licence records linked above.
`public/previews/templates/` contains the twelve starter scene previews. All models and examples shown are synthetic. Original browser captures omit local-origin footers. NVIDIA CC BY 4.0 models, Quaternius/Poly Haven CC0 material and fonts retain the creator/source/license records linked above.
Loading
Loading