@wonderyard/vivarium 1.4.1 → 2.0.0

package/README.md

@@ -1,4 +1,8 @@
-# Vivarium
+<p align="center">
+  <img width="128" height="128" src="docs/src/assets/glider.png" />
+</p>
+
+<h1 align="center">Vivarium</h1>
 
 <p align="center">
   <img src="docs/banner.png" />
@@ -69,7 +73,7 @@ const life = vi.create();
 const canvas = document.createElement(canvas);
 document.body.appendChild(canvas);
 
-// Set the canvas size. This will be the automaton size as well.
+// Set the canvas size (must be a power of 2). This will be the automaton size as well.
 const size = 256;
 canvas.width = size;
 canvas.height = size;
@@ -81,7 +85,7 @@ const { evolve } = setup({ canvas, automaton: life });
 const loop = async () => {
   await evolve();
   requestAnimationFrame(loop);
-}
+};
 requestAnimationFrame(loop);
 ```
 
@@ -92,4 +96,5 @@ requestAnimationFrame(loop);
 Vivarium runs its simulation entirely on the GPU thanks to the WebGPU API and its compute shaders. WebGPU is a relatively new technology. It is available since Chrome 113, Safari 26. See implementation status in other browsers [here](https://github.com/gpuweb/gpuweb/wiki/Implementation-Status). Vivarium has been tested on Chrome 139 for macOS and Safari 26.0 for macOS, showing better performances on Chrome overall.
 
 ## Contributing
+
 Although I've been researching and experimenting with cellular automata for years, this is my first WebGPU-based project, so it might be rough around the edges. With WebGPU I've been able to achieve something it wouldn't be possible in a browser otherwise: to build something simple, customizable, and accessible for the end user, without compromising on performance. The intent is to offer this library as a learning tool and something other people can build on top of. If you share the vision and you would like to improve this software, PRs are welcome.

package/dist/automaton/types.d.ts

@@ -9,6 +9,7 @@ export type Kind = {
 export type Color = string;
 export type Automaton = {
     neighborhood: Neighborhood;
+    wrapping: boolean;
     elements: Element[];
     kinds: Kind[];
     rules: Rule[];

package/dist/blueprint/base-blueprint.js

@@ -19,9 +19,7 @@ class o {
   }
   assertNotEmpty() {
     if (!this.automaton.elements.length)
-      throw new Error(
-        "No elements found in automaton, at least one element is required"
-      );
+      throw new Error("No elements found in automaton, at least one element is required");
   }
 }
 export {

package/dist/blueprint/ref-blueprint.js

@@ -1,7 +1,7 @@
 import { BaseBlueprint as n } from "./base-blueprint.js";
-import { R as p } from "../rule-blueprint-DGODv9IV.js";
+import { R as p } from "../rule-blueprint-C9qa6iP-.js";
 import { toRefIdOrPoint as d } from "./utils.js";
-import { A as u } from "../constants-D4GX9YB2.js";
+import { A as u } from "../constants-BT-9-x_4.js";
 class o extends n {
   constructor(e, t) {
     super(), this.automaton = e, this.id = t.id, this.name = t.name, this.type = t.type;

package/dist/blueprint/rule-blueprint.js

@@ -1,7 +1,7 @@
-import { R as o, a as l } from "../rule-blueprint-DGODv9IV.js";
+import { R as o, a as l } from "../rule-blueprint-C9qa6iP-.js";
 import "./base-blueprint.js";
 import "./utils.js";
-import "../constants-D4GX9YB2.js";
+import "../constants-BT-9-x_4.js";
 export {
   o as RuleBlueprint,
   l as RuleBlueprintWithAccept

package/dist/blueprint/utils.js

@@ -1,4 +1,4 @@
-import { n as t } from "../constants-D4GX9YB2.js";
+import { n as t } from "../constants-BT-9-x_4.js";
 const s = (o) => typeof o == "string" ? t[o] : o.id;
 export {
   s as toRefIdOrPoint

package/dist/blueprint/vivarium-blueprint.d.ts

@@ -27,7 +27,9 @@ export declare class VivariumBlueprint<N extends Neighborhood = "square"> extend
      * Includes {@link Helpers.not | not}, {@link Helpers.between | between}, {@link Helpers.even | even}, and {@link Helpers.odd | odd}.
      */
     helpers: Helpers;
-    constructor(neighborhoodName?: N | undefined);
+    constructor(neighborhoodName?: N | undefined, options?: {
+        wrapping?: boolean;
+    });
     /**
      * Defines a new element in the vivarium.
      *

package/dist/blueprint/vivarium-blueprint.js

@@ -1,12 +1,13 @@
-import { n as o } from "../rule-blueprint-DGODv9IV.js";
+import { n as o } from "../rule-blueprint-C9qa6iP-.js";
 import { BaseBlueprint as a } from "./base-blueprint.js";
 import { Helpers as h } from "./helpers.js";
 import { ElementBlueprint as m, KindBlueprint as u } from "./ref-blueprint.js";
-import { C as d, S as p } from "../constants-D4GX9YB2.js";
-class b extends a {
-  constructor(t) {
-    super(), this.neighborhoodName = t, this.helpers = new h(this.neighborhoodName), this.neighbor = this.neighborhoodName === "cross" ? d : p, this.automaton = {
+import { C as p, S as d } from "../constants-BT-9-x_4.js";
+class C extends a {
+  constructor(t, e) {
+    super(), this.neighborhoodName = t, this.helpers = new h(this.neighborhoodName), this.neighbor = this.neighborhoodName === "cross" ? p : d, this.automaton = {
       neighborhood: t ?? "square",
+      wrapping: e?.wrapping ?? !1,
       elements: [],
       kinds: [],
       rules: []
@@ -75,5 +76,5 @@ class b extends a {
   }
 }
 export {
-  b as VivariumBlueprint
+  C as VivariumBlueprint
 };

package/dist/common/constants.d.ts

@@ -62,3 +62,4 @@ export declare const GpuCondition: d.WgslStruct<{
     chance: d.F32;
 }>;
 export declare const WORKGROUP_SIZE: [number, number];
+export declare const MIN_GRID_SIZE: number;

package/dist/common/constants.js

@@ -1,14 +1,15 @@
-import { A as o, C as e, b as p, G as c, a as n, O as t, S as r, T as u, cj as G, c as i, n as O } from "../constants-D4GX9YB2.js";
+import { A as o, C as e, b as c, G as p, a as n, c4 as t, O as G, S as r, T as u, c3 as i, c as I, n as O } from "../constants-BT-9-x_4.js";
 export {
   o as Accept,
   e as Cross,
-  p as GpuCondition,
-  c as GpuElement,
+  c as GpuCondition,
+  p as GpuElement,
   n as GpuRule,
-  t as Opcode,
+  t as MIN_GRID_SIZE,
+  G as Opcode,
   r as Square,
   u as To,
-  G as WORKGROUP_SIZE,
-  i as acceptMap,
+  i as WORKGROUP_SIZE,
+  I as acceptMap,
   O as neighborhoodPoints
 };

package/dist/common/utils.js

@@ -295,11 +295,11 @@ const f = (e) => {
   const t = /^#?([a-f\d])([a-f\d])([a-f\d])$/i;
   e = e.replace(
     t,
-    (l, a, c, n) => a + a + c + c + n + n
+    (l, a, n, c) => a + a + n + n + c + c
   );
   const r = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(e);
   if (!r)
-    throw new Error("Bad color");
+    throw new Error(`Bad color: ${e}`);
   const s = parseInt(r[1], 16), u = parseInt(r[2], 16);
   return 4278190080 | parseInt(r[3], 16) << 16 | u << 8 | s;
 };