TextyDungeon

Explore the docs »

View Demo · Report Bug · Request Feature

A text rpg game engine using python and json

not worked on anymore feel free to use it and open an issue to show me what you made and if people seem interested i may continue this

Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

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

Getting Started

1. Install. pytest and textual

   pip install pytest textual

2. Clone the repo

   git clone https://github.com/dgsqf/TextyDungeon.git

3. cd into the directory

   cd TextyDungeon/src

4. Run this command to check if everything went correctly

   pytest -q

   if all test pass then you're good to go

(back to top)

Usage

you can move the src folder where you want it and when you want to play something just run

python main.py "{name of the json file}"

For more examples, please refer to the Documentation

(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

Contributing to the docs or fixing typoes are also greatly appreciated

(back to top)

License

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

(back to top)