Mogru

A text-based roguelike game written in Python 3 using python-tcod.
Explore the docs »

Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

A text-based roguelike game written in Python 3 using TCOD. Starting from a simple initial framework, it will be the basis for experiments in procedural generation of game elements and artificial intelligence.

Built With

• python-tcod
• SDL2
• numpy

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• SDL2: Install per your OS instructions. For most Linux distros, SDL2 is available as a package.

• python-tcod

pip install --user tcod

• numpy

pip install --user numpy

The project also includes a requirements.txt file to install all Python dependencies. To use that instead, run from the root of the repo:

pip install -r requirements.txt

Installation

There is no installation process at the moment. Clone the repo using the command below.

git clone https://github.com/bigangryguy/mogru.git

Usage

Mogru can be run from a command line. In the src folder of the repo, run:

python main.py

Playing

As with most text-based roguelikes, the player is represented as @ on the dungeon map.

Navigation of the map uses these keys:

• Left arrow, H, numpad 4: move left
• Right arrow, L, numpad 6: move right
• Up arrow, K, numpad 8: move up
• Down arrow, J, numpad 2: move down
• Home, Y, numpad 7: move up/left
• Page Up, U, numpad 9: move up/right
• End, B, numpad 1: move down/left
• Page Down, N, numpad 3: move down/right

Pressing . or numpad 5 skips your turn.

Pressing g picks up an item. Press i to open your inventory to use an item and press d to open your inventory to drop an item. While in your inventory, press the a to z keys to use the corresponding item or press any other key (or mouse click) to exit the inventory.

Press c to open the character information panel. Press any to close the panel.

Pressing Esc quits the game immediately.

Moving into enemies attacks them. They will attack you. The message log will display the results of your attacks and the enemy's attacks. To see a larger view of the message log, press V. You can use the up arrow, down arrow, page up, and page down keys to navigate the larger message log view. Press any other key to return to the main game screen.

Hovering your mouse pointer over something will display the name of that thing above your message log.

Roadmap

• Expand beyond the initial tutorial project
• Add custom tilesets
• Improve the map generator
• Add more items, monsters, etc.

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU General Public License V3.0. See COPYING for more information.

Contact

David Wilcox - @davidtwilcox - david@dtwil.co

Project Link: https://github.com/bigangryguy/mogru

Acknowledgements

• Yet Another Roguelike Tutorial - Written in Python 3 and TCOD