Main.ini (Config pack)

From PGE Wiki
Jump to navigation Jump to search

main.ini - General config pack settings. Provides the main settings of configuration package and it's identification.

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.

Default file formats for untitled files

[ file-formats ]
Parameter Allowed values Example value Description
level Enum:
* smbx64
* pgex
* smbx38a
level = pgex Default file format for level files: smbx64 is SMBX 1.3 compatible level file; pgex is own PGE format which supports all available features of PGE Project; smbx38a is SMBX-38A compatible level file format.
world Enum:
* smbx64
* pgex
* smbx38a
world = pgex Default file format for world map files: smbx64 is SMBX 1.3 compatible world map file; pgex is own PGE format which supports all available features of PGE Project; smbx38a is SMBX-38A compatible world map file format.


List of available playable characters in game (DEPRECATED, use lvl_characters.ini instead)

[ 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

Define initial dock widgets visibility in the Editor (applying on the first Editor run) (Added since May 26, 2018)

[ widgets-default-visibility ]
Parameter Allowed values Example value Description
lvl-itembox 0, 1, true, false lvl-itembox = true Initial visibility of Level ItemBox
lvl-itembox-enforce-default 0, 1, true, false lvl-itembox-enforce-default = false Enforce default visibility on startup of Level ItemBox
lvl-section-props 0, 1, true, false lvl-section-props = true Initial visibility of Level Section Properties
lvl-section-props-enforce-default 0, 1, true, false lvl-section-props-enforce-default = false Enforce default visibility on startup of Level Section Properties
lvl-warp-props 0, 1, true, false lvl-warp-props = true Initial visibility of Level Warps and Doors
lvl-warp-props-enforce-default 0, 1, true, false lvl-warp-props-enforce-default = false Enforce default visibility on startup of Level Warps and Doors
lvl-layers 0, 1, true, false lvl-layers = true Initial visibility of Level Layers box
lvl-layers-enforce-default 0, 1, true, false lvl-layers-enforce-default = false Enforce default visibility on startup of Level Layers box
lvl-events 0, 1, true, false lvl-events = true Initial visibility of Level Classic Events box
lvl-events-enforce-default 0, 1, true, false lvl-events-enforce-default = false Enforce default visibility on startup of Level Classic Events box
lvl-search 0, 1, true, false lvl-search = true Initial visibility of Level Item Search box
lvl-search-enforce-default 0, 1, true, false lvl-search-enforce-default = false Enforce default visibility on startup of Level Item Search box
wld-itembox 0, 1, true, false wld-itembox = true Initial visibility of World map ItemBox
wld-itembox-enforce-default 0, 1, true, false wld-itembox-enforce-default = false Enforce default visibility on startup of World map ItemBox
wld-settings 0, 1, true, false wld-settings = true Initial visibility of World map Settings
wld-settings-enforce-default 0, 1, true, false wld-settings-enforce-default = false Enforce default visibility on startup of World map Settings
wld-search 0, 1, true, false wld-search = true Initial visibility of World map Item Search box
wld-search-enforce-default 0, 1, true, false wld-search-enforce-default = false Enforce default visibility on startup of World map Item Search box
tilesets-box 0, 1, true, false tilesets-box = true Initial visibility of Tilesets ItemBox
tilesets-box-enforce-default 0, 1, true, false tilesets-box-enforce-default = false Enforce default visibility on startup of Tilesets ItemBox
debugger-box 0, 1, true, false debugger-box = true Initial visibility of Debugger box
debugger-box-enforce-default 0, 1, true, false debugger-box-enforce-default = false Enforce default visibility on startup of Debugger box
bookmarks-box 0, 1, true, false bookmarks-box = true Initial visibility of Bookmarks box
bookmarks-box-enforce-default 0, 1, true, false bookmarks-box-enforce-default = false Enforce default visibility on startup of Bookmarks box
variables-box 0, 1, true, false variables-box = true Initial visibility of Variables box
variables-box-enforce-default 0, 1, true, false variables-box-enforce-default = false Enforce default visibility on startup of Variables box


Disable certain in-editor feature (Added since April 5, 2019)

[ supported-features ]
Parameter Allowed values Example value Description
level-section-vertical-wrap active, inactive, hidden level-section-vertical-wrap = active Enable or Disable vertical wrap checkbox in Section Settings.
level-phys-ez-new-types active, inactive, hidden level-phys-ez-new-types = active Enable or Disable new physical environment types.
level-bgo-z-layer active, inactive, hidden level-bgo-z-layer = active Enable or Disable Z-Layer field for BGO.
level-bgo-z-position active, inactive, hidden level-bgo-z-position = active Enable or Disable Z-Offset/Position field for BGO.
level-warp-two-warp active, inactive, hidden level-warp-two-warp = active Enable or Disable two-way warp checkbox.
level-warp-portal active, inactive, hidden level-warp-portal = active Enable or Disable portal warp type.
level-warp-bomb-exit active, inactive, hidden level-warp-bomb-exit = active Enable or Disable bomb exit warp checkbox.
level-warp-allow-special-state-only active, inactive, hidden level-warp-allow-special-state-only = active Enable or Disable allow special only checkbox for warp.
level-warp-hide-interlevel-scene active, inactive, hidden level-warp-hide-interlevel-scene = active Enable or Disable hide inter-level scene when going another level by warp.
level-warp-allow-interlevel-npc active, inactive, hidden level-warp-allow-interlevel-npc = active Enable or Disable allow inter-level NPC carrying for warp.
level-warp-hide-stars active, inactive, hidden level-warp-hide-stars = active Enable or Disable hide star mark for warp.
level-warp-needed-stars-message active, inactive, hidden level-warp-needed-stars-message = active Enable or Disable custom need stars message for warp.