Menace of the Mines User Manual

Krzysztof Drewniak


Table of Contents

1. Overview
Features
2. Setup
From sources (everyone else)
SVN Users
Dependencies
Editing configure.lisp
Installation
From binary packages (Windows only)
From sources (windows)
Special modifications
3. User manual
The screen
Controls
Moving Around
Inventory controls
Miscellaneous controls
Opening doors
Targeting
Gameplay
Combat
Statistics
Blessings and Curses
4. Developer documentation

Chapter 1. Overview

Table of Contents

Features

Menace of the Mines (or motm) is a fast-paced roguelike has tons of monsters, many different classes and races and a unique magic system. (Well that's the goal anyway). This will be written in Common Lisp. The project is hosted at http://www.sourceforge.net/projects/motm/

The game's setup is documented at Chapter 2, Setup

Features

Many of the game's features are not implemented yet. These features are marked by (planned), and will be implemented by release 1.0. Also a feature marked (WIP) is being worked on currently and should be finished in trunk shortly. So, without further ado... The features list

  • A flexible input system
  • Various types of monsters (WIP)
  • A level generator
  • Combat
  • Replay mode
  • Various dungeon features (WIP)
  • Weapons, scrolls, wands, potions and other objects (WIP)
  • Magic (planned)
  • A unique magic system (planned)
  • Many different classes and races (planned)
  • Whatever drops into the developers' heads

Chapter 2. Setup

From sources (everyone else)

SVN Users

Important

If you are using SVN, you MUST copy configure.lisp.default to configure.lisp.

Dependencies

You will need a Common Lisp implementation. Any should do, however, this is being tested with clisp http://clisp.cons.org/ only (Anything else WILL require patching). There is one lisp library you need to install,

If you don't want to install this library system-wide place them in a directory of your choosing and add a line resembling

 (inc "/path/to/library/directory/")

to configure.lisp replacing /path/to/library/directory/ with the path to the directory where the library resides.

Note

The library mentioned above also has other dependencies. The (inc ... scheme will work for those too

To get the help system working you will need a platform-specific help viewer. On Unix this is the info program and on Windows you need hh.exe. If you don't have these, you have bigger problems then my game not running.

To build the help system files you will need some additional tools

Editing configure.lisp

Before installation, you need to edit the file configure.lisp. This file contains the destinations of the binary and score file. It is well-commented (comments are set off by ;) but, a quick review won't hurt First, all options are written as

(option :option-name option-value)

To change an option, simply change the option-value part to what you would like Additionally, all filenames are in double-quotes.

Warning

All directories must have trailing slashes

The three options you are most likely to change are (with the

:option-name

given

  • :install-dir

    which controls what directory the binaries will go in.

  • :score-dir

    which controls what directory the score and help files will go in.

  • :score-group

    which controls the group which owns the high-score file. Two good values for this group are games and users

    Important

    All users who wish to play Menace of the Mines MUST be in this group.

Installation

The installation procedures are simple. First, make sure that you have followed all the procedures in the section called “Editing configure.lisp. Then, type make followed by make install . This will compile and install the system. (You may need to run the make install command as root). To run the program, run the program motm

From binary packages (Windows only)

If you have downloaded a windows binary .zip (motm-X.Y-bin.zip) you simply double-click on motm.exe. The game will then start. Follow the instructions in Chapter 3, User manual to run the game

From sources (windows)

Special modifications

You will need to extract clisp 2.44into the source directory. Then get ASDF and extract it into the clisp-2.44 directory (you will need to be able to extract .tar.gz files. Then proceed to the section called “From sources (everyone else)” and continue. However, keep these modifications in mind:

Chapter 3. User manual

The screen

A typical Menace of the Mines screen might look like the example below. (Your screen will be in color, but that can't be reproduced here.)

 
Selected you [+,-,f]
                                                            HP: 37/50
                                                            Zaps: 4/4
                                                            Speed: +1
                                                            Str: 16/18
                                                            Dex: 15/18
                                                            Con: 13/18
                                                            Int: 14/18
                                                            Wis: 13/18
             ---+--                                 ------  Saves: 14/18
             |....|  --------  --------   -------   |....|  AC: 2
             |....'# |......'# |.......###......|   |....|
             |....| #'......| #.......|   |.....'#  |....|
             |....|  --------  |......|   ------- ##..<..|
             --.---            --------             ------
           ####
       ####---------   -----              -------
  ----.-   |.......|   |...|    -------   |..@..|  -------
  |....|  #'....x..|   |...|  ##'.....|   |.....| #.[....|
  |.....## |.......'#  |....##  |......###...?...# |.....|
  |....|   --------- ##...(|    -------   -------  |.....|
  ------               -----                       -------

This may seen strange to you. So a list of what all the symbols mean follows below

.

A floor file, on which you can stand.

| and -

The walls of rooms.

#

The tiles of dark corridors, which you can't see much in.

+

Closed doors, which can be opened with the o key (see the section called “Moving Around”)

'

An open door, which you can waltz right through.

Any letters of the alphabet

Enemy monsters who resent that fact that you're in their dungeon and are trying to find and kill you (so kill them first as described in the section called “Combat”

@

You, the hero of the game.

(

Weaponry, to aid you in your quest

[

Armor, to protect you during your journey

?

Scrolls with arcane magic inscribed upon them. Reading them can product a variety of effects.

Two other parts of the screen need to be gone over. First, the top line of the screen is the message line, in which messages from the game to you are displayed. (If there's a --More-- at the end of the message, hit Space for more information). Also, on the right, you see the status window. In the status window, you see your stats, hit points, and other information (see the section called “Statistics”

Controls

In this document, if you see keystrokes of the form something/something or something/something/something, that means any of those keystrokes will work. Also Alt+key and Ctrl+key means to hold the Alt of Control key and press the key indicated, then release both keys. Windows users, hoverer, should press Escape, release it, and then press the given key instead of Alt+key. Lastly, @+key means press @ release it and then hit key

Also, if you accidentally press Escape or @, press that key again to get back to the game. Also, pressing Escape when a game is waiting for input will probably cancel the action, after a few seconds, tops.

Moving Around

These are the controls for Menace of the Mines

h/4/left arrow key

Move your character left

j/2/down arrow key

Move your character down

k/8/up arrow key

Move your character up

l/6/right arrow key

Move your character right

y/7

Move your character northwest

u/9

Move your character northeast

b/1

Move your character southwest

n/3

Move your character southeast

o

Open a door. This prompts for the direction of the door.

c

Close a door. This prompts for the direction of the door.

O

Open a door and keep trying to open the door until the door is open. This prompts for the direction of the door.

Inventory controls

,

Pick up an object from the ground.

d

Remove an object from your inventory and drop it on the ground.

i

Display all the items in your inventory.

E

Display all the equipment you have on.

w

Wield a weapon. This prompts you the weapon to wield.

W

Wear a piece of armor. This prompts you the armor to wear.

T

Take off equipment, either weapons or armor.

r

Read a scroll. This will prompt you for a scroll to read and use up the scroll.

Miscellaneous controls

+

Increase your speed, making you able to preform actions quicker.

-

Decrease your speed, making you less able preform actions quickly.

S

Save the game, leaving your character in the place it was the next time you start.

Q

Quit the game, discarding your save.

f

Zap a monster, hitting it with a ranged attack and using 1 ammo. This prompts for a target using targeting mode.

H

View the high score list.

Cntl+r

Go to replay mode, where you can see the outcomes of previous games.

?

Activate the in-game help system. This will invoke a help-viewing program appropriate for your platform (info on UNIX, HTML help on windows) with this manual.

Alt+d

Activate debug mode, which displays a bunch of developer-specific information

@+e

Evaluate an arbitrary lisp expression. Coders only.

Opening doors

When opening or closing doors, the directional movement keys outlined in the the section called “Moving Around” controls serve as answers the question In what direction

Targeting

Targeting has a simple three-key structure

+

Go to the next monster

-

Go to the previous monster

f/Space/Return

Select the monster currently selected, as shown in the message area and by the flashing cursor above it.

Gameplay

Combat

So, a big scary monster is coming after you, and you need to kill them. What do you do? Well, there are two options. First, if you're brave enough, trying to move into a monster (using the movement keys from the section called “Controls” will trigger hand-to-hand combat. If you still have zaps left, you can zap the opposing monster from afar using the z key and the controls from the section called “Targeting”. The eventual goal of combat is to reduce your opponent to 0 HP. When a monster (or you) hits 0 HP, they die. When you die, the game ends.

Statistics

Your character, has 6 essential attributes, or stats. There are: Strength (Str), Dexterity (Dex), Constitution (Con), Intelligence (Int), Wisdom (Wis), and Saves. The exact purpose of these attributes has not been determined, but they do count for something,

Also, your character has three other characteristics. Hit points (HP), show how much life your character has left. When they reach 0, you die and the game is over.

Blessings and Curses

In Menace of the Mines, there are 7 degrees of blessedness or accursedness in which your items may be. If an item is blessed, it confers minor additional benefits to the user, BLESSED items bring greater benefits and *BLESSED* items, though extremely rare, can do almost anything except bring you back from the dead. Similarly, if an item is cursed, it causes minor complications for the user, CURSED items cause greater suffering and *CURSED* items, though extremely rare, will do anything in their considerable power to hurt you.

Chapter 4. Developer documentation

There isn't any, but I'll write some if you ask on the mailing list