Game Configuration Pack References

From PGE Wiki
Jump to navigation Jump to search

Game Configuration package is the main foundation for all games which will work with PGE: it's a set of game resources, item settings, and scripts. A Configuration pack includes item definitions, gameplay settings, game content, and other miscellaneous information.


All configuration packs must use this tree structure:

Note: italic folders can be customized by main.ini config

/<Name of config pack> - the config pack root directory

  • /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
  • /tilesets
  • /group_tilesets
  • /characters - playable character calibrations
  • /fonts - collection of in-game fonts (PGE Raster fonts, or TTF)
  • /items - collection of individual item configs (not used when elements definitions are using nested style)
    • /backgrounds - collection of level backgrounds individual configs
    • /bgo - collection of level background objects individual configs
    • /blocks - collection of level blocks individual configs
    • /levels - collection of world map level entrance objects individual configs
    • /npc - collection of level NPCs individual configs
    • /paths - collection of world map path cells individual configs
    • /scenery - collection of world map scenery objects individual configs
    • /terrain - collection of world map terrain tiles individual configs
  • /script - Config pack lua scripts are programming the game
    • /npcs - NPC-AI lua scripts
    • /player - Playable characters lua scripts
  • main.ini - main configuration pack description and settings
  • engine.ini - main settings of game engine application.
  • music.ini - configuration and list of musics
  • sounds.ini - configuration and list of sounds
  • sound_roles.ini - association of buit-in sound roles with sound-ID's from sounds.ini
  • rotation_table.ini - transformation rules which applies to items when rotating or flipping action was applied to them
  • lvl_characters.ini - Playable characters list definition
  • 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 - Graphical effects list definition
  • lvl_npc.ini - definition of non-playable characters for levels
    • Single entry config - definition (or customization) of a single entry of non-playable character for levels
  • lvl_section.json - Extra settings for level sections (see Extra Settings JSON Layout for specification)
  • lvl_settings.json - Extra settings for level-wide settings (see Extra Settings JSON Layout for specification)
  • wld_tiles.ini - World map terrain tiles list definition
  • wld_scenery.ini - World map scenery objects list definition
  • wld_paths.ini - World map path cells list definition
  • wld_levels.ini - World map level entrance objects list definition

Additional specs