Engine.ini (Config pack)

From Moondust Wiki
Jump to navigation Jump to search

engine.ini - Provides the main settings of game engine.


General

Window

Window settings

[window]
Parameter Allowed values Example value Description
title string title = "The Super Game of a Funny Face" The game title show in the title bar of the Engine.

Common

Common settings

[common]
Parameter Allowed values Example value Description
viewport-width [>=0] viewport-width = 800 Default width for in-game viewport.
viewport-height [>=0] viewport-height = 600 Default height for in-game viewport.
viewport-type enumeration viewport-type = "static" Specifies the type for viewport: static/scalable - the fixed size of viewport which will be scaled together with a window. dynamic/resizable - the viewport will change the size together with a window, but the in-game content will not be scaled.
Notice Note: Currently, Moondust Engine implements the static type only yet.
cursor-image-normal string cursor-image-normal = "hand.png" The picture filename for the selecting cursor.
cursor-image-rubber string cursor-image-rubber = "hand.png" The picture filename for the erasing rubber cursor.

Appearence

Message box

Message box appearence settings

[message-box]
Parameter Allowed values Example value Description
image string image = "message-box-overlay.png" The overlay texture used to draw the message box background.
box-padding >=0 box-padding = 20 The padding offset between box edges and printed text.
box-padding
border-width >=0 border-width = 32 The distance between edge and center sides of box overlay texture pieces.
border-width
font string font = "font2" The font name used for the text.
font-color color font-color = "#FF0334" The RGB or RGBA font color.

Format: #RRGGBB
- RR - Red color level between 0x00 and 0xFF
- GG - Green color level between 0x00 and 0xFF

- BB - Blue color level between 0x00 and 0xFF


Menu box

Menu box appearence settings. Menu-box is an extension over message box.

[menu-box]
Parameter Allowed values Example value Description
image string image = "message-box-overlay.png" The overlay texture used to draw the message box background. If not defined, the message box's overlay will be used.
box-padding >=0 box-padding = 20 The padding offset between box edges and printed text.
border-width >=0 border-width = 32 The distance between edge and center sides of box overlay texture pieces.
title-font string title-font = "font2" The font name used for the title text.
title-font-color color title-font-color = "#FF0334" The RGB or RGBA font color.

Format: #RRGGBB
- RR - Red color level between 0x00 and 0xFF
- GG - Green color level between 0x00 and 0xFF

- BB - Blue color level between 0x00 and 0xFF


Menus general

Generic menu settings

[menu]
Parameter Allowed values Example value Description
selector string selector = "menu-selector.png" The selector cursor image file name, taken from the common GFX resources.
scroll-up string scroll-up = "menu-scroll-up.png" The scroll-up arrow image file name, taken from the common GFX resources.
scroll-down string scroll-down = "menu-scroll-down.png" The scroll-down arrow image file name, taken from the common GFX resources.
item-height >=0 item-height = 32 The height of menu item.
font-offset >=0 font-offset = 10 The vertical font offset at the top of menu item selection zone.
font string font = "font1" The font name used for the menu items.


Fonts

Font settings

[fonts]
Parameter Allowed values Example value Description
ttf-font-default string ttf-font-default = "super-font.ttf" A default TTF font file name.
ttf-double-pixel boolean ttf-double-pixel = false Automatically pixelize the font characters.
ttf-fonts-count >=0 ttf-fonts-count = 3 The count of additional TTF font files to load.
ttf-font-0 >=0 ttf-font-0 = "super-font.ttf" The name of additional TTF font file, number 0.
ttf-font-1 >=0 ttf-font-1 = "mega-font.ttf" The name of additional TTF font file, number 1.
... ... ... = ...
ttf-font-n >=0 ttf-font-n = "ultra-font.ttf" The name of additional TTF font file, number N.

Scenes

Loading sreen

Loading scene settings

