coreize-msagent #20

Open
modeco80 wants to merge 3 commits from coreize-msagent into master
34 changed files with 277 additions and 96 deletions

View file

@ -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.

View file

@ -1,5 +1,5 @@
{
"name": "@msagent-chat/msagent.js",
"name": "@msagent.js/core",
"version": "0.1.0",
"packageManager": "yarn@4.2.2",
"devDependencies": {

View file

@ -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 {

View file

@ -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<Uint8Array>(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;
}

View file

@ -0,0 +1,13 @@
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';
export * from './image.js';
export * from './parse.js';

View file

@ -4,7 +4,6 @@ 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 { Agent } from './agent.js';
// Data
export class AcsData {
@ -13,14 +12,6 @@ export class AcsData {
images: AcsImageEntry[] = [];
}
// Cache of ACS data per character (for agentCreateCharacterFromUrl)
let acsDataCache = new Map<string, AcsData>();
// Purges the ACS cache.
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) {
@ -53,23 +44,3 @@ export function agentCharacterParseACS(buffer: BufferStream): AcsData {
return acsData;
}
export function agentCreateCharacter(data: AcsData): Agent {
return new Agent(data);
}
export async function agentCreateCharacterFromUrl(url: string): Promise<Agent> {
// just return the cache object
if (acsDataCache.has(url)) {
return agentCreateCharacter(acsDataCache.get(url)!);
} else {
let res = await fetch(url);
let data = await res.arrayBuffer();
let buffer = new Uint8Array(data);
let acsData = agentCharacterParseACS(new BufferStream(buffer));
acsDataCache.set(url, acsData);
return agentCreateCharacter(acsData);
}
}

View file

@ -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"
}

View file

Before

Width:  |  Height:  |  Size: 218 B

After

Width:  |  Height:  |  Size: 218 B

View file

@ -1,20 +1,12 @@
import { BufferStream, SeekDir } from './buffer.js';
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 './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
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<Uint8Array>(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);
}

View file

@ -0,0 +1,26 @@
import { agentCharacterParseACS, AcsData, BufferStream } from '@msagent.js/core';
import { Agent } from './agent.js';
// Cache of ACS data per character (for agentCreateCharacterFromUrl)
let acsDataCache = new Map<string, AcsData>();
// Purges the ACS cache.
export function agentPurgeACSCache() {
acsDataCache.clear();
}
export async function agentCreateCharacterFromUrl(url: string): Promise<Agent> {
// just return the cache object
if (acsDataCache.has(url)) {
return new Agent(acsDataCache.get(url)!);
} else {
let res = await fetch(url);
let data = await res.arrayBuffer();
let buffer = new Uint8Array(data);
let acsData = agentCharacterParseACS(new BufferStream(buffer));
acsDataCache.set(url, acsData);
return new Agent(acsData);
}
}

View file

@ -1,9 +1,8 @@
import { compressInit } from './decompress.js';
import { compressInit } from '@msagent.js/core';
import { wordballoonInit } from './wordballoon.js';
export * from './types.js';
export { Agent } from './agent.js';
export * from './character.js';
export * from './decompress.js';
export * from './sprite.js';
export * from './wordballoon.js';
export * from './contextmenu.js';

View file

@ -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<HTMLImageElement> {

View file

@ -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;

View file

@ -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 '<reference>'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. */
}
}

View file

@ -4,7 +4,8 @@
"server",
"webapp",
"protocol",
"msagent.js"
"msagent.js/core",
"msagent.js/web"
],
"scripts": {
"format": "prettier --write **/*.{ts,html,scss}",

View file

@ -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",

View file

@ -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;

View file

@ -1,5 +1,5 @@
import { MSWindow, MSWindowStartPosition } from './MSWindow.js';
import { agentInit } from '@msagent-chat/msagent.js';
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();

View file

@ -1,7 +1,9 @@
// 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';
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);

View file

@ -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 {

View file

@ -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"