From 29b831259dcb018bc688e05c0d856d509d50ed6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ond=C5=99ej=20Hru=C5=A1ka?= Date: Tue, 13 May 2014 01:31:29 +0200 Subject: [PATCH] Removed trash, updated readme. --- README.md | 59 ++++++++++++++++++++++++++++++++++++++++++++----------- check | 8 -------- pull | 8 -------- send | 40 ------------------------------------- 4 files changed, 48 insertions(+), 67 deletions(-) delete mode 100755 check delete mode 100755 pull delete mode 100755 send diff --git a/README.md b/README.md index 3f1b314..7abd644 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,16 @@ -Rogue - dungeon crawler -======================= +# Rogue - dungeon crawler -Goals ------ +Alt-name: *Savage Rats: The Beer Hunt* + + +## Description + +### Goals - Simple retro-themed dungeon crawler -Features --------- +### Code Features - Full OOP design - Event driven @@ -19,8 +21,7 @@ Features - Easily extensible base framework -Gameplay --------------- +### Game Features - Real-time action - Monsters with AI @@ -28,8 +29,44 @@ Gameplay - Random floor generator -Used libraries --------------- +### Used libraries - LWJGL (OpenGL & OpenAL support) -- SlickUtil (texture loader, audio system) \ No newline at end of file +- SlickUtil (texture loader, audio system) + + + +## BUILDING FROM SOURCE + +1. Export a jar with the `mightypork.*` packages and the `res` folder into `./build/in/build.jar` +2. CD into `./build` +3. Run `make` to create a stand-alone executable jar in `./build/out/release.jar` +4. Use `make run` to execute it + + + +## Usage + +The game is controlled by mouse and keyboard. + +### In-game controls + +- *ARROWS* or *ASDW* - walking +- *E* - eat smallest food +- *Z* - Toggle map magnification (zoom) +- *M* - Toggle the minimap +- *I* - Toggle inventory screen (pauses the game) +- *SPACE*, *P*, *PAUSE* - pause / resume the game + +- *Left button hold* - walk in the direction +- *Right click* - find path to the tile (works also on Minimap) + + +### Global controls + +- *Ctrl+M* - Jump to main menu +- *Ctrl+Q* - Quit to DOS +- *F2* - Take a screenshot +- *F11* - Toggle fullscreen + + diff --git a/check b/check deleted file mode 100755 index f173ba2..0000000 --- a/check +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/bash -echo - -echo -e "\e[0;33m> git status\e[0m" -echo -git status - -echo \ No newline at end of file diff --git a/pull b/pull deleted file mode 100755 index 49af273..0000000 --- a/pull +++ /dev/null @@ -1,8 +0,0 @@ -#!/bin/bash -echo - -echo -e "\e[0;33m> git pull origin master\e[0m" -echo -git pull origin master - -echo \ No newline at end of file diff --git a/send b/send deleted file mode 100755 index 1201c17..0000000 --- a/send +++ /dev/null @@ -1,40 +0,0 @@ -#!/bin/bash - -. check - -if [ -z "`git status --porcelain`" ] - then - echo -e "\e[0;31m Nothing to commit.\e[0m" - echo - exit -fi - - -echo -e "\e[0;32m Going to ADD all, COMMIT and PUSH.\e[0m" -echo -e "\e[0;32m Enter commit message (leave blank to abort).\e[0m" -echo -echo -n -e "\e[1;36m [msg]: \e[0m" -read msg -echo - -if [ -z "$msg" ] - then - echo -e "\e[0;31m Aborted.\e[0m" - echo - exit -fi - -echo -e "\e[0;33m> git add --all\e[0m" -echo -git add --all -echo - -echo -e "\e[0;33m> git commit -m \"$msg\"\e[0m" -echo -git commit -m "$msg" -echo - -echo -e "\e[0;33m> git push origin master\e[0m" -echo -git push origin master -echo