Marathoner - game engine for Game Jams.
Work in progress.
Supported platforms:
- Windows 32x or 64x
More detailed description will be in v1.0.0.
There is plan what we need complete till version 1.0.0 on Trello. Completed tasks will be moved to archive. Estimated date of completing plan is August-December 2018.
Some general features of this project. This project is only my hobby. This is why some of features can be a bit unreasonably. I just do what I like and no more.
- Using available solutions for everything. I do not want to write so many low-level routines. This is why project using so many third-party libraries as possible.
- Writing alternative modules if unable to build some modules on target platform. For example if needed third-party libraries does not support target platforms.
- Writing alternative modules if we need some more possibilities of other third-party libraries not exists in libraries used by current modules.
- Main Programming Language of this project is C without specific standard. It is possible to use C++ or Pascal in cases if I will need to use other language library or if I will want to do API for C++ or other language.
- Making so many abstraction levels as possible. I think it makes minimum limitations for game programmer.
- Not needed to support every file format. This file formats must be supported. Other formats are optional (for example extra file formats support in addition to mandatory can be provided by some third-party libraries).
- Images - png
- Sounds - wav
- Music - ogg
- Fonts - ttf and png-fonts
- Text - uft-8
- Config - ini
I can consider some ideas conflicting with current phylosophy if that ideas will not something as "Use pure OpenGL", "Use modern C++ as main programming language" or something similar.
Instructions for building third-party libraries can be found in:
Path to all needed toolchains' binaries must be in PATH variable.
Used compilers:
- Windows 32bit - TDM GCC 5.1.0
- Windows 64bit - MinGW-W64 x86_64 based on GCC 6.3.0
Before building you need to resolve conflicting names for windres utility in windows toolchains. My solution for every toolchain:
- Copy file windres.exe
- Rename copyed file to mingw32-windres.exe or x86_64-w64-mingw32-windres.exe
Directories "bin", "include" and "lib" of all prerequired libraries must be placed in "usr/local/toolchain_name" else you need build engine with parameter "PREFIX=<path_to_libraries>". In this case "bin" folder of third party libraries will be in directory "<path_to_libraries>/bin", "include" folder will be in "<path_to_libraries>/include" etc. On MSYS2 root "/" directory placed in MSYS2 folder, "/usr" directory in "<path_to_msys2>/usr" etc.
Build for default platform (currently Windows 32bit) with default options:
$ make
Build with custom options:
$ make [PLATFORM=<platform>] [<option1>=<value>] [<option2>=<value>] ...
Additional options:
- PLATFORM=<platform> - Choose target platform: win32 or win64. Default - PLATFORM=win32
- MOD=static, MOD=plugin - Build monolythic or plugin-based application. Default - MOD=plugin
- DEBUG=no, DEBUG=yes - Add or not add debug information in executables and plugins. Default - DEBUG=yes
- MORE_WARNINGS=no, MORE_WARNINGS=yes - Enable or disable some more warnings in compiletime. Default - MORE_WARNINGS=yes
Default options can be changed in file "Build.mk"
Builded executables can be found in directories "win32", "win64" etc.
Before building you need open file "makefiles/Monolythik.mk" and edit variable MODULES. It contain list of directories where modules' makefiles are placed. Listed modules will be builded with engine in monolythic application.
Example list:
MODULES = src/$(SCREEN_SDL2) \
src/$(SCREEN_SDL2_LUA) \
src/$(TEXTURE_SDL2_IMAGE) \
src/$(TEXTURE_SDL2_IMAGE_LUA) \
src/$(PRIMITIVE_SDL2) \
src/$(PRIMITIVE_SDL2_LUA) \
src/$(PNG_LIBPNG) \
src/$(PNG_LIBPNG_LUA) \
src/$(TTF_SDL2_TTF) \
src/$(TTF_SDL2_TTF_LUA) \
src/$(AUDIO_SDL2_MIXER) \
src/$(AUDIO_SDL2_MIXER_LUA) \
src/$(KEYBOARD_SDL2) \
src/$(KEYBOARD_SDL2_LUA) \
src/$(MOUSE_SDL2) \
src/$(MOUSE_SDL2_LUA) \
src/$(GAME_CONTROLLER_SDL2) \
src/$(GAME_CONTROLLER_SDL2_LUA) \
src/$(TIMER_SDL2) \
src/$(TIMER_SDL2_LUA) \
src/$(JSON_CJSON) \
src/$(JSON_CJSON_LUA) \
src/$(UTILS_COLOR) \
src/$(UTILS_COLOR_LUA) \
src/$(UTILS_MATH) \
src/$(UTILS_MATH_LUA) \
src/$(ABSTRACTION_SPRITE) \
src/$(ABSTRACTION_SPRITE_LUA) \
src/$(ABSTRACTION_FONT) \
src/$(ABSTRACTION_FONT_LUA) \
src/$(ABSTRACTION_GUI) \
src/$(ABSTRACTION_GUI_LUA) \
src/$(SCRIPT_LUA)
Note: Script module must be in list and must be latest in list.
Variables like SCREEN_SDL2 and SCREEN_SDL2_LUA are consists path to module's makefile from "src" directory. Full list of path variables can be found in main Makefile.
Scripts (Bat-files on Windows) for running tests plased in directory "<platform_name>/test_launch". Valid platform names - win32 and win64.
Text output of each test will be writed in file "test/output.txt".
Scripts with prefix "fa_" are launching Lua-scripts generating list of supported functions of that module.
Lua-scripts of tests placed in "test/<subsystem>" folder.
See function syntax without description in file doc/function_list_and_syntax.txt
More detailed will be in v1.0.0
You can setup launch options with commandline arguments.
"Marathoner [<option> <value>] [...]"
Engine options:
- "show-console" - show console with log on startup. Default - no. Valid values for showing console - "yes", "y", "1", "true".
Autorun options. This options have priority higher than configfile options:
- "--autorun-action <action>" - running way. Valid values: "runScript"
- "--autorun-plugin <pluginname>" - ID of plugin that will be run VM. Option is valid only if engine built as plugin-based
- "--autorun-script <filename>" - autorun script filename
Choose module of subsystem. This option are valid only if engine built as plugin-based:
"--<subsystem> <module>" - Example "--script Script_Lua"
Force disable modules via commandline not implemented now.
More examples in tests' bat-files. See "<platform>/test_launch" directory.
- "show_console" key - show console with log on startup. Default - no
Game starting settings
- "action" key - running way. Valid values: "runScript"
- "plugin" key (if "action = runScript") - ID of plugin that will be run VM. Key is valid only if engine built as plugin-based
- "script" key (if "action = runScript") - autorun script filename
Mark modules for forced disable. Keys are valid only if engine built as plugin-based.
key-value format: "<plugin_ID> = 0|1"
0 - disabled
1 - enabled (default)
Specify plugin ID of each subsystem for solve conflicts
of several plugins responsible for one subsystem or completely disable
subsystem. Keys are valid only if engine built as plugin-based:
key-value format: "<subsystem_name> = <plugin_ID> | none"
- <plugin_ID> for assign plugin
- "none" for disable subsystem
Launcher - program for edit configuration of the engine and launching needed autorun script file.
- Upper panel's buttons:
- Save - save configuration
- Save and Exit - save configuration and close Launcher
- Discard and Exit - discard changes and close Launcher
- Save and Run - save configuration and execute autorun script
- Discard and Run - discard changes and execute autorun script
- "Autorun" section:
- Plugin - choose Script plugin
- Script - choose Autorun script
- "Subsystem":
Choose module for every subsystem. You need to know about compatibility of the various standard modules (I need to do documentation for it). - "Enabled Modules":
check and uncheck modules for force disable (default - all enabled).
Em... somewho, theach me how to maintain project (and teach me English language and good manners too). I do not familiar with OpenSource culture.
I think I will able to do tasks of the plan till version 1.0.0 alone and then I will make complete "Contributing" instructions. If you will have ideas how to help, open issue or write me on e-mail: Vasiliy.Edomin{antispam}gmail{antispam}com.
- Source code are under zlib license (for this moment. Read LICENSE).
- Images made by me and generated sounds/music are under CC0 license (Public
Domain):
- "test/media/helicopter.png"
- "test/media/helicopter_anim.png"
- "test/media/castleFloor.png"
- "test/media/town_tileset_day.png"
- "test/media/mbf_big_00.png"
- "test/media/mbf_big_04.png"
- "test/media/bu-a-ninja-and-shields.ogg"
- "test/media/pickup.wav"
- "test/media/punch.wav"
- "test/media/explosion.wav"
- License text for font "test/media/Vera.ttf" can be found in file "test/media/COPYRIGHT-Vera.TXT". Author - Bitstream, Inc.
- Images made by Shepardskin are under CC0 license (Public Domain):
- "test/media/dog.png"
And I am sorry for my bad english.