Rogue: Savage Rats, a retro-themed dungeon crawler
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
rogue-savage-rats/README.md

72 lines
1.4 KiB

11 years ago
# Rogue - Savage Rats
11 years ago
Manual on [Google Drive](https://docs.google.com/document/d/1Ak9oVOnCKSqWux4Hm_-efDYTj4uewf5MtR_Zmys7goQ)
## Description
### Goals
11 years ago
- Simple retro-themed dungeon crawler
### Code Features
11 years ago
- Full OOP design
- Event driven
- OpenGL 2D rendering
- Screen / layer based graphics with Constraint System
- A* path-finding system
- Audio, Font & Texture systems
- Easily extensible base framework
### Game Features
- Real-time action
- Monsters with AI
- Collectable items (weapons, food)
- Random floor generator
11 years ago
### Used libraries
11 years ago
- LWJGL (OpenGL & OpenAL support)
- 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