Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.73 KB

README.md

File metadata and controls

46 lines (31 loc) · 1.73 KB

Python Roguelike Framework Build Status Documentation Status

>>>>> WARNING This is a Alpha release. WARNING <<<<<

Version: 2.0.0a

Online Documentation: http://python-roguelike-framework.readthedocs.io/en/latest/

Description

A Python framework for developing Roguelikes. It is built using the TDL library which is a port of the c/c++ libtcod library.

Installation

Git

git clone https://github.com/jpalladino84/roguelike-game.git

cd roguelike-game

pip install -r requirements.txt

Running

The framework starts with 5 levels for you to play around with. Run the game with:

python3.5 run.py

Configure

The true power of this framework is the ability to configure the game to your liking.

Contributing

Contributions are welcomed!

Keep in mind when contributing that the goal of this framework is that it should be easy to use and configure for newcomers, but also powerful for advanced users.

  • Features should be well documented

Further Reading

There is some boiler plate code from the Roguebasin's libtcod tutorial which I had to adapt to fit with the TDL library.

Good read on dungeon generation: http://journal.stuffwithstuff.com/2014/12/21/rooms-and-mazes/