[loading-scene]
Parameter Allowed values Example value Description
background string background = "loading-bg.png" The background overlay image filename for the loading scene.
bg-color color bg-color = "#FF0334" The RGB or RGBA background color.
script string script = "main_loading.lua" The main script for the loading screen processing.
updating-time >=1 updating-time = 128 The default interval between animation frames in milliseconds for all animations with undefined frame delay.
additional-images >=0 additional-images = 1 The number of additional static pictures or animations shown on the loading scene. See the "loading-image-*" section.

loading-image-*

The one of entries for additional static images or animations show on the loading screen. Where * - the number of each entry starting from 1 to N.

[loading-image-*]
Parameter Allowed values Example value Description
image string image = "coin.png" The image filename for the loading screen additional static image.
animated boolean animated = true Is this a static image or an animation?
frames >=1 frames = 2 The count of animation frames presented on the sprite.
frames-delay >=1 frames-delay = 128 The interval between animation frames in milliseconds.
pos-x >=0 pos-x = 42 The horizontal position of the image object on the screen.
pos-y >=0 pos-y = 42 The vertical position of the image object on the screen.


Main menu sreen

Title scene scene settings

[title-screen]
Parameter Allowed values Example value Description
background string background = "loading-bg.png" The background overlay image filename for the title scene.
bg-color color bg-color = "#FF0334" The RGB or RGBA background color.
script string script = "main_credits.lua" The main script for the title screen processing.
updating-time >=1 updating-time = 128 The default interval between animation frames in milliseconds for all animations with undefined frame delay.
additional-images >=0 additional-images = 1 The number of additional static pictures or animations shown on the title scene. See the "title-image-*" section.

title-image-*

The one of entries for additional static images or animations show on the title screen. Where * - the number of each entry starting from 1 to N.

[title-image-*]
Parameter Allowed values Example value Description
image string image = "coin.png" The image filename for the title screen additional static image.
animated boolean animated = true Is this a static image or an animation?
frames >=1 frames = 2 The count of animation frames presented on the sprite.
frames-delay >=1 frames-delay = 128 The interval between animation frames in milliseconds.
pos-x >=0 pos-x = 42 The horizontal position of the image object on the screen.
pos-y >=0 pos-y = 42 The vertical position of the image object on the screen.


World map

World map layout


World map scene settings

[world-map]
Parameter Allowed values Example value Description
background string background = "world-bg.png" The background overlay image filename for the world map scene.
script string script = "main_world.lua" The world map main script.
additional-images >=0 additional-images = 1 The number of additional static pictures or animations shown on the world map scene. See the "world-image-*" section.

Scene viewport
viewport-x >=0 viewport-x = 66 The horizontal position of a world map viewport.
viewport-y >=0 viewport-y = 130 The vertical position of a world map viewport.
viewport-width >=0 viewport-width = 668 The width of the world map viewport.
viewport-height >=0 viewport-height = 404 The height of the world map viewport.

Level title
level-title-x >=0 level-title-x = 244 The level title label horizontal position.
level-title-y >=0 level-title-y = 110 The level title label vertical position.
level-title-w >=0 level-title-w = 700 The level title text box max width.
level-title-font string level-title-font = "font2" The font name used for the level title text.
level-title-font-color color level-title-font-color = "#FF0334" The RGB or RGBA font color.
level-title-align enumeration level-title-align = "left" The default level title alignment inside of the text box size. ("left", "center", or "right").

Points counter
points-counter boolean points-counter = false Enable displaying of the points counter.
points-counter-x >=0 points-counter-x = 244 The points counter label horizontal position.
points-counter-y >=0 points-counter-y = 110 The points counter title label vertical position.
points-counter-font string points-counter-font = "font2" The font name used for the points counter text.
points-counter-font-color color points-counter-font-color = "#FF0334" The RGB or RGBA font color.

Health counter
health-counter boolean health-counter = false Enable displaying of the health counter.
health-counter-x >=0 health-counter-x = 244 The health counter label horizontal position.
health-counter-y >=0 health-counter-y = 110 The health counter title label vertical position.
health-counter-font string health-counter-font = "font2" The font name used for the health counter text.
health-counter-font-color color health-counter-font-color = "#FF0334" The RGB or RGBA font color.

