Project

Projects are folder based, simply create one and define your .milk files to get started.

The entry point for your story should be a file name main.milk. If this is not defined, the compiler will pick the first .milk file in the root directory.

/project.json

This file servers a project config file, it allows you to configure how the Milk Editor connects to the server.

/* 
/project.json
*/
{
    "local": true,
    "server": "alpha.astic.co.uk"
}   

Props

• local: true|false Default: false Enables or disables local development. When local development is active, the editor spawns a local game server. All actions done locally will not reflect on the web

• server (optional): url or url:port. This specifies the server url to use for sync and deployments. When local development is active, this property is ignored.

• ui (optional): This provides the frontend port to connect to. This property is mostly used during the development of the editor. It can be safely omitted

Characters

To define a character, create a folder with the character name and add a .json file with their information

/* 
/characters/flora
*/
{
    "kind": "character",
    "name": "flora"
}

Locations

Similarly to characters, create a folder and define your desired location

/* 
/locations/bathroom
*/
{
    "kind": "location",
    "name": "bathroom",
    "musicTheme": "home_theme",
    "title": "Bathroom"
}

/inventory

This folder should contain all inventory assets images. Each file will be defined and accessible as an Accessor in the engine

You can define a state file to rename an asset or group multiple assets into one inventory item

ball_of_yarn:
  blue = ball_of_yarn_blue
  gray = ball_of_yarn_gray
  pink = ball_of_yarn_pink
  red = ball_of_yarn_red
  yellow = ball_of_yarn_yellow