evotars 0.0.9 → 0.0.11

package/dist/index.d.ts

@@ -0,0 +1,175 @@
+import { ISpritesheetData } from 'pixi.js';
+import { ISpritesheetFrameData } from 'pixi.js';
+
+export declare type ActionableData = {
+    arguments: string[];
+    action: ActionData;
+};
+
+export declare type ActionData = Record<string, string | number | undefined>;
+
+export declare type ActionEntity = {
+    id: number;
+    name: string;
+    title: string;
+    description: string;
+    data: ActionData;
+};
+
+declare type AppOptions = {
+    font?: string;
+    sounds?: SoundOptions;
+    spriteLoaderFn: SpriteLoaderFn;
+};
+
+declare type Collider = {
+    x: number;
+    y: number;
+    w: number;
+    h: number;
+};
+
+export declare type ColorUserActionEntity = {
+    name: 'color';
+    data: {
+        color: string;
+    };
+} & UserActionEntity;
+
+export declare type DashUserActionEntity = {
+    name: 'dash';
+    data: {
+        force: number;
+    };
+} & UserActionEntity;
+
+export declare class Evotars {
+    private readonly root;
+    private readonly options;
+    private isRendered;
+    constructor(root: HTMLElement, options: AppOptions);
+    processMessage: (data: MessageEntity) => Promise<void>;
+    processAction: (data: UserActionEntity) => Promise<void>;
+    processChatters: (data: TwitchChatterEntity[]) => Promise<void>;
+    processRaid: (data: RaidEntity) => void;
+    updateSettings(data: SettingsEntity): void;
+    run(): Promise<void>;
+}
+
+declare type EvotarSpriteData = {
+    name: string;
+    collider: Collider;
+    size: SpriteSize;
+    scale: number;
+    flip: boolean;
+    colored: string[];
+};
+
+export declare type GrowUserActionEntity = {
+    name: 'grow';
+    data: {
+        duration: number;
+        scale: number;
+    };
+} & UserActionEntity;
+
+export declare const isColorUserActionEntity: (entity: ActionEntity) => entity is ColorUserActionEntity;
+
+export declare const isDashUserActionEntity: (entity: ActionEntity) => entity is DashUserActionEntity;
+
+export declare const isGrowUserActionEntity: (entity: ActionEntity) => entity is GrowUserActionEntity;
+
+export declare const isJumpUserActionEntity: (entity: ActionEntity) => entity is JumpUserActionEntity;
+
+export declare const isSpriteUserActionEntity: (entity: ActionEntity) => entity is SpriteUserActionEntity;
+
+export declare type JumpUserActionEntity = {
+    name: 'jump';
+    data: {
+        velocityX: number;
+        velocityY: number;
+    };
+} & UserActionEntity;
+
+export declare type MessageEntity = {
+    userId: string;
+    message: string;
+    emotes: string[];
+    info: UserInfo;
+};
+
+export declare type RaidEntity = {
+    broadcaster: {
+        id: string;
+        info: UserInfo;
+    };
+    viewers: {
+        count: number;
+        sprite: string;
+    };
+};
+
+export declare type SettingsEntity = {
+    showAnonymousEvotars?: boolean;
+    fallingEvotars?: boolean;
+    fallingRaiders?: boolean;
+};
+
+declare type SoundOptions = {
+    jump?: {
+        src: string;
+    };
+};
+
+declare type SpriteLoaderFn = (name: string) => Promise<{
+    sprite: SpritesheetData;
+    data: EvotarSpriteData;
+    image: string;
+} | undefined>;
+
+declare interface SpritesheetData extends ISpritesheetData {
+    frames: Record<string, SpritesheetFrameData>;
+}
+
+declare interface SpritesheetFrameData extends ISpritesheetFrameData {
+    duration: number;
+}
+
+declare type SpriteSize = {
+    w: number;
+    h: number;
+};
+
+export declare type SpriteUserActionEntity = {
+    name: 'sprite';
+    data: {
+        sprite: string;
+    };
+} & UserActionEntity;
+
+export declare type TwitchChatterEntity = {
+    userId: string;
+    name: string;
+};
+
+export declare type UserActionEntity = {
+    userId: string;
+    cooldown: number;
+    info: UserInfo;
+} & ActionEntity;
+
+export declare type UserEntity = {
+    userId: number;
+    guid: string;
+    displayName: string;
+    profileImageUrl: string;
+    previewUrl: string;
+};
+
+export declare type UserInfo = {
+    displayName: string;
+    sprite: string;
+    color?: string;
+};
+
+export { }

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.0.9",
+  "version": "0.0.11",
   "name": "evotars",
   "description": "Show animated characters on stream",
   "author": "Mikhail Morozov",
@@ -19,8 +19,28 @@
     "preview": "vite preview",
     "lint": "tsc --noEmit"
   },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
   "source": "./src/index.ts",