Lives counter
lives-counter boolean lives-counter = false Enable displaying of the lives counter.
lives-counter-x >=0 lives-counter-x = 244 The lives counter label horizontal position.
lives-counter-y >=0 lives-counter-y = 110 The lives counter title label vertical position.
lives-counter-font string lives-counter-font = "font2" The font name used for the lives counter text.
lives-counter-font-color color lives-counter-font-color = "#FF0334" The RGB or RGBA font color.

Star counter
star-counter boolean star-counter = false Enable displaying of the star counter.
star-counter-x >=0 star-counter-x = 244 The star counter label horizontal position.
star-counter-y >=0 star-counter-y = 110 The star counter title label vertical position.
star-counter-font string star-counter-font = "font2" The font name used for the star counter text.
star-counter-font-color color star-counter-font-color = "#FF0334" The RGB or RGBA font color.

Coin counter
coin-counter boolean coin-counter = false Enable displaying of the coin counter.
coin-counter-x >=0 coin-counter-x = 244 The coin counter label horizontal position.
coin-counter-y >=0 coin-counter-y = 110 The coin counter title label vertical position.
coin-counter-font string coin-counter-font = "font2" The font name used for the coin counter text.
coin-counter-font-color color coin-counter-font-color = "#FF0334" The RGB or RGBA font color.

Portrait of playable character
portrait boolean portrait = false Enable displaying of the playable character portrait.
portrait-x >=0 portrait-x = 244 The coin counter label horizontal position.
portrait-y >=0 portrait-y = 110 The coin counter title label vertical position.
portrait-animation string portrait-animation = "Run" The name of player animation to play.
portrait-frame-delay >=1 portrait-frame-delay = 64 The delay between animation frames in milliseconds.
portrait-direction -1 or 1 portrait-direction = -1 The face direction of playable character: -1 left, 1 right.


world-image-*

The one of entries for additional static images or animations show on the world map screen. Where * - the number of each entry starting from 1 to N.

[world-image-*]
Parameter Allowed values Example value Description
image string image = "coin.png" The image filename for the world map additional static image.
animated boolean animated = true Is this a static image or an animation?
frames >=1 frames = 2 The count of animation frames presented on the sprite.
frames-delay >=1 frames-delay = 128 The interval between animation frames in milliseconds.
pos-x >=0 pos-x = 42 The horizontal position of the image object on the screen.
pos-y >=0 pos-y = 42 The vertical position of the image object on the screen.

Level playing

Level scene settings

[level]
Parameter Allowed values Example value Description
script string script = "main_level.lua" The main script for the level processing.

Credits screen

Credits scene settings

[credits-scene]
Parameter Allowed values Example value Description
background string background = "loading-bg.png" The background overlay image filename for the credits scene.
bg-color color bg-color = "#FF0334" The RGB or RGBA background color.
script string script = "main_credits.lua" The main script for the credits screen processing.
updating-time >=1 updating-time = 128 The default interval between animation frames in milliseconds for all animations with undefined frame delay.
additional-images >=0 additional-images = 1 The number of additional static pictures or animations shown on the credits scene. See the "credits-image-*" section.

credits-image-*

The one of entries for additional static images or animations show on the credits screen. Where * - the number of each entry starting from 1 to N.

[credits-image-*]
Parameter Allowed values Example value Description
image string image = "coin.png" The image filename for the credits screen additional static image.
animated boolean animated = true Is this a static image or an animation?
frames >=1 frames = 2 The count of animation frames presented on the sprite.
frames-delay >=1 frames-delay = 128 The interval between animation frames in milliseconds.
pos-x >=0 pos-x = 42 The horizontal position of the image object on the screen.
pos-y >=0 pos-y = 42 The vertical position of the image object on the screen.