From e170c5c6b6bc92a88ede7ad7bc3c528bd6c33029 Mon Sep 17 00:00:00 2001 From: modeco80 Date: Sun, 25 Aug 2024 08:56:12 -0400 Subject: [PATCH 1/3] msagent.js: core-ize This will allow us to parse ACS files on the server side without hassle. --- msagent.js/README.md | 9 ++ msagent.js/{ => core}/Makefile | 0 msagent.js/{ => core}/package.json | 2 +- msagent.js/{ => core}/src/buffer.ts | 9 +- msagent.js/{ => core}/src/decompress.cpp | 0 msagent.js/{ => core}/src/decompress.ts | 0 msagent.js/{ => core}/src/decompress.wasm | Bin msagent.js/core/src/index.ts | 10 ++ msagent.js/{ => core}/src/structs/README.md | 0 .../{ => core}/src/structs/animation.ts | 0 .../{ => core}/src/structs/character.ts | 0 msagent.js/{ => core}/src/structs/core.ts | 0 msagent.js/{ => core}/src/structs/image.ts | 0 msagent.js/{ => core}/src/types.ts | 0 msagent.js/{ => core}/tsconfig.json | 0 msagent.js/web/package.json | 20 ++++ msagent.js/{ => web}/res/wordballoon.png | Bin msagent.js/{ => web}/res/wordballoon.xcf | Bin msagent.js/{ => web}/src/agent.ts | 8 +- msagent.js/{ => web}/src/character.ts | 10 +- msagent.js/{ => web}/src/contextmenu.ts | 0 msagent.js/{ => web}/src/index.ts | 4 +- msagent.js/{ => web}/src/sprite.ts | 2 +- msagent.js/{ => web}/src/wordballoon.ts | 2 +- msagent.js/web/tsconfig.json | 108 ++++++++++++++++++ package.json | 3 +- webapp/package.json | 2 +- webapp/src/ts/client.ts | 2 +- webapp/src/ts/main.ts | 2 +- webapp/src/ts/testbed.ts | 2 +- yarn.lock | 33 ++++-- 31 files changed, 195 insertions(+), 33 deletions(-) rename msagent.js/{ => core}/Makefile (100%) rename msagent.js/{ => core}/package.json (89%) rename msagent.js/{ => core}/src/buffer.ts (97%) rename msagent.js/{ => core}/src/decompress.cpp (100%) rename msagent.js/{ => core}/src/decompress.ts (100%) rename msagent.js/{ => core}/src/decompress.wasm (100%) create mode 100644 msagent.js/core/src/index.ts rename msagent.js/{ => core}/src/structs/README.md (100%) rename msagent.js/{ => core}/src/structs/animation.ts (100%) rename msagent.js/{ => core}/src/structs/character.ts (100%) rename msagent.js/{ => core}/src/structs/core.ts (100%) rename msagent.js/{ => core}/src/structs/image.ts (100%) rename msagent.js/{ => core}/src/types.ts (100%) rename msagent.js/{ => core}/tsconfig.json (100%) create mode 100644 msagent.js/web/package.json rename msagent.js/{ => web}/res/wordballoon.png (100%) rename msagent.js/{ => web}/res/wordballoon.xcf (100%) rename msagent.js/{ => web}/src/agent.ts (98%) rename msagent.js/{ => web}/src/character.ts (87%) rename msagent.js/{ => web}/src/contextmenu.ts (100%) rename msagent.js/{ => web}/src/index.ts (75%) rename msagent.js/{ => web}/src/sprite.ts (96%) rename msagent.js/{ => web}/src/wordballoon.ts (99%) create mode 100644 msagent.js/web/tsconfig.json diff --git a/msagent.js/README.md b/msagent.js/README.md index bf1686b..92c9a45 100644 --- a/msagent.js/README.md +++ b/msagent.js/README.md @@ -1 +1,10 @@ # msagent.js + +This project is split up into two subcompoennts: + +- `@msagent.js/core` contains the core inner workings. This is everything that works on either the Web or node.js. + +- `@msagent.js/web` contains most of the public API that msagent.js has exported. + + +The web project is implicitly dependent on the core project. Do not introduce code that requires Web APIs in the core. diff --git a/msagent.js/Makefile b/msagent.js/core/Makefile similarity index 100% rename from msagent.js/Makefile rename to msagent.js/core/Makefile diff --git a/msagent.js/package.json b/msagent.js/core/package.json similarity index 89% rename from msagent.js/package.json rename to msagent.js/core/package.json index 8d7317b..405542b 100644 --- a/msagent.js/package.json +++ b/msagent.js/core/package.json @@ -1,5 +1,5 @@ { - "name": "@msagent-chat/msagent.js", + "name": "@msagent.js/core", "version": "0.1.0", "packageManager": "yarn@4.2.2", "devDependencies": { diff --git a/msagent.js/src/buffer.ts b/msagent.js/core/src/buffer.ts similarity index 97% rename from msagent.js/src/buffer.ts rename to msagent.js/core/src/buffer.ts index 20e935d..5eb4e5a 100644 --- a/msagent.js/src/buffer.ts +++ b/msagent.js/core/src/buffer.ts @@ -94,8 +94,13 @@ export class BufferStream { withOffset(where: number, cb: () => void) { let last = this.tell(); this.seek(where, SeekDir.BEG); - cb(); - this.seek(last, SeekDir.BEG); + try { + cb(); + } catch(_) { + throw _; + } finally { + this.seek(last, SeekDir.BEG); + } } readBool(): boolean { diff --git a/msagent.js/src/decompress.cpp b/msagent.js/core/src/decompress.cpp similarity index 100% rename from msagent.js/src/decompress.cpp rename to msagent.js/core/src/decompress.cpp diff --git a/msagent.js/src/decompress.ts b/msagent.js/core/src/decompress.ts similarity index 100% rename from msagent.js/src/decompress.ts rename to msagent.js/core/src/decompress.ts diff --git a/msagent.js/src/decompress.wasm b/msagent.js/core/src/decompress.wasm similarity index 100% rename from msagent.js/src/decompress.wasm rename to msagent.js/core/src/decompress.wasm diff --git a/msagent.js/core/src/index.ts b/msagent.js/core/src/index.ts new file mode 100644 index 0000000..0b5df58 --- /dev/null +++ b/msagent.js/core/src/index.ts @@ -0,0 +1,10 @@ +export * from './buffer.js'; + +// structs +export * from './structs/core.js'; +export * from './structs/character.js'; +export * from './structs/animation.js'; +export * from './structs/image.js'; + +export * from './types.js'; +export * from './decompress.js'; diff --git a/msagent.js/src/structs/README.md b/msagent.js/core/src/structs/README.md similarity index 100% rename from msagent.js/src/structs/README.md rename to msagent.js/core/src/structs/README.md diff --git a/msagent.js/src/structs/animation.ts b/msagent.js/core/src/structs/animation.ts similarity index 100% rename from msagent.js/src/structs/animation.ts rename to msagent.js/core/src/structs/animation.ts diff --git a/msagent.js/src/structs/character.ts b/msagent.js/core/src/structs/character.ts similarity index 100% rename from msagent.js/src/structs/character.ts rename to msagent.js/core/src/structs/character.ts diff --git a/msagent.js/src/structs/core.ts b/msagent.js/core/src/structs/core.ts similarity index 100% rename from msagent.js/src/structs/core.ts rename to msagent.js/core/src/structs/core.ts diff --git a/msagent.js/src/structs/image.ts b/msagent.js/core/src/structs/image.ts similarity index 100% rename from msagent.js/src/structs/image.ts rename to msagent.js/core/src/structs/image.ts diff --git a/msagent.js/src/types.ts b/msagent.js/core/src/types.ts similarity index 100% rename from msagent.js/src/types.ts rename to msagent.js/core/src/types.ts diff --git a/msagent.js/tsconfig.json b/msagent.js/core/tsconfig.json similarity index 100% rename from msagent.js/tsconfig.json rename to msagent.js/core/tsconfig.json diff --git a/msagent.js/web/package.json b/msagent.js/web/package.json new file mode 100644 index 0000000..f7a5cb8 --- /dev/null +++ b/msagent.js/web/package.json @@ -0,0 +1,20 @@ +{ + "name": "@msagent.js/web", + "version": "0.1.0", + "packageManager": "yarn@4.2.2", + "dependencies": { + "@msagent.js/core": "*" + }, + "devDependencies": { + "@parcel/core": "^2.12.0", + "parcel": "^2.12.0", + "typescript": "^5.5.3" + }, + "scripts": { + "build": "parcel build" + }, + "type": "module", + "source": "src/index.ts", + "module": "./dist/index.js", + "types": "./dist/index.d.ts" +} diff --git a/msagent.js/res/wordballoon.png b/msagent.js/web/res/wordballoon.png similarity index 100% rename from msagent.js/res/wordballoon.png rename to msagent.js/web/res/wordballoon.png diff --git a/msagent.js/res/wordballoon.xcf b/msagent.js/web/res/wordballoon.xcf similarity index 100% rename from msagent.js/res/wordballoon.xcf rename to msagent.js/web/res/wordballoon.xcf diff --git a/msagent.js/src/agent.ts b/msagent.js/web/src/agent.ts similarity index 98% rename from msagent.js/src/agent.ts rename to msagent.js/web/src/agent.ts index 19a6014..1c8d353 100644 --- a/msagent.js/src/agent.ts +++ b/msagent.js/web/src/agent.ts @@ -1,9 +1,9 @@ -import { BufferStream, SeekDir } from './buffer.js'; +import { BufferStream, SeekDir } from '@msagent.js/core'; import { AcsData } from './character.js'; import { ContextMenu, ContextMenuItem } from './contextmenu.js'; -import { AcsAnimation, AcsAnimationFrameInfo } from './structs/animation.js'; -import { AcsImageEntry } from './structs/image.js'; -import { Point, Size } from './types.js'; +import { AcsAnimation, AcsAnimationFrameInfo } from '@msagent.js/core'; +import { AcsImageEntry } from '@msagent.js/core'; +import { Point, Size } from '@msagent.js/core'; import { wordballoonDrawImage, wordballoonDrawText } from './wordballoon.js'; // probably should be in a utility module diff --git a/msagent.js/src/character.ts b/msagent.js/web/src/character.ts similarity index 87% rename from msagent.js/src/character.ts rename to msagent.js/web/src/character.ts index 02a333d..dfe6c2c 100644 --- a/msagent.js/src/character.ts +++ b/msagent.js/web/src/character.ts @@ -1,9 +1,9 @@ -import { BufferStream, SeekDir } from './buffer.js'; +import { BufferStream, SeekDir } from '@msagent.js/core'; -import { LOCATION } from './structs/core.js'; -import { AcsCharacterInfo } from './structs/character.js'; -import { AcsAnimationEntry } from './structs/animation.js'; -import { AcsImageEntry } from './structs/image.js'; +import { LOCATION } from '@msagent.js/core'; +import { AcsCharacterInfo } from '@msagent.js/core'; +import { AcsAnimationEntry } from '@msagent.js/core'; +import { AcsImageEntry } from '@msagent.js/core'; import { Agent } from './agent.js'; // Data diff --git a/msagent.js/src/contextmenu.ts b/msagent.js/web/src/contextmenu.ts similarity index 100% rename from msagent.js/src/contextmenu.ts rename to msagent.js/web/src/contextmenu.ts diff --git a/msagent.js/src/index.ts b/msagent.js/web/src/index.ts similarity index 75% rename from msagent.js/src/index.ts rename to msagent.js/web/src/index.ts index e30aaaa..8667ff9 100644 --- a/msagent.js/src/index.ts +++ b/msagent.js/web/src/index.ts @@ -1,9 +1,7 @@ -import { compressInit } from './decompress.js'; +import { compressInit } from '@msagent.js/core'; import { wordballoonInit } from './wordballoon.js'; -export * from './types.js'; export * from './character.js'; -export * from './decompress.js'; export * from './sprite.js'; export * from './wordballoon.js'; export * from './contextmenu.js'; diff --git a/msagent.js/src/sprite.ts b/msagent.js/web/src/sprite.ts similarity index 96% rename from msagent.js/src/sprite.ts rename to msagent.js/web/src/sprite.ts index 7aeafe8..a72aef3 100644 --- a/msagent.js/src/sprite.ts +++ b/msagent.js/web/src/sprite.ts @@ -1,6 +1,6 @@ // Sprite utilities -import { Rect } from './types'; +import { Rect } from '@msagent.js/core'; // Load a image asynchronously export async function spriteLoadImage(uri: string): Promise { diff --git a/msagent.js/src/wordballoon.ts b/msagent.js/web/src/wordballoon.ts similarity index 99% rename from msagent.js/src/wordballoon.ts rename to msagent.js/web/src/wordballoon.ts index a414268..cc11f49 100644 --- a/msagent.js/src/wordballoon.ts +++ b/msagent.js/web/src/wordballoon.ts @@ -1,5 +1,5 @@ import { spriteCutSpriteFromSpriteSheet, spriteDraw, spriteDrawRotated, spriteLoadImage } from './sprite'; -import { Point, Rect, Size } from './types'; +import { Point, Rect, Size } from '@msagent.js/core'; let corner_sprite: HTMLImageElement; let straight_sprite: HTMLImageElement; diff --git a/msagent.js/web/tsconfig.json b/msagent.js/web/tsconfig.json new file mode 100644 index 0000000..8473c6f --- /dev/null +++ b/msagent.js/web/tsconfig.json @@ -0,0 +1,108 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2022", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "es2022", /* Specify what module code is generated. */ + "rootDir": "src", /* Specify the root folder within your source files. */ + "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./dist", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +} diff --git a/package.json b/package.json index 0138548..2367614 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,8 @@ "server", "webapp", "protocol", - "msagent.js" + "msagent.js/core", + "msagent.js/web" ], "scripts": { "format": "prettier --write **/*.{ts,html,scss}", diff --git a/webapp/package.json b/webapp/package.json index 3895d64..8bd7bb7 100644 --- a/webapp/package.json +++ b/webapp/package.json @@ -9,7 +9,7 @@ }, "packageManager": "yarn@4.2.2", "devDependencies": { - "@msagent-chat/msagent.js": "*", + "@msagent.js/web": "*", "@parcel/core": "^2.12.0", "parcel": "^2.12.0", "run-script-os": "^1.1.6", diff --git a/webapp/src/ts/client.ts b/webapp/src/ts/client.ts index ae44441..b0be591 100644 --- a/webapp/src/ts/client.ts +++ b/webapp/src/ts/client.ts @@ -24,7 +24,7 @@ import { MSAgentTalkMessage } from '@msagent-chat/protocol'; import { User } from './user'; -import { agentCreateCharacterFromUrl, ContextMenuItem } from '@msagent-chat/msagent.js'; +import { agentCreateCharacterFromUrl, ContextMenuItem } from '@msagent.js/web'; export interface MSAgentClientEvents { close: () => void; diff --git a/webapp/src/ts/main.ts b/webapp/src/ts/main.ts index 296411d..b71a18a 100644 --- a/webapp/src/ts/main.ts +++ b/webapp/src/ts/main.ts @@ -1,5 +1,5 @@ import { MSWindow, MSWindowStartPosition } from './MSWindow.js'; -import { agentInit } from '@msagent-chat/msagent.js'; +import { agentInit } from '@msagent.js/web'; import { MSAgentClient } from './client.js'; import { Config } from '../../config.js'; import { RunCommand } from './commands.js'; diff --git a/webapp/src/ts/testbed.ts b/webapp/src/ts/testbed.ts index a2df379..1c387e9 100644 --- a/webapp/src/ts/testbed.ts +++ b/webapp/src/ts/testbed.ts @@ -1,7 +1,7 @@ // Testbed code // This will go away when it isn't needed -import * as msagent from '@msagent-chat/msagent.js'; +import * as msagent from '@msagent.js/web'; let w = window as any; w.agents = []; let input = document.getElementById('testbed-input') as HTMLInputElement; diff --git a/yarn.lock b/yarn.lock index 0a0a771..43eed7e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -478,16 +478,6 @@ __metadata: languageName: node linkType: hard -"@msagent-chat/msagent.js@npm:*, @msagent-chat/msagent.js@workspace:msagent.js": - version: 0.0.0-use.local - resolution: "@msagent-chat/msagent.js@workspace:msagent.js" - dependencies: - "@parcel/core": "npm:^2.12.0" - parcel: "npm:^2.12.0" - typescript: "npm:^5.5.3" - languageName: unknown - linkType: soft - "@msagent-chat/protocol@workspace:protocol": version: 0.0.0-use.local resolution: "@msagent-chat/protocol@workspace:protocol" @@ -525,7 +515,7 @@ __metadata: version: 0.0.0-use.local resolution: "@msagent-chat/webapp@workspace:webapp" dependencies: - "@msagent-chat/msagent.js": "npm:*" + "@msagent.js/web": "npm:*" "@parcel/core": "npm:^2.12.0" nanoevents: "npm:^9.0.0" parcel: "npm:^2.12.0" @@ -535,6 +525,27 @@ __metadata: languageName: unknown linkType: soft +"@msagent.js/core@npm:*, @msagent.js/core@workspace:msagent.js/core": + version: 0.0.0-use.local + resolution: "@msagent.js/core@workspace:msagent.js/core" + dependencies: + "@parcel/core": "npm:^2.12.0" + parcel: "npm:^2.12.0" + typescript: "npm:^5.5.3" + languageName: unknown + linkType: soft + +"@msagent.js/web@npm:*, @msagent.js/web@workspace:msagent.js/web": + version: 0.0.0-use.local + resolution: "@msagent.js/web@workspace:msagent.js/web" + dependencies: + "@msagent.js/core": "npm:*" + "@parcel/core": "npm:^2.12.0" + parcel: "npm:^2.12.0" + typescript: "npm:^5.5.3" + languageName: unknown + linkType: soft + "@msgpackr-extract/msgpackr-extract-darwin-arm64@npm:3.0.3": version: 3.0.3 resolution: "@msgpackr-extract/msgpackr-extract-darwin-arm64@npm:3.0.3" -- 2.46.2 From f8511894e3be2dfdae015c2172288cb581eb48f1 Mon Sep 17 00:00:00 2001 From: modeco80 Date: Sun, 25 Aug 2024 09:05:51 -0400 Subject: [PATCH 2/3] move character parsing stuff to core --- msagent.js/core/src/index.ts | 2 ++ msagent.js/core/src/parse.ts | 46 +++++++++++++++++++++++++++ msagent.js/web/src/character.ts | 55 ++------------------------------- webapp/src/ts/main.ts | 3 +- webapp/src/ts/user.ts | 2 +- 5 files changed, 54 insertions(+), 54 deletions(-) create mode 100644 msagent.js/core/src/parse.ts diff --git a/msagent.js/core/src/index.ts b/msagent.js/core/src/index.ts index 0b5df58..823640f 100644 --- a/msagent.js/core/src/index.ts +++ b/msagent.js/core/src/index.ts @@ -8,3 +8,5 @@ export * from './structs/image.js'; export * from './types.js'; export * from './decompress.js'; + +export * from './parse.js'; diff --git a/msagent.js/core/src/parse.ts b/msagent.js/core/src/parse.ts new file mode 100644 index 0000000..33f099d --- /dev/null +++ b/msagent.js/core/src/parse.ts @@ -0,0 +1,46 @@ +import { BufferStream, SeekDir } from './buffer.js'; + +import { LOCATION } from './structs/core.js'; +import { AcsCharacterInfo } from './structs/character.js'; +import { AcsAnimationEntry } from './structs/animation.js'; +import { AcsImageEntry } from './structs/image.js'; + +// Data +export class AcsData { + characterInfo = new AcsCharacterInfo(); + animInfo: AcsAnimationEntry[] = []; + images: AcsImageEntry[] = []; +} + +export function agentCharacterParseACS(buffer: BufferStream): AcsData { + // Make sure the magic is correct for the ACS file. + if (buffer.readU32LE() != 0xabcdabc3) { + throw new Error('The provided data buffer does not contain valid ACS data.'); + } + + let acsData = new AcsData(); + + // Read the rest of the header. + let characterInfoLocation = LOCATION.read(buffer); + let animationInfoLocation = LOCATION.read(buffer); + let imageInfoLocation = LOCATION.read(buffer); + let audioInfoLocation = LOCATION.read(buffer); + + buffer.withOffset(characterInfoLocation.offset, () => { + acsData.characterInfo = AcsCharacterInfo.read(buffer); + }); + + buffer.withOffset(animationInfoLocation.offset, () => { + acsData.animInfo = buffer.readCountedList(() => { + return AcsAnimationEntry.read(buffer); + }); + }); + + buffer.withOffset(imageInfoLocation.offset, () => { + acsData.images = buffer.readCountedList(() => { + return AcsImageEntry.read(buffer); + }); + }); + + return acsData; +} diff --git a/msagent.js/web/src/character.ts b/msagent.js/web/src/character.ts index dfe6c2c..a089783 100644 --- a/msagent.js/web/src/character.ts +++ b/msagent.js/web/src/character.ts @@ -1,18 +1,6 @@ -import { BufferStream, SeekDir } from '@msagent.js/core'; - -import { LOCATION } from '@msagent.js/core'; -import { AcsCharacterInfo } from '@msagent.js/core'; -import { AcsAnimationEntry } from '@msagent.js/core'; -import { AcsImageEntry } from '@msagent.js/core'; +import { agentCharacterParseACS, AcsData, BufferStream } from '@msagent.js/core'; import { Agent } from './agent.js'; -// Data -export class AcsData { - characterInfo = new AcsCharacterInfo(); - animInfo: AcsAnimationEntry[] = []; - images: AcsImageEntry[] = []; -} - // Cache of ACS data per character (for agentCreateCharacterFromUrl) let acsDataCache = new Map(); @@ -21,47 +9,10 @@ export function agentPurgeACSCache() { acsDataCache.clear(); } -export function agentCharacterParseACS(buffer: BufferStream): AcsData { - // Make sure the magic is correct for the ACS file. - if (buffer.readU32LE() != 0xabcdabc3) { - throw new Error('The provided data buffer does not contain valid ACS data.'); - } - - let acsData = new AcsData(); - - // Read the rest of the header. - let characterInfoLocation = LOCATION.read(buffer); - let animationInfoLocation = LOCATION.read(buffer); - let imageInfoLocation = LOCATION.read(buffer); - let audioInfoLocation = LOCATION.read(buffer); - - buffer.withOffset(characterInfoLocation.offset, () => { - acsData.characterInfo = AcsCharacterInfo.read(buffer); - }); - - buffer.withOffset(animationInfoLocation.offset, () => { - acsData.animInfo = buffer.readCountedList(() => { - return AcsAnimationEntry.read(buffer); - }); - }); - - buffer.withOffset(imageInfoLocation.offset, () => { - acsData.images = buffer.readCountedList(() => { - return AcsImageEntry.read(buffer); - }); - }); - - return acsData; -} - -export function agentCreateCharacter(data: AcsData): Agent { - return new Agent(data); -} - export async function agentCreateCharacterFromUrl(url: string): Promise { // just return the cache object if (acsDataCache.has(url)) { - return agentCreateCharacter(acsDataCache.get(url)!); + return new Agent(acsDataCache.get(url)!); } else { let res = await fetch(url); let data = await res.arrayBuffer(); @@ -70,6 +21,6 @@ export async function agentCreateCharacterFromUrl(url: string): Promise { let acsData = agentCharacterParseACS(new BufferStream(buffer)); acsDataCache.set(url, acsData); - return agentCreateCharacter(acsData); + return new Agent(acsData); } } diff --git a/webapp/src/ts/main.ts b/webapp/src/ts/main.ts index b71a18a..023586b 100644 --- a/webapp/src/ts/main.ts +++ b/webapp/src/ts/main.ts @@ -1,5 +1,5 @@ import { MSWindow, MSWindowStartPosition } from './MSWindow.js'; -import { agentInit } from '@msagent.js/web'; +import { agentInit, agentPurgeACSCache } from '@msagent.js/web'; import { MSAgentClient } from './client.js'; import { Config } from '../../config.js'; import { RunCommand } from './commands.js'; @@ -36,6 +36,7 @@ function roomInit() { user.agent.remove(); } roomInit(); + agentPurgeACSCache(); loggingIn = false; elements.logonButton.disabled = false; logonWindow.show(); diff --git a/webapp/src/ts/user.ts b/webapp/src/ts/user.ts index 1cad4f2..d8c2b8f 100644 --- a/webapp/src/ts/user.ts +++ b/webapp/src/ts/user.ts @@ -1,4 +1,4 @@ -import { Agent } from '@msagent-chat/msagent.js'; +import { Agent } from '@msagent.js/web'; import { AgentAnimationConfig } from '@msagent-chat/protocol'; export class User { -- 2.46.2 From d97004a6ddbd7613a99736d45c53ed5547aabd1d Mon Sep 17 00:00:00 2001 From: modeco80 Date: Sun, 25 Aug 2024 09:22:06 -0400 Subject: [PATCH 3/3] move image drawing to core also adjust for some api changes I forgot to fix --- msagent.js/core/src/image.ts | 49 ++++++++++++++++++++++++++++++++++++ msagent.js/core/src/index.ts | 1 + msagent.js/web/src/agent.ts | 41 +++--------------------------- msagent.js/web/src/index.ts | 1 + webapp/src/ts/testbed.ts | 5 +++- 5 files changed, 58 insertions(+), 39 deletions(-) create mode 100644 msagent.js/core/src/image.ts diff --git a/msagent.js/core/src/image.ts b/msagent.js/core/src/image.ts new file mode 100644 index 0000000..7e1e02d --- /dev/null +++ b/msagent.js/core/src/image.ts @@ -0,0 +1,49 @@ +import { AcsImageEntry } from './structs/image'; + +// probably should be in a utility module +function dwAlign(off: number): number { + let ul = off >>> 0; + + ul += 3; + ul >>= 2; + ul <<= 2; + return ul; +} + +import { BufferStream, SeekDir } from './buffer'; +import { RGBAColor } from './structs/core'; + +/// Draws an ACS image to a newly allocated buffer. +/// This function normalizes the agent 8bpp DIB format to a saner RGBA format, +/// that can be directly converted to an ImageData for drawing to a web canvas. +/// +/// However, that should be done (and is done) by a higher level web layer. +export function imageDrawToBuffer(imageEntry: AcsImageEntry, palette: RGBAColor[]) { + let rgbaBuffer = new Uint32Array(imageEntry.image.width * imageEntry.image.height); + + let buffer = imageEntry.image.data; + let bufStream = new BufferStream(buffer); + + let rows = new Array(imageEntry.image.height - 1); + + // Read all the rows bottom-up first. This idiosyncracy is due to the fact + // that the bitmap data is actually formatted to be used as a GDI DIB + // (device-independent bitmap), so it inherits all the strange baggage from that. + for (let y = imageEntry.image.height - 1; y >= 0; --y) { + let row = bufStream.subBuffer(imageEntry.image.width).raw(); + rows[y] = row.slice(0, imageEntry.image.width); + + // Seek to the next DWORD aligned spot to get to the next row. + // For most images this may mean not seeking at all. + bufStream.seek(dwAlign(bufStream.tell()), SeekDir.BEG); + } + + // Next, draw the rows converted to RGBA, top down (so it's drawn as you'd expect) + for (let y = 0; y < imageEntry.image.height - 1; ++y) { + let row = rows[y]; + for (let x = 0; x < imageEntry.image.width; ++x) { + rgbaBuffer[y * imageEntry.image.width + x] = palette[row[x]].to_rgba(); + } + } + return rgbaBuffer; +} diff --git a/msagent.js/core/src/index.ts b/msagent.js/core/src/index.ts index 823640f..86ec132 100644 --- a/msagent.js/core/src/index.ts +++ b/msagent.js/core/src/index.ts @@ -9,4 +9,5 @@ export * from './structs/image.js'; export * from './types.js'; export * from './decompress.js'; +export * from './image.js'; export * from './parse.js'; diff --git a/msagent.js/web/src/agent.ts b/msagent.js/web/src/agent.ts index 1c8d353..29c727f 100644 --- a/msagent.js/web/src/agent.ts +++ b/msagent.js/web/src/agent.ts @@ -1,20 +1,12 @@ -import { BufferStream, SeekDir } from '@msagent.js/core'; -import { AcsData } from './character.js'; +import { BufferStream, SeekDir, imageDrawToBuffer } from '@msagent.js/core'; +import { AcsData } from '@msagent.js/core'; import { ContextMenu, ContextMenuItem } from './contextmenu.js'; import { AcsAnimation, AcsAnimationFrameInfo } from '@msagent.js/core'; import { AcsImageEntry } from '@msagent.js/core'; import { Point, Size } from '@msagent.js/core'; import { wordballoonDrawImage, wordballoonDrawText } from './wordballoon.js'; -// probably should be in a utility module -function dwAlign(off: number): number { - let ul = off >>> 0; - ul += 3; - ul >>= 2; - ul <<= 2; - return ul; -} function randint(min: number, max: number) { return Math.floor(Math.random() * (max - min) + min); @@ -316,34 +308,7 @@ export class Agent { // Draw a single image from the agent's image table. drawImage(imageEntry: AcsImageEntry, xOffset: number, yOffset: number) { - let rgbaBuffer = new Uint32Array(imageEntry.image.width * imageEntry.image.height); - - let buffer = imageEntry.image.data; - let bufStream = new BufferStream(buffer); - - let rows = new Array(imageEntry.image.height - 1); - - // Read all the rows bottom-up first. This idiosyncracy is due to the fact - // that the bitmap data is actually formatted to be used as a GDI DIB - // (device-independent bitmap), so it inherits all the strange baggage from that. - for (let y = imageEntry.image.height - 1; y >= 0; --y) { - let row = bufStream.subBuffer(imageEntry.image.width).raw(); - let rowResized = row.slice(0, imageEntry.image.width); - rows[y] = rowResized; - - // Seek to the next DWORD aligned spot to get to the next row. - // For most images this may mean not seeking at all. - bufStream.seek(dwAlign(bufStream.tell()), SeekDir.BEG); - } - - // Next, draw the rows converted to RGBA, top down (so it's drawn as you'd expect) - for (let y = 0; y < imageEntry.image.height - 1; ++y) { - let row = rows[y]; - for (let x = 0; x < imageEntry.image.width; ++x) { - rgbaBuffer[y * imageEntry.image.width + x] = this.data.characterInfo.palette[row[x]].to_rgba(); - } - } - + let rgbaBuffer = imageDrawToBuffer(imageEntry, this.data.characterInfo.palette); let data = new ImageData(new Uint8ClampedArray(rgbaBuffer.buffer), imageEntry.image.width, imageEntry.image.height); this.ctx.putImageData(data, xOffset, yOffset); } diff --git a/msagent.js/web/src/index.ts b/msagent.js/web/src/index.ts index 8667ff9..e321a12 100644 --- a/msagent.js/web/src/index.ts +++ b/msagent.js/web/src/index.ts @@ -1,6 +1,7 @@ import { compressInit } from '@msagent.js/core'; import { wordballoonInit } from './wordballoon.js'; +export { Agent } from './agent.js'; export * from './character.js'; export * from './sprite.js'; export * from './wordballoon.js'; diff --git a/webapp/src/ts/testbed.ts b/webapp/src/ts/testbed.ts index 1c387e9..915d5d1 100644 --- a/webapp/src/ts/testbed.ts +++ b/webapp/src/ts/testbed.ts @@ -2,6 +2,8 @@ // This will go away when it isn't needed import * as msagent from '@msagent.js/web'; +import * as msagent_core from '@msagent.js/core'; + let w = window as any; w.agents = []; let input = document.getElementById('testbed-input') as HTMLInputElement; @@ -12,7 +14,8 @@ input.addEventListener('change', async () => { let buffer = await input.files![0].arrayBuffer(); console.log('Creating agent'); - let agent = msagent.agentCreateCharacter(new Uint8Array(buffer)); + let agentParsedData = msagent_core.agentCharacterParseACS(new msagent_core.BufferStream(new Uint8Array(buffer))); + let agent = new msagent.Agent(agentParsedData); w.agents.push(agent); -- 2.46.2