Editing MG/Project Structure
Jump to navigation
Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
| − | This page describes the | + | This page describes the folder structure of the [[MegaGlest]] Project. |
==Structure== | ==Structure== | ||
| Line 6: | Line 6: | ||
! scope="col"|Description | ! scope="col"|Description | ||
|- | |- | ||
| − | | | + | |top level folder |
|Contains top level CMakeLists.txt which controls how the sub modules get built using cmake | |Contains top level CMakeLists.txt which controls how the sub modules get built using cmake | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data</tt> |
|Contains game data content like models, textures, xml files, etc which the game loads as required. This is game data which ships with the game by default (such as the Megapack). Mods are not placed here but in the users' home directory (ApplicationData on Windows) - they use the same directory structure, though. | |Contains game data content like models, textures, xml files, etc which the game loads as required. This is game data which ships with the game by default (such as the Megapack). Mods are not placed here but in the users' home directory (ApplicationData on Windows) - they use the same directory structure, though. | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data/glest_game/data/core</tt> |
|Core game data such as menu textures, fonts and sounds | |Core game data such as menu textures, fonts and sounds | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data/glest_game/data/lang</tt> |
|Language files translated into your native tongue (feel free to contribute) | |Language files translated into your native tongue (feel free to contribute) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data/glest_game/maps</tt> |
|[[Map]] files (these are the world definition to play the game in) | |[[Map]] files (these are the world definition to play the game in) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data/glest_game/scenarios</tt> |
|[[Scenario]] files ([[Lua]] scripting for story mode) | |[[Scenario]] files ([[Lua]] scripting for story mode) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data/glest_game/screens</tt> |
|This is the folder where screenshots are saved when users press the ''E'' hotkey in game | |This is the folder where screenshots are saved when users press the ''E'' hotkey in game | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data/glest_game/techs</tt> |
|[[Techtrees]] which contains selected [[faction]] definitions (XML, G3D, OGG, etc) | |[[Techtrees]] which contains selected [[faction]] definitions (XML, G3D, OGG, etc) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data/glest_game/tilesets</tt> |
|[[Tileset]] files (this defines how the terrain should look, grassy, sandy, forest, etc) | |[[Tileset]] files (this defines how the terrain should look, grassy, sandy, forest, etc) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>data/glest_game/tutorials</tt> |
|Tutorial files (this is where beginners should start to learn how to play) | |Tutorial files (this is where beginners should start to learn how to play) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>docs</tt> |
|Contains various readme files, license agreements, etc. This is a good place to start reading for developers. | |Contains various readme files, license agreements, etc. This is a good place to start reading for developers. | ||
|- | |- | ||
| − | |<tt> | + | |<tt>mk</tt> |
|This is where platform specific project files are kept. Currently there are folders for ''linux'', ''windoze'', ''macosx'' and ''shared'' (for files used on multiple platforms) | |This is where platform specific project files are kept. Currently there are folders for ''linux'', ''windoze'', ''macosx'' and ''shared'' (for files used on multiple platforms) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>mk/linux</tt> |
|Linux related files | |Linux related files | ||
|- | |- | ||
| − | |<tt> | + | |<tt>mk/fedora</tt> |
|fedora rpm build related files | |fedora rpm build related files | ||
|- | |- | ||
| − | |<tt> | + | |<tt>mk/macosx</tt> |
|OS X project files (using XCode) | |OS X project files (using XCode) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>mk/windoze</tt> |
|Windows project files (using Visual Studio 2008 Express) | |Windows project files (using Visual Studio 2008 Express) | ||
|- | |- | ||
| − | |<tt> | + | |<tt>source</tt> |
|All source code for the project lives inside here. | |All source code for the project lives inside here. | ||
|- | |- | ||
| − | |<tt> | + | |<tt>source/g3d_viewer</tt> |
|A tool for G3D model and particle file viewing | |A tool for G3D model and particle file viewing | ||
|- | |- | ||
| − | |<tt> | + | |<tt>source/glest_game</tt> |
|C / C++ MegaGlest game code | |C / C++ MegaGlest game code | ||
|- | |- | ||
| − | |<tt> | + | |<tt>source/glest_map_editor</tt> |
|A tool for editing *.gbm (Glest) and *.mgm (MegaGlest) map files | |A tool for editing *.gbm (Glest) and *.mgm (MegaGlest) map files | ||
|- | |- | ||
| − | | | + | |<tt>source/masterserver</tt> |
| − | | | + | |PHP source code for our hosted masterserver |
|- | |- | ||
| − | |<tt> | + | |<tt>source/shared_lib</tt> |
|C / C++ shared library code used in MegaGlest and some of the tools above | |C / C++ shared library code used in MegaGlest and some of the tools above | ||
|- | |- | ||
| − | |<tt> | + | |<tt>source/tests</tt> |
|C / C++ unit tests | |C / C++ unit tests | ||
|- | |- | ||
| − | |<tt> | + | |<tt>source/tools</tt> |
|Several utilities related to MegaGlest | |Several utilities related to MegaGlest | ||
|- | |- | ||
| − | |<tt> | + | |<tt>source/windows_deps</tt> |
|C / C++ dependencies for Windows Compilation | |C / C++ dependencies for Windows Compilation | ||
|} | |} | ||
==Linux Scripts== | ==Linux Scripts== | ||
| − | The following are miscellaneous scripts located in <tt> | + | The following are miscellaneous scripts located in <tt>mk/linux</tt>: |
{| class="wikitable" | {| class="wikitable" | ||
| Line 102: | Line 102: | ||
|- | |- | ||
|''setupBuildDeps.sh'' | |''setupBuildDeps.sh'' | ||
| − | |Installs required | + | |Installs required linux dependencies (Ubuntu, Debian, Fedora and open SuSE based) |
|} | |} | ||