-  "main": "./src/index.ts",
+  "main": "./dist/evotars.umd.cjs",
+  "module": "./dist/evotars.js",
+  "exports": {
+    ".": {
+      "types": {
+        "default": "./dist/index.d.ts"
+      },
+      "default": {
+        "import": "./dist/evotars.js",
+        "require": "./dist/evotars.umd.cjs"
+      }
+    }
+  },
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "typings": "./dist/index.d.ts",
   "devDependencies": {
     "@types/tinycolor2": "^1.4.6",
     "typescript": "^5.0.2",

package/.editorconfig

@@ -1,13 +0,0 @@
-# Editor configuration, see http://editorconfig.org
-root = true
-
-[*]
-charset = utf-8
-indent_style = space
-indent_size = 2
-insert_final_newline = true
-trim_trailing_whitespace = true
-
-[*.md]
-max_line_length = off
-trim_trailing_whitespace = false

package/.prettierrc.json

@@ -1,3 +0,0 @@
-{
-  "singleQuote": true
-}

package/index.html

@@ -1,13 +0,0 @@
-<!doctype html>
-<html lang="en">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Evotars</title>
-    <link rel="preload" rel="stylesheet" href="https://fonts.googleapis.com/css?family=Rubik">
-  </head>
-  <body>
-    <script type="module" src="/playground/main.ts"></script>
-  </body>
-</html>
-

package/playground/main.ts

@@ -1,48 +0,0 @@
-import { Evotars } from '../src/evotars';
-import { SettingsEntity } from '../src/types';
-import './styles.css';
-
-const sounds = { jump: { src: '/sounds/jump.mp3' } };
-const settings: SettingsEntity = {
-  fallingEvotars: true,
-};
-
-const root = document.body;
-
-if (root) {
-  const evotars = new Evotars(root, {
-    font: 'Rubik',
-    sounds,
-    spriteLoaderFn: async (name: string) => {
-      const path = '/evotars/' + name + '/';
-      const sprite = await fetch(path + 'sprite.json');
-      const spriteJson = await sprite.json();
-      const data = await fetch(path + 'data.json');
-      const dataJson = await data.json();
-
-      return {
-        data: dataJson,
-        image: path + 'sprite.png',
-        sprite: spriteJson,
-      };
-    },
-  });
-
-  await evotars.run();
-  evotars.updateSettings(settings);
-
-  setTimeout(() => {
-    evotars.processMessage({
-      message: 'Hello!',
-      userId: '1',
-      emotes: [
-        'https://static-cdn.jtvnw.net/emoticons/v2/emotesv2_a3c4578cf38c4c668553ead85b899d70/default/dark/3.0',
-      ],
-      info: {
-        color: 'pink',
-        displayName: 'Evotar',
-        sprite: 'dude',
-      },
-    });
-  }, 500);
-}

package/playground/styles.css

@@ -1,17 +0,0 @@
-:root {
-  margin: 0;
-  padding: 0;
-}
-
-html {
-  height: 100%;
-}
-
-body {
-  margin: 0;
-  padding: 0;
-  width: 100%;
-  height: 100%;
-  min-height: 100%;
-  overflow: hidden;
-}

package/public/evotars/agent/data.json

@@ -1,18 +0,0 @@
-{
-  "name": "agent",
-  "collider": {
-    "x": 8,
-    "y": 7,
-    "w": 16,
-    "h": 18
-  },
-  "size": {
-    "w": 32,
-    "h": 32
-  },
-  "scale": 4,
-  "flip": true,
-  "colored": [
-    "Body"
-  ]
-}

package/public/evotars/agent/sprite.json

@@ -1,166 +0,0 @@
-{ "frames": {
-   "agent_Body_0": {
-    "frame": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 300
-   },
-   "agent_Body_1": {
-    "frame": { "x": 32, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 300
-   },
-   "agent_Body_2": {
-    "frame": { "x": 64, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 300
-   },
-   "agent_Body_3": {
-    "frame": { "x": 96, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Body_4": {
-    "frame": { "x": 128, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Body_5": {
-    "frame": { "x": 160, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Body_6": {
-    "frame": { "x": 192, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Body_7": {
-    "frame": { "x": 224, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Body_8": {
-    "frame": { "x": 256, "y": 0, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Eyes_0": {
-    "frame": { "x": 0, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 300
-   },
-   "agent_Eyes_1": {
-    "frame": { "x": 32, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 300
-   },
-   "agent_Eyes_2": {
-    "frame": { "x": 64, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 300
-   },
-   "agent_Eyes_3": {
-    "frame": { "x": 96, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Eyes_4": {
-    "frame": { "x": 128, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Eyes_5": {
-    "frame": { "x": 160, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Eyes_6": {
-    "frame": { "x": 192, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Eyes_7": {
-    "frame": { "x": 224, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   },
-   "agent_Eyes_8": {
-    "frame": { "x": 256, "y": 32, "w": 32, "h": 32 },
-    "rotated": false,
-    "trimmed": false,
-    "spriteSourceSize": { "x": 0, "y": 0, "w": 32, "h": 32 },
-    "sourceSize": { "w": 32, "h": 32 },
-    "duration": 100
-   }
- },
- "meta": {
-  "app": "https://www.aseprite.org/",
-  "version": "1.x-dev",
-  "image": "agent.png",
-  "format": "RGBA8888",
-  "size": { "w": 288, "h": 64 },
-  "scale": "1",
-  "frameTags": [
-   { "name": "Idle", "from": 0, "to": 2, "direction": "forward", "color": "#000000ff" },
-   { "name": "Jump", "from": 3, "to": 3, "direction": "forward", "color": "#000000ff" },
-   { "name": "Fall", "from": 4, "to": 4, "direction": "forward", "color": "#000000ff" },
-   { "name": "Land", "from": 5, "to": 5, "direction": "forward", "color": "#000000ff" },
-   { "name": "Run", "from": 6, "to": 8, "direction": "forward", "color": "#000000ff" }
-  ],
-  "layers": [
-   { "name": "Body", "opacity": 255, "blendMode": "normal" },
-   { "name": "Eyes", "opacity": 255, "blendMode": "normal" }
-  ]
- }
-}

package/public/evotars/cat/data.json

@@ -1,18 +0,0 @@
-{
-  "name": "cat",
-  "collider": {
-    "x": 8,
-    "y": 4,
-    "w": 16,
-    "h": 11
-  },
-  "size": {
-    "w": 32,
-    "h": 32
-  },
-  "scale": 4,
-  "flip": true,
-  "colored": [
-    "Body"
-  ]
-}