Path to the aspeprite executeable used for sprite sheet generation
Local paths that may contain assets and game code e.g.:
All files in there are considered to be part of the game (including subdirectories).
Files and folders start with
_ or end with
_ will be ignored.
Simply put the directories (no
WIP, not sure yet
Per default TypeSprite exports the game in an: iife.
So it can be used like this:
<!-- The game is running now -->
If you like/need to load it in a more modern fashion and get more control when the engine starts and you also like to have access to the running instance one can set this value to true.
import runGame from 'path/to/game.js';
const gameInstance = runGame();
depends on canvas Type
"create" => a new canvas is created and attached to the canvas selector object "selector" => it is expected that the canvas selector points to a canvas
Only valid if
[OPTIONAL] Define any flags that helps to run your game.
Suggestions: "ios", "nativ", "desktop", or "demo" :-)
It's possible to have different mainloop behavior and controlls how update() is called.
when > 0 it will cap the FPS to the given value if the window has lost the fosus. This is useful during development when your laptop starts to scream at you while working on a game.
when > 0 it will cap the FPS to the given value.
Means the mainloop won't start automatically. This has to be done by hand.
Means built-in property-parser won't be set automatically. You can add them by yourself
Means built-in resourceloader won't be set automatically.
Should be analoge to tsconfig.path.
Simply put the directories (no '*').
A global path-prefix used for all resources loaded using the ResourceManager.
You have two options to run a TypeSprite game:
RunConfigand start an
RunConfig is just this:
It'll search for a
myworld.edf in the given
allows quick and full feature access to the TypeSprite.
If the reasonable defaults are not suitable it's possible to write a custom main file and initialize the engine by hand.
Port for the dev-server
Name or list of names the start world.
For a very simple case one can simply set a string.
However, for certain patterns it's useful to start more than one world and in a controlled order.
Example 1: start two worlds at the same time
startWorlds: ["world1", "world2"]
Example 2: start 3 worlds in a controlled order
startWorlds: [["world1"], ["world2", "world3"]]
when world1 is active, world2 and world3 get activated.
Generated using TypeDoc