Game Configuration Pack References
Game Configuration pack - is a main platform of all games which working with PGE. Configuration pack including an items definitions, game-play settings, game content, and more other.
Structure
Any configuration pack uses this tree structure:
Note: italic folders can be customized by main.ini config
/<Name of config pack>
- /data - content data container
- /graphics - graphics resources
- /characters - playable characters sprites
- /common - common engine graphics (for example, logos, titles, design elements, etc.)
- /level - graphics which uses in levels
- /worldmap - graphics which uses in world maps
- /music - music container
- /sound - music container
- /graphics - graphics resources
- /tilesets
- /group_tilesets
- main.ini - main configuration pack description and settings
- music.ini - configuration and list of musics
- sounds.ini - configuration and list of sounds
- lvl_bgo.ini - definition of background objects for levels
- lvl_bkgrd.ini - definition of backgrounds for levels
- lvl_blocks.ini - definition of blocks for levels
- lvl_effects.ini - definition of effects for levels
- lvl_npc.ini - definition of non-playable characters for levels
- wld_tiles.ini - definition of tiles for world map
- wld_scenery.ini - definition of sceneries for levels
- wld_paths.ini - definition of paths for levels
- wld_levels.ini - definition of level points for levels
Configuration files
main.ini
Is a main settings of configuration pack
[main] Is a basic settings of this configuration pack
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| config_name | string | config_name="Raocow Talkhaus" | The full name of configuration pack |
| worlds | string | worlds="Raocow Games" | Game worlds folder where engine will look for episodes |
| music | string | music = "music" | Folder with music files (in the data subdirectory) |
| sound | string | sound = "sound" | Sound folder |
| application-dir | [0,1] | application-dir=0 | If this flag was set to 1, data will be locked relative to application dir instead "data" subdirectory. |
| graphics-level | string | graphics-level="graphics/level" | Level graphics folder |
| graphics-worldmap | string | graphics-worldmap="graphics/worldmap" | Worldmap graphics folder |
| graphics-characters | string | graphics-characters="graphics/characters" | Playable character graphics folder |
| custom-data | string | custom-data="data-custom" | Custom data path [reserved] |
| smbx-compatible | [0,1] | smbx-compatible=1 | This option will disable using of non-SMBX features for created games with this config.
Saved files compatible with SMBX 1.3 If you set this option to 0, you can read SMBX files, but you will lose data on try to save in SMBX format and will get bugs in render, if you will try saved file in SMBX |
[graphics]
Some settings of editing process and graphics setup
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| default-grid | [>=0] | default-grid=32 | You can define any grid size for your game |
[characters]
List of available playable characters in game
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| characters | [>=0] | characters=5 | Total number of available playable characters |
| character*-name | string | character4-name = "Raocow" | Name of character selected number (instead of * write the character ID [1...total characters]) |
[gui]
Global editor GUI settings
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| editor-splash | string | editor-splash="graphics/common/editor_splash.png" | Default splash of this configuration package |
| default-theme | string | default-theme="Raocow Style" | Folder name of theme which will be used as default |
music.ini
Defining list of available music
[music-main]
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| total-world | [>=1] | total-world=16 | Total number of world map music |
| total-level | [>=1] | total-level=56 | Total number of level music |
| total-special | [>=1] | total-special=3 | Total of special musics which using for special events and is not available to playback by standard methods |
| level-custom-music-id | [>=0] | level-custom-music-id=24 | ID which will used as "custom music". |
[world-music-*]
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| name | string | name="Jazz for everything" | Title of music |
| file | string | file="jazz-for-everything.ogg" | Music file which connected to this ID slot |
[level-music-*]
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| name | string | name="Rock'n'roll!" | Title of music |
| file | string | file="rock-n-roll.ogg" | Music file which connected to this ID slot |
[special-music-*]
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| name | string | name="tick-tack, go-go!" | Title of music |
| file | string | file="tick-tack.ogg" | Music file which connected to this ID slot |
sounds.ini
Definition of available sound effects
[sound-main]
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| total | [>=1] | total=91 | Total number of available sound effects |
[sound-1]
| Parameter | Variants | Example value | Description |
|---|---|---|---|
| name | string | name="Jump" | Title of sound effect |
| file | string | file="player-jump.ogg" | File name of sound file |
| hidden | [0,1] | hidden=0 | Hide this sound in the available sounds list in the events |