Main.ini (Configuration package)
Revision as of 23:20, 7 July 2017 by Wohlstand (talk | contribs) (Created page with "Category:Configuration_Package '''General settings'''. Declares the general settings of configuration package and identifies it. Is a basic settings of this configuration...")
General settings. Declares the general settings of configuration package and identifies it.
Is a basic settings of this configuration pack
| [ main ] | |||
|---|---|---|---|
| Parameter | Allowed values | Example value | Description |
| config_name | string | config_name = "Raocow Talkhaus" | The full name of configuration pack |
| config_desc | string | config_desc = "Config pack with stuff made by Raocow's Talkhaus team" | Additional description about this configuration package |
| worlds | string | worlds = "Raocow Games" | Name of folder with episodes. If not defined, will be used common 'worlds' folder which independent to configuration pack where you have able to play episodes with any config packs. To take able have config specific episodes, the custom world folder must be defined. |
| music | string | music = "music" | Name or relative path to configuration pack default music folder. By default this folder locates in the 'data' folder. |
| sound | string | sound = "sound" | Name or relative path to configuration pack default sounds folder. By default this folder locates in the 'data' folder. |
| application-dir | [0,1] | application-dir = 0 | Use application root instead of data sub folder as basic path to data environment. |
| application-path | string | application-path = "/usr/local/games/pge_default/" | Definition of absolute path to data directory. Will work if 'application-dir' will is 1 |
| graphics-level | string | graphics-level = "graphics/level" | Path to folder of level graphics folder. |
| graphics-worldmap | string | graphics-worldmap = "graphics/worldmap" | Path to folder of world map graphics folder. |
| graphics-characters | string | graphics-characters = "graphics/characters" | Path to folder of playable character graphics folder |
| graphics-common | string | graphics-common = "graphics/common" | Path to folder of common engine graphics |
| custom-data | string | custom-data = "data-custom" | Additional environment folder for custom data[reserved] |
| smbx-compatible | [0,1] | smbx-compatible = 1 | [reserved flag] This option will disable the use of non-SMBX features for games created with this config.
This will allow saved level files, etc. to be compatible with SMBX 1.3 If you set this option to 0, you can read SMBX files, but you will lose data if you try to save in SMBX format, and you will get rendering bugs if you try to open the file in SMBX |
Some settings of the editing process and graphics setup
| [ graphics ] | |||
|---|---|---|---|
| Parameter | Allowed values | Example value | Description |
| default-grid | >=0 | default-grid = 32 | Default global alignment grid size. You can define any grid size for your game. |
List of available playable characters in game
| [ characters ] | |||
|---|---|---|---|
| Parameter | Allowed values | Example value | Description |
| characters | >0 | characters = 5 | Total number of available playable characters |
| character*-name | string | character*-name = "Raocow" | Name of character selected number (instead of * write the character ID [1...total characters]). You should define all allocated character names! |
Global editor GUI settings
| [ gui ] | |||
|---|---|---|---|
| Parameter | Allowed values | Example value | Description |
| editor-icon | string | editor-icon = "icon_small.png" | Icon of the configuration package which will be shown in the config selection dialog in the Editor. |
| engine-icon | string | engine-icon = "icon_small.png" | Icon of the configuration package which will be shown in the config selection screen in the Engine. |
| editor-splash | string | editor-splash = "graphics/common/editor_splash.png" | Default editor splash of this configuration package |
| default-theme | string | default-theme = "Raocow Style" | Folder name of theme which will be used as default |
| animations | >=0 | animations = 3 | Number of additional animated images which will be drawn over splash logo |
Define of one of splash animation with number from 1 to total number of animations
| [ splash-animation-* ] | |||
|---|---|---|---|
| Parameter | Allowed values | Example value | Description |
| image | string | image = "graphics/common/coin.png" | Path to image which will be shown on the splash logo |
| frames | >=1 | frames = 4 | Number of animation frames. If not defined or 1 - image will be shown as static image |
| speed | >=1 | speed = 78 | Delay between frames (in ms). Default 128 ms. |
| x | >=0 | x = 416 | Horizontal position of image relative to left-top corner of splash |
| y | >=0 | y = 242 | Vertical position of image relative to left-top corner of splash |