From 4c926af3996aa8a5ebacd47b4ca0fd7b9a32b468 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Lemaire?= Date: Sun, 16 Feb 2014 13:11:11 +0100 Subject: [PATCH] Update readme --- README.md | 73 +++++++++++++++++++++++++++++++++- readme.txt | 113 ----------------------------------------------------- 2 files changed, 71 insertions(+), 115 deletions(-) delete mode 100644 readme.txt diff --git a/README.md b/README.md index 31676df..d81a670 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,73 @@ -blockofighter +BlockoFighter ============= -A 3d two-player arena combat game, featuring characters similar to a popular construction toy +A 3D two-player arena combat game, featuring characters similar to a popular construction toy. + +About +----- + +BlockoFighter is a humorous beat-em-up game which originally started as a school project during a course in computer graphics. The first version called LegoFighter was finished under Christmas 2001 and now, after many months of work and idle time, we are finally presenting BlockoFighter - the second version of the game. + +The game has been completely rewritten and there are many improvements which include sound effects and music, a full 3D arena and a nice physics engine. The backbones for the game are OpenGL and SDL. + +This version of the game was made as an entry for the game development competition at the Assembly 2002 demo party. It placed third (kudos to the winner, Stair Dismount ;) + +Blockofighter is a two-player game where two Blocko men (they may look like LEGO characters but they are not) encounter in a fierce battle which occurs in a rectangular arena located in the spectacular fjords of scenic Lapland. The fighting is so intense that severed limbs or heads are not a rare sight. Furious breakdancing moves are available for skilled players who want to fight with style. West side! + +How to play +----------- + +Use arrows, enter and esc to navigate in menus. + +| Action | Player 1 | Player 2 | +|:---------------|:-------------:|:------------:| +| Move forward | Up arrow | E | +| Move backward | Down arrow | D | +| Turn left | Left arrow | S | +| Turn right | Right arrow | F | +| Jump | ¨ or ] | Q | +| Hit | ' or \ | A | + +Requirements +------------ + +Minimal system requirements are: + +* Windows or GNU/Linux operating system +* OpenGL 2.0 (or better) compatible graphics card, with at least 64MB graphical memory +* At least 1GHz CPU +* At least 512MB RAM + +Software dependencies are: + +* [SDL 1.2](http://www.libsdl.org/) +* [SDL_Image 1.2](http://www.libsdl.org/) +* [FMOD](http://www.fmod.org) + +Compiling +--------- + +Use the provided Makefile (altering it if necessary), and build the game using the `make` command. You can then run the program using the compiled executable, from the main project directory. + +Credits +------- + +* Miika Sell - Original source code +* Juha Kaarlas - Original source code +* [Michaël Lemaire](http://thunderk.net) - Current maintainer +* Osmand - Music +* Forge - Sound effects + +Links +----- + +The project is hosted on [GitHub](https://github.com/thunderk/blockofighter). + +The original demoscene release is presented on [pouët.net](http://www.pouet.net/prod.php?which=7195). + +License +------- + +This source code is available under the terms of the [Mozilla Public License](http://www.mozilla.org/MPL/2.0/). Read the full license terms in the LICENSE file. + +LEGO® is a trademark of the LEGO Group of companies which does not sponsor, authorize or endorse this program. Any resemblance with LEGO® bricks is purely coincidental or made as a tribute, with no commercial claim whatsoever. diff --git a/readme.txt b/readme.txt deleted file mode 100644 index 251ee16..0000000 --- a/readme.txt +++ /dev/null @@ -1,113 +0,0 @@ - - BlockoFighter v. 2.01 - - - http://blockofighter.kicks-ass.net/ - - -Standard disclaimer and legal mumbo jumbo -========================================= - -This program is FREEWARE, which means you can use the program without -a charge for non-profit purposes, namely personal gaming. - -LEGO® is a trademark of the LEGO Group of companies which does not -sponsor, authorize or endorse this program. The models may look like -LEGO® bricks but that is just your mind doing tricks. - -We take no responsibility of what might or might not happen to you, -your computer, pets, car or whatever as a result of using this program. - -We'd like you to have fun playing this simple game. Although it isn't -mandatory we would very much like to receive feedback. - -Feedback can be sent to Miika Sell (msell@cc.hut.fi , Itchi on IrcNet) or -Juha Kaarlas (profeetta@psicorps.com , Druidi on IrcNet). - -You may distribute this game ONLY in it's complete form in original -package. Source codes are for educational purposes and for building -executable in Linux, and may not be used for own purposes without -our permission. - - -History -======= - -2.01: - * Blockomen make more damage -> faster games - * Blockomen can now jump from any stable surface - * Keyboard configuration is changed, see below for new controls - -2.0: - Whole game remade from scratch. - -Recommended system specs -======================== - -OpenGL is required! The game uses SDL for window and image handling, -and FMOD by Firelight Technologies for audio. - -Fast CPU (at least 1GHz) is highly recommended, mostly because of very -slow and unoptimized physics engine. Also a fast graphics-card is -recommended, but this game is mostly CPU-expensive. - - -Windows -======= - -All necessary libraries are included in the package. Just launch -BlockoFighter.exe - - -Linux -===== - -SDL and FMOD must be installed in order for this game to compile -and work. -SDL and SDL_Image are located at http://www.libsdl.org/, but are also -available for example via apt-get in Linux Debian: - apt-get install libsdl1.2-dev - apt-get install libsdl-image1.2-dev -FMOD is located at http://www.fmod.org/ - -After installing libraries, just use "make" -command to build the game, -and enjoy the game by launching blockofighter -executable. - -This game was created in Windows-environment, and we were not able -to test it in Linux enough, but at least it worked with me :) - - -Controls -======== - - Action Player 1 Player 2 ----------------------------------------------- - Move forward: Up arrow E -Move backward: Down arrow D - Turn left: Left arrow S - Turn right: Right arrow F - Jump: ¨ or ] (near enter) Q - Hit: ' or \ (near enter) A - -Use arrows, enter and esc to navigate in menus - - -Known issues -============ - -- Blockomen might sometimes get stuck in each others -- In some Linux-environment screen was left blank while game - was still running fine. We are working on this. -- There has been reports about blockomen not getting damage at all - when launching Blockofighter for the first time, though this has not - been verified. If this happens, try launching the game again. - - -Greetings -========= - -Special thanks to Osmand, who made two songs for us. -Thanks goes also to Forge for creating some of our sound effects. - -Since this is made for Assembly demoparty, some greets are necessary: - Lonely Coders, Unreal Voodoo, THP and all friends who supported us. \ No newline at end of file