diff options
| author | tcsullivan <tullivan99@gmail.com> | 2016-11-25 12:44:45 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-11-25 12:44:45 -0500 |
| commit | 2bca6239c8c65a982628a8643312c17ce66246cb (patch) | |
| tree | 0c588a2407cfc31feba6003393a33daddafff95f /README.md | |
| parent | a54c935490b2c4e3840b91796c5ca530db8a828f (diff) | |
updated readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 11 insertions, 7 deletions
@@ -3,6 +3,8 @@ gamedev gamedev is a high school project between drumsetmonkey and tcsullivan written in C++ and using SDL2/OpenGL. The goal of this project is to have a completed commercial-grade video game available to Linux and Windows users. We plan on profiting off of the game once we finish it, so once the game reaches its final stages it may become closed source (however, what was uploaded will stay for others to use as a resource). +NOTE!!!! +We're going through a major rewrite right now, so a lot of stuff probably won't work. Building should still be managable though. Build Requirements ------------------ @@ -13,9 +15,9 @@ Fedora, FreeBSD, and Windows 7, 8 and 10. The following libraries are required t * SDL2, including SDL2_image and SDL2_mixer * FreeType (2? libfreetype6? who knows...) * GLEW +* entityX (alecthomas/entityx on github) -You will also need the GNU GCC compiler collection, including the programs 'g++' and 'ld'. - +You will also need the GNU GCC compiler collection, the Makefile uses g++. Building -------- @@ -28,7 +30,7 @@ make This command may be multithreaded using the -j argument. -To run on not-Windows, once built: +To run on Linux, once built: ``` ./main @@ -44,23 +46,25 @@ The executable may take the following arguments: * -r, which will reset XML and player data * -d, which will kill the game once initialization has been done +* -x, specify which XML file to load. Looks in the XML folder, defined in config/setting.xml -d is mainly used in conjunction with -r, to reset the XML files and then exit the game before they can be overwritten. - +-x might be buggy, or not work. Controls -------- The following are the controls for the game. Any extra controls can be found in ```src/ui.cpp``` +Controls can kinda be adjusted using the in-game control menu. Movement: * 'a' and 'd' move the player left and right respectively +* 'w' enters buildings * 'space' make the player jump if he obtains the jumping skill * 'L-Shift' increase the players speed to a "sprint" if he obtains the running skill * 'L-Ctrl' decrease the players speed to a "walk" +* 'h' opens a quest menu Other: -* 'f' place a light -* 'l' create a light that follows the player -* 't' hold to quickly move time * 'f3' for debug information +* 'f12' for screenshot (currently segfaults, fixing) |