Source code repository structure of PGE Project

From Moondust Wiki
Revision as of 11:52, 24 April 2017 by Wohlstand (talk | contribs)
Jump to navigation Jump to search

Structure of folder of PGE Project repository

  • _common - a common code, used by multiple components
    • ConfigPackManager - common code to read configuration package INI properties of elements
    • data_functions - SMBX64 validation functions
    • DirManager - a directory manager which designed as alternative to QDir in STL programs
    • FileMapper - a cross-platform class which provides support for file memory mapping interface
    • fmt - a flexible library to format strings, used by PGE Engine
    • IniProcessor - parser of INI files which designed as alternative to QSettings in STL programs
    • PGE_File_Formats - <Submodule> A library that provides ability to read and write level and world map files of various formats
    • res_generator - a small middle-ware utility that builds the resources header for PGE Engine
    • tclap - a flexible library which provides flexible command line arguments parsing, used by PGE Engine, PNG2GIFs, GIFs2PNG and LazyFixTools
    • travis-ci - a set of bash scripts which are designed for building the PGE Project on various CI servers
    • Utf8Main - a class which will guarantee that main(argc, argv) will always receive arguments in UTF-8 with no matter to operating system
    • Utils - a set of common utility classes
  • _Libs - dependent libraries to PGE Project
    • _builds - the cache of pre-built libraries for various operating systems
    • _sources - the folder which contains autotools-buildable libraries packed into tarballs and the set of bash scripts to build them
    • AudioCodecs - a set of audio coding and decoding libraries are required for SDL Mixer X library
    • FreeImage - <Submodule> a library which provides reading and writing of images in various formats, used by almost every component except of PGE Manager and PGE Maintainer
    • luabind - a flexible and powerful library which providing the binding API for lua in C++11, used by PGE Engine
    • oolua - another lua binding library, currently is not used, based on Lua 5.3
    • QtPropertyBrowser - a library that provides flexible property editing widget, used by PGE Editor
    • SDL_Mixer_X - SDL Mixer X - a flexible and powerful audio mixing library, used by PGE Editor, PGE Engine, and PGE Music Player
    • sqlite3 - <Submodule> A library which provides SQLite database system, used by PGE Engine
  • _Misc - Scripts, resources and experimental projects are related to PGE Project
  • luadoc - drafts for PGE Engine lua api documentation
  • Content - a set of resource are placing together with the executables into binary folder (documentations, examples, readmes, editor themes, etc.)
  • Documents - various specifications, documentation, sketches, storing and using by developers
  • Editor - the PGE Editor application
  • Engine - the PGE Engine application
  • GIFs2PNG - a masked GIFs to PNG conversion utility
  • PNG2GIFs - a PNG to masked GIFs conversion utiltiy
  • LazyFixTool - an utility which automatically fixes a bad-drawn masked GIFs graphics
  • Maintainer - a GUI utility that provides tool set to maintain graphics, musics, levels, and episodes
  • Manager - a WIP manager designed to provide easier way to update PGE and download & update a public configuration packages
  • MusicPlayer - an SDL Mixer X based music player with Qt frontend designed for a music testing before including it into the game
  • PlayableCalibrator - an utility to create the playable character configuration that includes offsets of frames and animation sets
  • ServerLib - a WIP networking server prepared for implementation of cooperative editing and netplay support