void

basic 2D game library.

Installation

``
npm install --save @oidoid/void
`

$3

- Aseprite
- cwebp

Development

$3

1. clone void as a sibling directory of the game.
2. npm link ../void from the game.
3. add customConditions to the root tsconfig for esbuild and a void reference for tsc. Eg:

`jsonc
{
"extends": "./tsconfig.prod.json",
"compilerOptions": {
"customConditions": ["dev"],
},
"references": [{"path": "../void"}]
}
`

it's possible to use "paths": {"@oidoid/void": ["../void/src"]} instead of or in addition to customConditions.
4. for unit tests, run with NODE_OPTIONS=--conditions=dev.

$3

to avoid threading template parameters throughout all code, declaration merging is used for the following:

- AtlasMap
- CamSchema
- CamUpdater
- Debug
- Draw
- DrawSchema
- Ent
- EntSchema
- LevelZoo
- Loader
- PoolMap
- ReturnTag
- Sys

it's similar to modifying HTMLElementTagNameMap.

$3

queries declare system dependencies.

sprite is a kind of common denominator for position and area. if the ent should have no visual representation, leave the sprite as hidden.

$3

lists then ents are typically updated in insertion order. the cam and then cursor _ents_ should appear first.

components are parsed and updated in key order. the recommended order is:

- debugInput
- id
- name
- text
- sprite
- textWH
- cursor
- hud
- ninePatch
- button
- textXY
- invalid
- override

systems are uniquely associated with a key. zero or one system per key. if multiple keys on an ent are associated with a system, it will be run multiple times per update.

$3

there are two schemas: a game configuration (void.json) and level configs (*.level.jsonc). the parser assumes a valid schema to minimize code size.

levels are described with the level schema. some schema components may only be applied at parse time.

$3

ents and subsystems self-report as invalid when an update or render is required. ents should avoid reading another ent's invalid state since it's cleared once that ent has been updated.

Copyright and License

© oidoid.

$3

This program is free software: you can redistribute it and/or modify it under
the terms of the GNU Affero General Public License as published by the Free
Software Foundation, either version 3 of the License, or (at your option) any
later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along
with this program. If not, see .

`
╭>°╮┬┌─╮╭─╮┬┌─╮
╰──╯┴└─╯╰─╯┴└─╯
``