From d0c6f8dc2158689d7d10d8c5820830be235432e5 Mon Sep 17 00:00:00 2001 From: tcsullivan <tullivan99@gmail.com> Date: Wed, 21 Mar 2018 12:16:58 -0400 Subject: Update README.md --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2f969b0..89d7b73 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ gamedev ======= -gamedev was started as a high school project between drumsetmonkey and tcsullivan, written in C++ and using SDL2/OpenGL. The goal of this project was to have a completed commercial-grade video game available for Linux and Windows users; the plan was to profit off the game once it and the engine were finished. Through the first year and a half of development we quickly learned that the game's engine would need the most focus, as we were starting from complete scratch. Due to this, there is no playable, plot-based game. +gamedev was started as a high school project between drumsetmonkey and tcsullivan, written in C++ and using SDL2/OpenGL. The goal of this project was to have a completed commercial-grade video game available for Linux and Windows users; the plan was to profit off the game once it and the engine were finished. Through the first year and a half of development we quickly learned that the game's engine would need the most focus, as we were starting from complete scratch. Due to this, there is no playable, plot-based game (yet?). -However, the engine is still growing. Development has now slowed to a crawl with the start of our college lives, but changes will still be made every now and then. Maybe a true video game will eventually come out of this, but the engine will most likely always remain open source. +However, the engine is still growing. Development has now slowed to a crawl with the start of our college lives, but changes will still be made every now and then. Maybe a true video game will eventually come out of this, but the engine will always remain open source. Build Requirements ------------------ -The 'gamedev' project can be built on both Linux-based and Windows operating systems. The game has been verified (at some point) to work on Debian, Arch Linux, FreeBSD, and Windows 7 through 10. The following programs and libraries are required to build 'gamedev': +The 'gamedev' project can be built on both Linux-based and Windows operating systems. The game has been verified (at some point) to work on Debian, Arch Linux, FreeBSD, and Windows 7/10. The following programs and libraries are required to build 'gamedev': * make * g++ -* SDL2, including SDL2_image and SDL2_mixer +* SDL2, SDL2_image, and SDL2_mixer * FreeType 2 * GLEW * giflib @@ -23,7 +23,7 @@ Windows builds are done with msys2, 64-bit. The compiler must support C++17. Build Preparation ----------------- -The Makefile expects a file named setup.mk to exist. It needs to define two variables on two lines: +The Makefile expects a file named setup.mk to exist. It needs to define two variables: ``` TARGET_OS = # either win32 or linux TARGET_BITS = # either 32 or 64 @@ -37,7 +37,7 @@ cp config/settings.xml.example config/settings.xml Finally, create an output directory (used for compiling): ``` -mkdir out +mkdir -p out/systems out/components ``` Building @@ -54,8 +54,7 @@ To build the engine: ``` make ``` - -This command may be multithreaded using the -j argument. +This command may be multithreaded using the -j argument. To run on Linux, once built: ``` @@ -82,6 +81,7 @@ The following are the controls for the game. Any extra controls can be found som Some controls can be adjusted using the in-game control menu. Movement: +* 'esc' for the menu * 'a' and 'd' move the player left and right * 'w' enters buildings * 'e' opens the inventory -- cgit v1.2.3