DeathTrap Dungeon

An action-packed text adventure game built in Python.
Explore the docs »

Test the Latest Beta · Report Bug · Request Feature

Table of Contents

1. About DeathTrap Dungeon
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About DeathTrap Dungeon

Welcome to the DeathTrap Dungeon repo on GitHub! DeathTrap Dungeon is a text adventure game that incorporates elements of puzzle solving, exploration, battles, and strategy.

(back to top)

Built With

• 

(back to top)

Getting Started

To get DeathTrap Dungeon up and running, follow these simple steps:

Prerequisites

DeathTrap Dungeon uses mostly Python builtin modules and works without any extra dependencies having to be installed. However, in order to unlock extra functionality, you can install the Pygame module.

• Pygame

  pip3 install pygame

Installation

1. Clone the repo

   git clone https://github.com/mlaude545/DeathTrap-Dungeon.git

2. (Optional) install Pygame

   pip3 install pygame

3. Make the game executable

   chmod u+x main.py

4. Run the game

   ./main.py

(back to top)

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

(back to top)

Roadmap

• Finish DTD v3.0.0 development.
• Release DTD v3.0.0.
• Provide ongoing feature updates and patches.
  • Watch this space for updates once DTD v3.0.0 has been released!

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

(back to top)

Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Reuben Parfrey - reubenparfrey@gmail.com

Project Link: https://github.com/mlaude545/DeathTrap-Dungeon

(back to top)

Acknowledgments

• Othnieldrew for providing this awesome template!! Check it out here: https://github.com/othneildrew/Best-README-Template
• Charly Sly for the huge amount of help during development - https://github.com/magenta808/

(back to top)