@antha/engine 0.1.0 → 0.1.2

package/README.md

@@ -1,11 +1,38 @@
-# Antha
+# @antha/engine
 
-The Antha game engine (for the web), where everything is a mod! The only thing this engine core includes is a framework for flexibly defining and inserting mods with all the tools they need to be successful.
+The Antha game engine (for the web), where everything is a mod! This engine core package only includes a lightweight framework for flexibly defining, inserting, and running the engine mods.
 
 -   Demo: https://electrovir.github.io/antha/demo
 
 ## Install
 
 ```sh
-npm i antha
+npm i @antha/engine
+```
+
+## Usage
+
+<!-- example-link: src/readme-examples/creating-engine.example.ts -->
+
+```TypeScript
+import {AnthaEngine, defineAnthaMod} from '@antha/engine';
+
+const engine = new AnthaEngine<{
+    count: number;
+}>({
+    mods: [
+        defineAnthaMod<{
+            count: number;
+        }>({
+            modName: 'counter',
+            execute({state}) {
+                state.count = (state.count ?? 0) + 1;
+
+                return `Count: ${state.count}`;
+            },
+        }),
+    ],
+});
+
+engine.startLoop();
 ```

package/dist/antha-engine.d.ts

@@ -36,10 +36,10 @@ export type ModCleanupParams<State extends AnyObject> = {
     modInstanceId: ModInstanceId;
 } & ModOptions;
 /**
- * Return this from a mod's {@link AnthaMod.execute} callback to instruct {@link AnthaEngine} that the
- * mod's current execution should not count toward the mod's frequency schedule. This is useful when
- * a mod needs a dependency (such as a canvas or external resource) that isn't ready yet so that the
- * engine will keep retrying on subsequent ticks, even if the mod has a low execution frequency.
+ * Return this from a mod's `execute` callback to instruct {@link AnthaEngine} that the mod's current
+ * execution should not count toward the mod's frequency schedule. This is useful when a mod needs a
+ * dependency (such as a canvas or external resource) that isn't ready yet so that the engine will
+ * keep retrying on subsequent ticks, even if the mod has a low execution frequency.
  *
  * @category Mod
  */

package/dist/antha-engine.js

@@ -6,10 +6,10 @@ import { Observable } from 'observavir';
 import { AnthaUi } from './antha-ui.element.js';
 import { browserAnthaLogger } from './logger/browser-antha-logger.js';
 /**
- * Return this from a mod's {@link AnthaMod.execute} callback to instruct {@link AnthaEngine} that the
- * mod's current execution should not count toward the mod's frequency schedule. This is useful when
- * a mod needs a dependency (such as a canvas or external resource) that isn't ready yet so that the
- * engine will keep retrying on subsequent ticks, even if the mod has a low execution frequency.
+ * Return this from a mod's `execute` callback to instruct {@link AnthaEngine} that the mod's current
+ * execution should not count toward the mod's frequency schedule. This is useful when a mod needs a
+ * dependency (such as a canvas or external resource) that isn't ready yet so that the engine will
+ * keep retrying on subsequent ticks, even if the mod has a low execution frequency.
  *
  * @category Mod
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@antha/engine",
-    "version": "0.1.0",
+    "version": "0.1.2",
     "description": "The Antha game engine (for the web).",
     "keywords": [
         "vir",
@@ -38,7 +38,7 @@
         "@augment-vir/assert": "^32.2.2",
         "@augment-vir/common": "^32.2.2",
         "@paralleldrive/cuid2": "^3.3.0",
-        "date-vir": "^9.0.0",
+        "date-vir": "^9.1.0",
         "observavir": "^2.3.3",
         "sentry-vir": "^4.5.1"
     },