diff --git a/CHANGELOG.md b/CHANGELOG.md index 83aeb9c..43ed0f4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [1.0.0-beta] - 2023-04-30 + +Initial beta release. + ## [0.8.0] - 2021-12-27 ### Added diff --git a/docs/api/functions/render.html b/docs/api/functions/render.html index e512ca4..71fb3fd 100644 --- a/docs/api/functions/render.html +++ b/docs/api/functions/render.html @@ -35,7 +35,7 @@
opts: Returns Svg

A valid SVG.js Svg object

+
  • Defined in index.ts:151
    • diff --git a/docs/api/functions/renderStatic.html b/docs/api/functions/renderStatic.html index 9c73638..3ab20fd 100644 --- a/docs/api/functions/renderStatic.html +++ b/docs/api/functions/renderStatic.html @@ -36,7 +36,7 @@
    opts: Returns string

    A string containing a valid <svg> tag

    +
  • Defined in index.ts:90
    • diff --git a/docs/api/functions/renderglyph.html b/docs/api/functions/renderglyph.html index 39045a5..4a76543 100644 --- a/docs/api/functions/renderglyph.html +++ b/docs/api/functions/renderglyph.html @@ -39,7 +39,7 @@
    opts: Returns string

    A string containing a valid <svg> tag

    +
  • Defined in index.ts:108
    • diff --git a/docs/api/interfaces/APRenderRep.html b/docs/api/interfaces/APRenderRep.html index 552cd1a..060e81a 100644 --- a/docs/api/interfaces/APRenderRep.html +++ b/docs/api/interfaces/APRenderRep.html @@ -26,7 +26,7 @@

    Hierarchy

    Indexable

    [k: string]: unknown
    +
  • Defined in schemas/schema.d.ts:21
    • @@ -50,21 +50,21 @@

    Optional

    Instruct the renderer how to show any changes to the game state. See the docs for details. For the entropy renderer, the pieces are theoretically laid out on a grid 14 cells wide. So to show annotations on the second board, you will reference column indexes starting at 7. The number of rows does not change.

    +
  • Defined in schemas/schema.d.ts:443

    • Optional areas

    areas?: ({
        B: string;
        G: string;
        R: string;
        Y: string;
        type: "globalStash";
    } | {
        cell?: string;
        stack: string[];
        type: "expandedColumn";
    } | {
        label: string;
        stash: string[][];
        type: "localStash";
    } | {
        buffer?: number;
        buttons: [{
            attributes?: [{
                name: string;
                value: string;
            }, ...{
                name: string;
                value: string;
            }[]];
            label: string;
            value?: string;
            [k: string]: unknown;
        }, ...{
            attributes?: [{
                name: string;
                value: string;
            }, ...{
                name: string;
                value: string;
            }[]];
            label: string;
            value?: string;
            [k: string]: unknown;
        }[]];
        colour?: string;
        height?: number;
        minWidth?: number;
        position?: "left" | "right";
        type: "buttonBar";
    } | {
        buffer?: number;
        clickable?: boolean;
        height?: number;
        list: {
            name: string;
            piece: string;
            value?: string;
        }[];
        position?: "left" | "right";
        type?: "key";
    })[]

    Areas are renderer-specific elements that are used and rendered in various ways.

    +
  • Defined in schemas/schema.d.ts:300

    • board

    board: null | {
        buffer?: {
            pattern?: string;
            show?: ("S" | "N" | "E" | "W")[];
            width: number;
        };
        height?: number;
        markers?: ({
            points: [{
                col: number;
                row: number;
            }, ...{
                col: number;
                row: number;
            }[]];
            type: "dots";
        } | {
            colour?: string | number;
            opacity?: number;
            points: [{
                col: number;
                row: number;
            }, {
                col: number;
                row: number;
            }, {
                col: number;
                row: number;
            }, ...{
                col: number;
                row: number;
            }[]];
            type: "shading";
        } | {
            colour: string | number;
            edge: "S" | "N" | "E" | "W" | "NE" | "SE" | "SW" | "NW";
            type: "edge";
        } | {
            cell: {
                col: number;
                row: number;
            };
            colour?: string | number;
            side: "S" | "N" | "E" | "W";
            type: "fence";
        } | {
            glyph: string;
            points: [{
                col: number;
                row: number;
            }, ...{
                col: number;
                row: number;
            }[]];
            type: "glyph";
        })[];
        maxWidth?: number;
        minWidth?: number;
        stackOffset?: number;
        strokeColour?: string;
        strokeOpacity?: number;
        strokeWeight?: number;
        style: "squares" | "squares-checkered" | "squares-beveled" | "vertex" | "vertex-cross" | "go" | "hex-odd-p" | "hex-even-p" | "hex-odd-f" | "hex-even-f" | "hex-of-hex" | "hex-of-tri" | "hex-of-cir" | "snubsquare";
        tileHeight?: number;
        tileSpacing?: number;
        tileWidth?: number;
        width?: number;
    } | {
        name: string;
        seat?: "S" | "N" | "E" | "W";
        stars: [string, string] | [string];
    }[] | {
        boardOne?: {
            label?: string;
            occluded?: boolean;
        };
        boardTwo?: {
            label?: string;
            occluded?: boolean;
        };
        orientation?: "horizontal" | "vertical";
        strokeColour?: string;
        strokeOpacity?: number;
        strokeWeight?: number;
        style: "entropy";
        [k: string]: unknown;
    }

    This is the game board itself.

    +
  • Defined in schemas/schema.d.ts:39

    • Optional legend

    legend?: {
        [k: string]: string | Glyph | [Glyph, ...Glyph[]];
    }
    @@ -76,28 +76,28 @@

    Type declaration

  • [k: string]: string | Glyph | [Glyph, ...Glyph[]]
    • +
  • Defined in schemas/schema.d.ts:33

    • Optional options

    options?: "rotate-pieces"[]

    A list of flags to pass to the renderer.

    +
  • Defined in schemas/schema.d.ts:29

    • pieces

    pieces: null | string | [string[][], ...string[][][]] | [string, ...string[]][]

    Describes what pieces are where. For the entropy renderer, the pieces should be laid out on a grid 14 cells wide, which the renderer will break up into the two different boards.

    +
  • Defined in schemas/schema.d.ts:296

    • Optional renderer

    renderer?: "default" | "stacking-offset" | "stacking-tiles" | "stacking-expanding" | "homeworlds" | "entropy"

    The rendering engine the game wants to use.

    +
  • Defined in schemas/schema.d.ts:25
    • diff --git a/docs/api/interfaces/Glyph.html b/docs/api/interfaces/Glyph.html index 55efb58..0ed0f88 100644 --- a/docs/api/interfaces/Glyph.html +++ b/docs/api/interfaces/Glyph.html @@ -23,7 +23,7 @@

    Hierarchy

    • Glyph
    +
  • Defined in schemas/schema.d.ts:500
    • @@ -48,14 +48,14 @@

    Optional

    A 3- or 6-digit hex colour value. Do not use this to assign player colours! This should only be used for tweaking composite pieces. Ignored if player is also defined.

    +
  • Defined in schemas/schema.d.ts:516

    • Optional name

    name?: string

    The name of the actual glyph. It may not contain any whitespace.

    +
  • Defined in schemas/schema.d.ts:504

    • Optional nudge

    nudge?: {
        dx?: number;
        dy?: number;
    }
    @@ -73,42 +73,42 @@
    Optional

    Negative values move the glyph up.

    +
  • Defined in schemas/schema.d.ts:532

    • Optional opacity

    opacity?: number

    A number between 0 and 1 indicating how opaque to render the glyph. A value of 0 means completely transparent.

    +
  • Defined in schemas/schema.d.ts:524

    • Optional player

    player?: number

    A positive integer pointing to a player position. Based on user settings, an appropriate background fill colour will be chosen.

    +
  • Defined in schemas/schema.d.ts:512

    • Optional rotate

    rotate?: number

    A number between -360 and 360 representing the degrees to rotate the glyph. Negative values rotate counterclockwise.

    +
  • Defined in schemas/schema.d.ts:528

    • Optional scale

    scale?: number

    A number representing how you want the glyph proportionately scaled. Numbers <1 will shrink the glyph. Numbers >1 will enlarge it.

    +
  • Defined in schemas/schema.d.ts:520

    • Optional text

    text?: string

    Mutually exclusive with name. In this case, the glyph is plain text, shrunk down to the appropriate size to fit in a cell. This is intended for very short strings, like numbers.

    +
  • Defined in schemas/schema.d.ts:508
    • diff --git a/docs/api/interfaces/IRenderOptions.html b/docs/api/interfaces/IRenderOptions.html index 3c1158f..905b4a8 100644 --- a/docs/api/interfaces/IRenderOptions.html +++ b/docs/api/interfaces/IRenderOptions.html @@ -26,7 +26,7 @@

    Hierarchy

    • IRenderOptions
    +
  • Defined in index.ts:29
    • @@ -84,7 +84,7 @@
    piece: Returns void
    +
  • Defined in renderers/_base.ts:71

    • Optional boardHover

    boardHover?: ((row, col, piece) => void)
    @@ -115,7 +115,7 @@
    piece: Returns void
    +
  • Defined in renderers/_base.ts:79

    • Optional colourBlind

    colourBlind?: boolean
    @@ -123,7 +123,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:42

    • Optional colours

    colours?: string[]
    @@ -132,7 +132,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:26

    • Optional columnLabels

    columnLabels?: string
    @@ -140,14 +140,14 @@

    Optional

    +
  • Defined in renderers/_base.ts:57

    • Optional divelem

    divelem?: HTMLElement

    You can also pass the HTML element itself.

    +
  • Defined in index.ts:40

    • Optional divid

    divid?: string
    @@ -155,7 +155,7 @@

    Optional

    +
  • Defined in index.ts:35

    • Optional glyphmap

    glyphmap?: [string, string][]
    @@ -164,7 +164,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:63

    • Optional height

    height?: NumberAlias
    @@ -172,7 +172,7 @@

    Optional

    +
  • Defined in index.ts:58

    • Optional patternList

    patternList?: string[]
    @@ -181,7 +181,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:37

    • Optional patterns

    patterns?: boolean
    @@ -189,7 +189,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:31

    • Optional rotate

    rotate?: number
    @@ -198,7 +198,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:48

    • Optional sheets

    sheets?: string[]
    @@ -207,7 +207,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:20

    • Optional showAnnotations

    showAnnotations?: boolean
    @@ -215,14 +215,14 @@

    Optional

    +
  • Defined in renderers/_base.ts:53

    • Optional svgid

    svgid?: string

    The string DOM ID you want the final output out be given.

    +
  • Defined in index.ts:63

    • Optional target

    target?: Svg
    @@ -230,7 +230,7 @@

    Optional

    +
  • Defined in index.ts:46

    • Optional width

    width?: NumberAlias
    @@ -238,7 +238,7 @@

    Optional

    +
  • Defined in index.ts:52
    • diff --git a/docs/api/interfaces/IRendererOptionsIn.html b/docs/api/interfaces/IRendererOptionsIn.html index ccbe81f..e0ceaf1 100644 --- a/docs/api/interfaces/IRendererOptionsIn.html +++ b/docs/api/interfaces/IRendererOptionsIn.html @@ -25,7 +25,7 @@

    Hierarchy

    +
  • Defined in renderers/_base.ts:14
    • @@ -76,7 +76,7 @@
    piece: Returns void
    +
  • Defined in renderers/_base.ts:71

    • Optional boardHover

    boardHover?: ((row, col, piece) => void)
    @@ -106,14 +106,14 @@
    piece: Returns void
    +
  • Defined in renderers/_base.ts:79

    • Optional colourBlind

    colourBlind?: boolean

    Signals whether you want to use the built-in set of four colour-blind-friendly colours.

    +
  • Defined in renderers/_base.ts:42

    • Optional colours

    colours?: string[]
    @@ -121,14 +121,14 @@

    Optional

    +
  • Defined in renderers/_base.ts:26

    • Optional columnLabels

    columnLabels?: string

    A string of unique characters that will be used to create column labels. Defaults to the lowercase English alphabet.

    +
  • Defined in renderers/_base.ts:57

    • Optional glyphmap

    glyphmap?: [string, string][]
    @@ -136,7 +136,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:63

    • Optional patternList

    patternList?: string[]
    @@ -144,14 +144,14 @@

    Optional

    +
  • Defined in renderers/_base.ts:37

    • Optional patterns

    patterns?: boolean

    Signals whether you want black and white patterns used instead of colours.

    +
  • Defined in renderers/_base.ts:31

    • Optional rotate

    rotate?: number
    @@ -159,7 +159,7 @@

    Optional

    +
  • Defined in renderers/_base.ts:48

    • Optional sheets

    sheets?: string[]
    @@ -167,14 +167,14 @@

    Optionalcore.

    +
  • Defined in renderers/_base.ts:20

    • Optional showAnnotations

    showAnnotations?: boolean

    Signals whether you want move annotations shown.

    +
  • Defined in renderers/_base.ts:53
    • diff --git a/docs/api/types/Colourstrings.html b/docs/api/types/Colourstrings.html index 28058cf..59f63f2 100644 --- a/docs/api/types/Colourstrings.html +++ b/docs/api/types/Colourstrings.html @@ -19,7 +19,7 @@

    Type alias Colourstrings

    Pattern for hex colour strings

    +
  • Defined in schemas/schema.d.ts:12
    • diff --git a/docs/api/types/PositiveInteger.html b/docs/api/types/PositiveInteger.html index 4605d82..23c8e7b 100644 --- a/docs/api/types/PositiveInteger.html +++ b/docs/api/types/PositiveInteger.html @@ -21,7 +21,7 @@

    Type alias PositiveInteger

    and run json-schema-to-typescript to regenerate this file.

    +
  • Defined in schemas/schema.d.ts:8
    • diff --git a/docs/api/types/Stashstrings.html b/docs/api/types/Stashstrings.html index 2f7011d..e3f57cf 100644 --- a/docs/api/types/Stashstrings.html +++ b/docs/api/types/Stashstrings.html @@ -19,7 +19,7 @@

    Type alias Stashstrings

    Pattern for the global stash definitions for the homeworlds renderer.

    +
  • Defined in schemas/schema.d.ts:16
    • diff --git a/package.json b/package.json index 4042069..e6ced25 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@abstractplay/renderer", - "version": "0.8.0", + "version": "1.0.0-beta", "description": "Renders Abstract Play game states graphically", "repository": { "type": "git",