narrat 2.10.2 → 2.10.4

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 Liana Pigeot
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 Liana Pigeot
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,136 +1,136 @@
-# 🚀 Narrat
-
-![example workflow](https://github.com/liana-p/narrat-engine/actions/workflows/main.yml/badge.svg) [![Netlify Status](https://api.netlify.com/api/v1/badges/55d4b9ba-62b7-4c43-86ce-8bc2aaf98643/deploy-status)](https://app.netlify.com/sites/ornate-pie-561978/deploys)
-
-Work on the engine directly in Codeflow:
-
-[![Open in Codeflow](./docs/open-in-codeflow.svg)](https://pr.new/liana-p/narrat-engine)
-
-Or try editing the default narrat game easily:
-
-[![Try editing the default game](./docs/open-in-codeflow.svg)](https:///pr.new/github.com/liana-p/narrat-engine/edit/main/packages/narrat/examples/games/default/scripts/default.nar)
-
-Narrat is a game engine for making interactive narrative RPGs packed with features.. Create your game by editing with a Simple scripting syntax. It supports Skills with skill check rolls, an Items inventory, and has a Quests System. The script system is very powerful and allows branching choices, functions, variables and conditions.
-
-More info on the [narrat website](https://get-narrat.com). There is an [online demo](https://get-narrat.com/demo/) available to try in the browser.
-
-## Getting Started
-
-The best way to get started in a minute is to follow the [Getting Started](https://docs.get-narrat.com/guides/getting-started) documentation page. It shows you to download the ready-to-use game template to get started writing a game with narrat.
-
-## Development (for contributors)
-
-Note: Narrat is a monorepo using `pnpm` as package manager. The `packages` folder contains the individual packages, including the main `narrat` package.
-
-Narrat is written in [TypeScript](https://www.typescriptlang.org/). It uses the [Vue](https://vuejs.org/) framework for front-end development. It also uses [pinia](https://pinia.vuejs.org/) for state management
-
-### Requirements
-
-- [node.js](https://nodejs.org/en/) (Downloading LTS is fine)
-- [pnpm](https://pnpm.io/). This Narrat repo is a monorepo using pnpm workspaces to easily manage the different packages.
-- A text editor capable of editing a TypeScript and Vue.js project. Recommended: [VSCode](https://code.visualstudio.com/) and the extension [Volar](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-volar) for Vue.
-
-### Running the engine for development
-
-1. Install dependencies
-
-`pnpm install`
-
-2. Run the demo
-
-`pnpm dev`
-
-This starts the engine on the demo page with the `example.nar` demo script loaded for testing.
-
-### Developping narrat specifically
-
-If developping on the narrat package, it's better to go inside the narrat package folder and run commands there.
-
-### Multiple demo games
-
-There are multiple demo games and it's possible to add new ones. For example `npm run rpg` will run the `rpg` demo. Demos are in the `examples` folder.
-
-Running a specific demo is done by changing an environment variables. See the scripts in `package.json` for how to run a specific demo.
-
-### Available pnpm commands in narrat
-
-- `start`: Start the demo for development
-- `build`: The main build command, builds the library in a state ready to use or publish.
-- `test`: Unit tests, used in CI
-- `dev`: Same as start
-- `generate-types`: Generates `.d.ts` type declaration files for the library (auto run on builds)
-- `fix-type-aliases`: Uses [tsc-alias](https://www.npmjs.com/package/tsc-alias) to auto-replace [path mappings](https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping) in the built files, as the TypeScript compiler doesn't do it. (auto run at the end of builds)
-- `lint`: Runs the linter on the code (used in CI)
-- `check-types`: Validates TypeScript types.
-
-### CI info
-
-The following tasks run on CI, and CI is required to pass for pull requests to be merged:
-
-- Linting
-- Engine build
-- Unit tests (currently only the parser is unit tested)
-- TypeScript type checking.
-
-Please make sure your code passes lint/tests/build/type checks before opening a PR.
-
-### Working on the code
-
-The narrat codebase isn't currently documented, outside of the [usage docs](https://docs.get-narrat.com). The code is fully written in TypeScript though and should be clearly separated enough to be approachable.
-
-### Engine architecture
-
-The narrat engine runs primarily as a Vue app. All the UI in the game is made of Vue components, and when a game uses narrat it effectively creates a Vue app.
-
-#### App state
-
-The engine's state is stored in pinia. It is split in separate pinia modules for different areas of the engine. They can all be found in the [src/stores](src/stores) folder.
-
-- `audio`: handles playing and stopping audio and music
-- `dialog`: Receives and stores all lines of dialogue created by game scripts which appear at the right of the game in the main interactive narrative view.
-- `hud`: Stores stats which are displayed on the hud
-- `inventory`: Manages the player's item inventory
-- `main`: Manages app-level logic and other generic systems like startup/reset/load/save
-- `notifications`: Manages notifications which appear at the top of the screen
-- `quests`: Manages quests and objectives
-- `rendering`: Manages the layout's state for dynamically placing and resizing the game UI
-- `skills`: Manages player skills and xp. Also store skill check states
-- `vm`: Manages the virtual machine which runs the scripting language and controls the game flow.
-
-All stores can be accessed anywhere in the code with the `use` hooks (example: `useVM()`).
-
-#### Scripting language (VM and parser)
-
-The scripting language for narrat runs in a virtual machine which has its state stored in the Vue app with Pinia.
-
-The narrat scripting language relies on the parser and the vm. The code for the parser is mainly in [src/vm/vm-parser.ts](src/vm/vm-parser.ts). The parser is in charge of taking the `.nar` files as input, and returning a tree of parsed expressions that the engine can use.
-
-The actual VM is what runs narrat games, and generally controls the flow of the application. The general logic for the vm is in the `vm` store, but there is also some logic sprinkled in the `src/vm` file.
-
-All the actual operations available to the scripting language (like `talk`) are defined as Command plugins. The built-in commands included in the language by default are in the [src/vm/commands](src/vm/commands/) folder. More command can be added by games by registering plugins.
-
-#### Adding new commands
-
-Language commands are defined in the `vm/commands` folder. It should be easy to add new commands to the game engine by looking at the existing commands as an example. New command plugins are included in the `vm/commands/index` file.
-
-#### Config file
-
-The main config file has a type defined in `src/config.ts`. The vast majority of the config options for narrat are passed in this config files, which games must provide to the engine when starting. New options for the engine should be added to the type for the config file, and also have their default value included in the `src/defaultConfig.ts` file.
-
-Engine code can access the config with the `getConfig()` function.
-
-#### Plugin system
-
-There is now a plugin system developers can use to add new functionality to narrat (more documentation soon). See the [narrat-bitsy](https://github.com/liana-pigeot/narrat-bitsy) plugin for an example.
-
-(Note: The narrat-bitsy plugin hasn't been updated for 2.0.0 and might be a bit out of date).
-
-## Assets used in demo games
-
-- [Pointing arrows from OpenGameArt](https://opengameart.org/content/pointing-arrows)
-- [UI button from OpenGameArt](https://opengameart.org/content/buttons-and-frame)
-- [10 Basic RPG enemies](https://opengameart.org/content/10-basic-rpg-enemies)
-- [RPG Battle backgrounds from OpenGameArt](https://opengameart.org/content/backgrounds-3)
-- [3D City from OpenGameArt](https://opengameart.org/content/3d-city)
-
-The rest is handmade.
+# 🚀 Narrat
+
+![example workflow](https://github.com/liana-p/narrat-engine/actions/workflows/main.yml/badge.svg) [![Netlify Status](https://api.netlify.com/api/v1/badges/55d4b9ba-62b7-4c43-86ce-8bc2aaf98643/deploy-status)](https://app.netlify.com/sites/ornate-pie-561978/deploys)
+
+Work on the engine directly in Codeflow:
+
+[![Open in Codeflow](./docs/open-in-codeflow.svg)](https://pr.new/liana-p/narrat-engine)
+
+Or try editing the default narrat game easily:
+
+[![Try editing the default game](./docs/open-in-codeflow.svg)](https:///pr.new/github.com/liana-p/narrat-engine/edit/main/packages/narrat/examples/games/default/scripts/default.nar)
+
+Narrat is a game engine for making interactive narrative RPGs packed with features.. Create your game by editing with a Simple scripting syntax. It supports Skills with skill check rolls, an Items inventory, and has a Quests System. The script system is very powerful and allows branching choices, functions, variables and conditions.
+
+More info on the [narrat website](https://get-narrat.com). There is an [online demo](https://get-narrat.com/demo/) available to try in the browser.
+
+## Getting Started
+
+The best way to get started in a minute is to follow the [Getting Started](https://docs.get-narrat.com/guides/getting-started) documentation page. It shows you to download the ready-to-use game template to get started writing a game with narrat.
+
+## Development (for contributors)
+
+Note: Narrat is a monorepo using `pnpm` as package manager. The `packages` folder contains the individual packages, including the main `narrat` package.
+
+Narrat is written in [TypeScript](https://www.typescriptlang.org/). It uses the [Vue](https://vuejs.org/) framework for front-end development. It also uses [pinia](https://pinia.vuejs.org/) for state management
+
+### Requirements
+
+- [node.js](https://nodejs.org/en/) (Downloading LTS is fine)
+- [pnpm](https://pnpm.io/). This Narrat repo is a monorepo using pnpm workspaces to easily manage the different packages.
+- A text editor capable of editing a TypeScript and Vue.js project. Recommended: [VSCode](https://code.visualstudio.com/) and the extension [Volar](https://marketplace.visualstudio.com/items?itemName=ms-vscode.vscode-volar) for Vue.
+
+### Running the engine for development
+
+1. Install dependencies
+
+`pnpm install`
+
+2. Run the demo
+
+`pnpm dev`
+
+This starts the engine on the demo page with the `example.nar` demo script loaded for testing.
+
+### Developping narrat specifically
+
+If developping on the narrat package, it's better to go inside the narrat package folder and run commands there.
+
+### Multiple demo games
+
+There are multiple demo games and it's possible to add new ones. For example `npm run rpg` will run the `rpg` demo. Demos are in the `examples` folder.
+
+Running a specific demo is done by changing an environment variables. See the scripts in `package.json` for how to run a specific demo.
+
+### Available pnpm commands in narrat
+
+- `start`: Start the demo for development
+- `build`: The main build command, builds the library in a state ready to use or publish.
+- `test`: Unit tests, used in CI
+- `dev`: Same as start
+- `generate-types`: Generates `.d.ts` type declaration files for the library (auto run on builds)
+- `fix-type-aliases`: Uses [tsc-alias](https://www.npmjs.com/package/tsc-alias) to auto-replace [path mappings](https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping) in the built files, as the TypeScript compiler doesn't do it. (auto run at the end of builds)
+- `lint`: Runs the linter on the code (used in CI)
+- `check-types`: Validates TypeScript types.
+
+### CI info
+
+The following tasks run on CI, and CI is required to pass for pull requests to be merged:
+
+- Linting
+- Engine build
+- Unit tests (currently only the parser is unit tested)
+- TypeScript type checking.
+
+Please make sure your code passes lint/tests/build/type checks before opening a PR.
+
+### Working on the code
+
+The narrat codebase isn't currently documented, outside of the [usage docs](https://docs.get-narrat.com). The code is fully written in TypeScript though and should be clearly separated enough to be approachable.
+
+### Engine architecture
+
+The narrat engine runs primarily as a Vue app. All the UI in the game is made of Vue components, and when a game uses narrat it effectively creates a Vue app.
+
+#### App state
+
+The engine's state is stored in pinia. It is split in separate pinia modules for different areas of the engine. They can all be found in the [src/stores](src/stores) folder.
+
+- `audio`: handles playing and stopping audio and music
+- `dialog`: Receives and stores all lines of dialogue created by game scripts which appear at the right of the game in the main interactive narrative view.
+- `hud`: Stores stats which are displayed on the hud
+- `inventory`: Manages the player's item inventory
+- `main`: Manages app-level logic and other generic systems like startup/reset/load/save
+- `notifications`: Manages notifications which appear at the top of the screen
+- `quests`: Manages quests and objectives
+- `rendering`: Manages the layout's state for dynamically placing and resizing the game UI
+- `skills`: Manages player skills and xp. Also store skill check states
+- `vm`: Manages the virtual machine which runs the scripting language and controls the game flow.
+
+All stores can be accessed anywhere in the code with the `use` hooks (example: `useVM()`).
+
+#### Scripting language (VM and parser)
+
+The scripting language for narrat runs in a virtual machine which has its state stored in the Vue app with Pinia.
+
+The narrat scripting language relies on the parser and the vm. The code for the parser is mainly in [src/vm/vm-parser.ts](src/vm/vm-parser.ts). The parser is in charge of taking the `.nar` files as input, and returning a tree of parsed expressions that the engine can use.
+
+The actual VM is what runs narrat games, and generally controls the flow of the application. The general logic for the vm is in the `vm` store, but there is also some logic sprinkled in the `src/vm` file.
+
+All the actual operations available to the scripting language (like `talk`) are defined as Command plugins. The built-in commands included in the language by default are in the [src/vm/commands](src/vm/commands/) folder. More command can be added by games by registering plugins.
+
+#### Adding new commands
+
+Language commands are defined in the `vm/commands` folder. It should be easy to add new commands to the game engine by looking at the existing commands as an example. New command plugins are included in the `vm/commands/index` file.
+
+#### Config file
+
+The main config file has a type defined in `src/config.ts`. The vast majority of the config options for narrat are passed in this config files, which games must provide to the engine when starting. New options for the engine should be added to the type for the config file, and also have their default value included in the `src/defaultConfig.ts` file.
+
+Engine code can access the config with the `getConfig()` function.
+
+#### Plugin system
+
+There is now a plugin system developers can use to add new functionality to narrat (more documentation soon). See the [narrat-bitsy](https://github.com/liana-pigeot/narrat-bitsy) plugin for an example.
+
+(Note: The narrat-bitsy plugin hasn't been updated for 2.0.0 and might be a bit out of date).
+
+## Assets used in demo games
+
+- [Pointing arrows from OpenGameArt](https://opengameart.org/content/pointing-arrows)
+- [UI button from OpenGameArt](https://opengameart.org/content/buttons-and-frame)
+- [10 Basic RPG enemies](https://opengameart.org/content/10-basic-rpg-enemies)
+- [RPG Battle backgrounds from OpenGameArt](https://opengameart.org/content/backgrounds-3)
+- [3D City from OpenGameArt](https://opengameart.org/content/3d-city)
+
+The rest is handmade.

package/dist/components/tabs/TabsController.vue.d.ts

@@ -1,7 +1,7 @@
 import { TabOptions } from './tab-selector.vue';
 export interface TabControllerProps {
     tabs: TabOptions[];
-    defaultTab: string;
+    defaultTab: number;
 }
 declare const _default: {
     new (...args: any[]): {

package/dist/exports/config.d.ts

@@ -1 +1,2 @@
 export { getConfig } from '../config';
+export { audioConfig, skillsConfig, itemsConfig, questsConfig, screensConfig, buttonsConfig, tooltipsConfig, charactersConfig, getSkillConfig, getImageUrl, getAssetUrl, getSplitConfigUrl, getDataUrl, getButtonConfig, getScreenConfig, getItemConfig, getQuestConfig, getObjectiveConfig, } from '../config';

package/dist/exports/inputs.d.ts

@@ -0,0 +1 @@
+export type { ButtonKeybind, AnalogKeybind, ButtonAction, AnalogAction, ButtonActionState, AnalogDirectionState, AnalogActionState, Action, Inputs, } from '../inputs/Inputs';

package/dist/exports/plugins.d.ts

@@ -28,6 +28,7 @@ export interface CustomMenuTab {
     component: any;
 }
 export declare type NarratPluginObject<T> = {
+    pluginId: string;
     onPageLoaded?: NarratLifecycleHook;
     onNarratSetup?: NarratLifecycleHook;
     onAppMounted?: NarratLifecycleHook;
@@ -40,7 +41,26 @@ export declare type NarratPluginObject<T> = {
     customStores?: CustomStores;
     customMenuButtons?: CustomMenuButton[];
     customMenuTabs?: CustomMenuTab[];
+    startMenuButtons?: CustomStartMenuButton[];
+    save?: () => any;
+    load?: (data: any) => void;
+    reset?: () => void;
+    loadingPromises?: Promise<any>[];
 };
+/**
+ * Custom buttons that get added to the start menu (where the New Game etc buttons are)
+ * Action option is to provide a function to run on click
+ * popupComponent option is to provide a component to display in a modal window on click (for custom pieces of UI)
+ */
+export interface CustomStartMenuButton {
+    id: string;
+    text: string;
+    action?: () => void;
+    popupComponent?: {
+        name: string;
+        component: any;
+    };
+}
 declare function registerPlugin<T>(plugin: NarratPluginObject<T>): void;
 declare function addCommand<T>(command: CommandPlugin<T>): void;
 export { CommandRunner };

package/dist/exports/stores.d.ts

@@ -1,11 +1,16 @@
-export { useMain } from '../stores/main-store';
 export { useAudio } from '../stores/audio-store';
+export { useConfig } from '../stores/config-store';
 export { useDialogStore } from '../stores/dialog-store';
 export { useHud } from '../stores/hud-stats-store';
+export { useInputs } from '../stores/inputs-store';
 export { useInventory } from '../stores/inventory-store';
+export { useMain } from '../stores/main-store';
+export { useMenu } from '../stores/menu-store';
 export { useNotifications } from '../stores/notification-store';
 export { useQuests } from '../stores/quest-log';
 export { useRenderingStore } from '../stores/rendering-store';
+export { useScreenObjects } from '../stores/screen-objects-store';
 export { useScreens } from '../stores/screens-store';
 export { useSkills } from '../stores/skills';
+export { useTooltips } from '../stores/tooltip-store';
 export { useVM } from '../stores/vm-store';

package/dist/exports/utils.d.ts

@@ -0,0 +1,12 @@
+export { error, warning } from '../utils/error-handling';
+export { processText, findVariable } from '../utils/string-helpers';
+export { getFile, loadDataFile } from '../utils/ajax';
+export { getWindow } from '../utils/getWindow';
+export { InputsListener, inputEvents } from '../utils/InputsListener';
+export type { InputEvents } from '../utils/InputsListener';
+export { LogManager, logManager, logger } from '../utils/logger';
+export { timeout } from '../utils/promises';
+export { randomId } from '../utils/randomId';
+export { Vec2 } from '../utils/Vector2';
+export type { Vector2 } from '../utils/Vector2';
+export { gameloop } from '../utils/gameloop';

package/dist/favicon.svg

@@ -1,30 +1,30 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Rat" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 595.3 595.3" style="enable-background:new 0 0 595.3 595.3;" xml:space="preserve">
-<style type="text/css">
-	.st0{fill:#E23B33;}
-</style>
-<path id="Rat_Shape" class="st0" d="M556.9,82.5c-10.8-24.3-47-57.1-71.3-65.6c-24.3-8.4-64.1-0.3-88.7,22.3
-	c-20,18.4-26,28.2-29.1,37c-2.1,5.9-4.8,13.5-6,20.9v0c-0.5,4.1-4.5,7-8.6,6.1c-10.4-2.3-29.5-6-44.4-6.3
-	c-13.7-0.2-30.1,3.2-40.4,5.7c-4.5,1.1-8.8-2.2-8.8-6.8c-0.1-5.3-1.1-12.3-4.8-19.6c-8.5-16.9-19.6-32.6-57.8-47.4
-	c-31.9-12.4-75.1-9.7-100.8,1.8c-28.1,12.6-42.4,37.9-54,61.8c-14.4,29.8-14.9,83.6-6.4,104c12.8,30.7,35.8,47.2,52.6,53
-	c11.3,3.8,28.2,3.7,38.2,3.3c4.2-0.2,7.7,3.3,7.5,7.5c-0.7,13.6-0.9,41.5,7,61.4c7.7,19.4,29.7,62.3,50.7,101.2
-	c0,0.1-14.6,2.9-31.4,6.8c-23.9,5.5-52.6,12.7-54.3,13.7c-3.5,2.1-3,10-2.7,12c0.5,3.4,5.3,8.1,6.9,8.3c3.9,0.3,31.3-7.6,55.7-14.6
-	c18.5-5.3,34.9-9.3,35.5-8.2c5.1,9.3,10,18,14.4,25.8c5.2,9.1,10.7,16.4,14.1,23.6c1.1,2.3-16.6,5.8-32.5,14.7
-	c-16.4,9.1-29.7,21-32.3,24c-1.8,2.1-3,6-1.2,10.7c1.1,2.9,10,5.7,12.4,5.1c6.8-1.7,16.5-12.5,33.1-21.1
-	c16.3-8.5,32.9-14.9,33.8-13.6c9.7,14.3,16.9,21.6,22.6,31.2c9.8,16.5,27.3,45.9,46.6,39.5c6.4-2.1,31.1-33.6,53.3-68.6
-	c1.3-2.1,16.1,11.3,30.4,23.2c13.8,11.4,22.7,20.6,27.1,21.4c5.4,1,14.2-7.7,14.1-14.7c-0.1-2.7-14.3-13.8-29.1-26.2
-	c-14.5-12.1-30.1-22.8-29.2-24.3c7.6-12,14.5-23.7,20.1-33.9c4.3-7.8,8.9-16,13-24.7c0.6-1.2,15.9,3,31.4,7.1c15.3,4,26.7,10,31,8
-	c6.9-3,11.6-13.8,9.4-18.3c-1.1-2.3-17-7.3-33.2-12c-14.2-4.1-28-6.5-27.7-7.3c15.5-34,28.8-64.8,27.6-69.6
-	c-1.7-7.1,2.6-11.9,7-36.5c3.2-18.1,4.7-40.9,5.2-51.7c0.2-3.5,2.8-6.3,6.3-6.7c3.1-0.3,6.9-0.9,10.5-1.9c7.8-2,18.6-7.8,36.4-20.6
-	c17.9-12.8,38.7-49.6,44.4-67.8S567.6,106.8,556.9,82.5z M265.1,336.2c-8.1,4-13,7-26.4,9.6c-6.9,1.4-29.4-0.2-40.7-4.6
-	c-10.5-4.1-19.9-7.6-30-15.4s-15.7-13.2-15.7-15.3c0-4.4,6-9.4,11-9.4c5.1,0,14.5,9.2,29.7,16.6c14.3,7,17.9,6.1,25.4,7.3
-	c2.9,0.5,7.7,0.6,10.7,0.4c14.1-1.3,21.4-5.9,25.3-8.8c4-3,13.7-12.9,17.2-12.5c8,1,18.9,3.4,18.9,7.1
-	C290.4,319,273.2,332.1,265.1,336.2z M320.9,521.4c-4.3,3.7-17.7,13.5-23.3,13.5c-2.8,0-7.4-8.2-11.5-16.8
-	c-4.1-8.5-9.1-21.1-9.1-31.6c0-4.6,6-7.4,13.4-9.2c7.2-1.7,27.3-1.8,29.9-1.1c6.8,1.7,12.9,2.2,12.7,6.4c-0.4,12.7-7,18.9-8.3,24.3
-	C323.4,512.3,323.4,519.2,320.9,521.4z M431.1,320.3c-9.2,7.4-10.6,8.1-24.9,13.7c-11.3,4.4-28.6,5.8-41.6,3.6
-	c-12.2-2.1-22.3-4.6-29.5-10.1c-9.7-7.3-16.4-15.1-16.4-19.8c0-3.7,6.4-4.3,14.5-4.9c3.5-0.3,9.3,5.9,13.2,9.2
-	c8.1,6.8,14.8,8,28.8,9.9c2.9,0.4,7.8,0.4,10.7,0.1c7.5-0.9,12-0.4,25.8-8.2c20-11.2,17.8-14.4,25.1-12.6c2.2,0.6,5.8,1.2,5.6,5.6
-	C442.4,309,440.5,312.7,431.1,320.3z"/>
-</svg>
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
+<svg version="1.1" id="Rat" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
+	 viewBox="0 0 595.3 595.3" style="enable-background:new 0 0 595.3 595.3;" xml:space="preserve">
+<style type="text/css">
+	.st0{fill:#E23B33;}
+</style>
+<path id="Rat_Shape" class="st0" d="M556.9,82.5c-10.8-24.3-47-57.1-71.3-65.6c-24.3-8.4-64.1-0.3-88.7,22.3
+	c-20,18.4-26,28.2-29.1,37c-2.1,5.9-4.8,13.5-6,20.9v0c-0.5,4.1-4.5,7-8.6,6.1c-10.4-2.3-29.5-6-44.4-6.3
+	c-13.7-0.2-30.1,3.2-40.4,5.7c-4.5,1.1-8.8-2.2-8.8-6.8c-0.1-5.3-1.1-12.3-4.8-19.6c-8.5-16.9-19.6-32.6-57.8-47.4
+	c-31.9-12.4-75.1-9.7-100.8,1.8c-28.1,12.6-42.4,37.9-54,61.8c-14.4,29.8-14.9,83.6-6.4,104c12.8,30.7,35.8,47.2,52.6,53
+	c11.3,3.8,28.2,3.7,38.2,3.3c4.2-0.2,7.7,3.3,7.5,7.5c-0.7,13.6-0.9,41.5,7,61.4c7.7,19.4,29.7,62.3,50.7,101.2
+	c0,0.1-14.6,2.9-31.4,6.8c-23.9,5.5-52.6,12.7-54.3,13.7c-3.5,2.1-3,10-2.7,12c0.5,3.4,5.3,8.1,6.9,8.3c3.9,0.3,31.3-7.6,55.7-14.6
+	c18.5-5.3,34.9-9.3,35.5-8.2c5.1,9.3,10,18,14.4,25.8c5.2,9.1,10.7,16.4,14.1,23.6c1.1,2.3-16.6,5.8-32.5,14.7
+	c-16.4,9.1-29.7,21-32.3,24c-1.8,2.1-3,6-1.2,10.7c1.1,2.9,10,5.7,12.4,5.1c6.8-1.7,16.5-12.5,33.1-21.1
+	c16.3-8.5,32.9-14.9,33.8-13.6c9.7,14.3,16.9,21.6,22.6,31.2c9.8,16.5,27.3,45.9,46.6,39.5c6.4-2.1,31.1-33.6,53.3-68.6
+	c1.3-2.1,16.1,11.3,30.4,23.2c13.8,11.4,22.7,20.6,27.1,21.4c5.4,1,14.2-7.7,14.1-14.7c-0.1-2.7-14.3-13.8-29.1-26.2
+	c-14.5-12.1-30.1-22.8-29.2-24.3c7.6-12,14.5-23.7,20.1-33.9c4.3-7.8,8.9-16,13-24.7c0.6-1.2,15.9,3,31.4,7.1c15.3,4,26.7,10,31,8
+	c6.9-3,11.6-13.8,9.4-18.3c-1.1-2.3-17-7.3-33.2-12c-14.2-4.1-28-6.5-27.7-7.3c15.5-34,28.8-64.8,27.6-69.6
+	c-1.7-7.1,2.6-11.9,7-36.5c3.2-18.1,4.7-40.9,5.2-51.7c0.2-3.5,2.8-6.3,6.3-6.7c3.1-0.3,6.9-0.9,10.5-1.9c7.8-2,18.6-7.8,36.4-20.6
+	c17.9-12.8,38.7-49.6,44.4-67.8S567.6,106.8,556.9,82.5z M265.1,336.2c-8.1,4-13,7-26.4,9.6c-6.9,1.4-29.4-0.2-40.7-4.6
+	c-10.5-4.1-19.9-7.6-30-15.4s-15.7-13.2-15.7-15.3c0-4.4,6-9.4,11-9.4c5.1,0,14.5,9.2,29.7,16.6c14.3,7,17.9,6.1,25.4,7.3
+	c2.9,0.5,7.7,0.6,10.7,0.4c14.1-1.3,21.4-5.9,25.3-8.8c4-3,13.7-12.9,17.2-12.5c8,1,18.9,3.4,18.9,7.1
+	C290.4,319,273.2,332.1,265.1,336.2z M320.9,521.4c-4.3,3.7-17.7,13.5-23.3,13.5c-2.8,0-7.4-8.2-11.5-16.8
+	c-4.1-8.5-9.1-21.1-9.1-31.6c0-4.6,6-7.4,13.4-9.2c7.2-1.7,27.3-1.8,29.9-1.1c6.8,1.7,12.9,2.2,12.7,6.4c-0.4,12.7-7,18.9-8.3,24.3
+	C323.4,512.3,323.4,519.2,320.9,521.4z M431.1,320.3c-9.2,7.4-10.6,8.1-24.9,13.7c-11.3,4.4-28.6,5.8-41.6,3.6
+	c-12.2-2.1-22.3-4.6-29.5-10.1c-9.7-7.3-16.4-15.1-16.4-19.8c0-3.7,6.4-4.3,14.5-4.9c3.5-0.3,9.3,5.9,13.2,9.2
+	c8.1,6.8,14.8,8,28.8,9.9c2.9,0.4,7.8,0.4,10.7,0.1c7.5-0.9,12-0.4,25.8-8.2c20-11.2,17.8-14.4,25.1-12.6c2.2,0.6,5.8,1.2,5.6,5.6
+	C442.4,309,440.5,312.7,431.1,320.3z"/>
+</svg>

package/dist/inputs/Inputs.d.ts

@@ -0,0 +1,61 @@
+import { Vector2 } from '../utils/Vector2';
+export interface ButtonKeybind {
+    keyboardKey: string;
+}
+export interface AnalogKeybind {
+    left: string;
+    right: string;
+    up: string;
+    down: string;
+}
+export interface ButtonAction {
+    id: string;
+    type: 'button';
+    action: 'press' | 'release';
+    keybinds: ButtonKeybind[];
+}
+export interface AnalogAction {
+    id: string;
+    type: 'analog';
+    keybinds: AnalogKeybind[];
+}
+export interface ButtonActionState {
+    active: boolean;
+    previous: boolean;
+}
+export interface AnalogDirectionState {
+    left: number;
+    right: number;
+    up: number;
+    down: number;
+}
+export interface AnalogActionState {
+    value: Vector2;
+    previous: Vector2;
+    fullState: AnalogDirectionState;
+    previousFullState: AnalogDirectionState;
+}
+export declare type Action = ButtonAction | AnalogAction;
+export declare class Inputs {
+    gameActions: {
+        [key: string]: Action;
+    };
+    keyboardState: {
+        [key: string]: {
+            current: boolean;
+            previous: boolean;
+        };
+    };
+    actions: {
+        [key: string]: ButtonActionState | AnalogActionState;
+    };
+    startListening(): void;
+    addAction(action: Action): void;
+    getAnalog(actionId: string): AnalogActionState;
+    getButton(actionId: string): ButtonActionState;
+    getKeyState(key: string): {
+        current: boolean;
+        previous: boolean;
+    };
+    update(): void;
+}

package/dist/lib.d.ts

@@ -13,6 +13,8 @@ export * from './exports/plugins';
 export * from './exports/display';
 export * from './exports/config';
 export * from './exports/events';
+export * from './exports/inputs';
 export * from './exports/stores';
 export * from './exports/others';
 export * from './exports/components';
+export * from './exports/utils';