User Configuration for the messenger.

userdata is a custom type which can store any data in the game. users can save their own global data and implement local storage here.

scenemsg is another custom type which represents the message type users wants to send to a scene when switching scenes.

• initScene represents the scene users get start
• initSceneMsg represents the message to initialize the start scene
• globalDataCodec is for local storage, users can encode the any data in global data and user data to storage them, and decode them when reopen the game. This globalData is a subset of the real global data, removing all internal data structures
• virtualSize represents how users want their game be virtual sized. In other words, users make their game in the virtual size, and the game will be resized due to the browser window size but keeping the aspect ratio
• debug option determines whether enable some simple debugging tools or not remember to disable it when releasing game
• background determines the background of the game transparent background and colored background is already prepared
• allTexture stores all the texture assets users will use in the game. the path is based on the project folder. format: (name, path)
• allSpriteSheets stores all the sprite sheets users set for this game. users should both name the sprite sheets and every single sprite. Using it by format: "sheet_name.sprite_name" Sprite sheets are useful when managing the art recourses or making frame-by-frame animations
• timeInterval determines the highest fps of the game, representing the interval between every two frames. More strictly speaking, it represents the interval between every two Tick events
• ports stores the ports that users must provide.

The ports that the user must provide to the messenger.

Learn more about ports here

A colored background.

A transparent background. You should use this for release.