Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ProjNull/TAEngine

TAEngine - A text adventure engine, where you write your games in JSON.
https://github.com/ProjNull/TAEngine

text-adventure text-adventure-engine

Last synced: about 2 months ago
JSON representation

TAEngine - A text adventure engine, where you write your games in JSON.

Host: GitHub
URL: https://github.com/ProjNull/TAEngine
Owner: ProjNull
License: mit
Created: 2023-05-19T08:06:59.000Z (over 1 year ago)
Default Branch: master
Last Pushed: 2023-05-26T08:04:52.000Z (over 1 year ago)
Last Synced: 2024-04-20T19:59:08.488Z (5 months ago)
Topics: text-adventure, text-adventure-engine
Language: Python
Homepage:
Size: 114 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]






  

    

  

TAEngine


  


    A text adventure engine, where you write your games in JSON.

    


    Explore source »

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Usage

    Roadmap

    Contributing

    License

    Contact

    Acknowledgments

  


## About The Project

![TAEngine][product-screenshot]'

A simple text adventure engine, written in python. It was written as part of our 19th of May Programming & IT Applications conjoined lesson.

You write adventures in JSON and rename the extension to .taj

(back to top)


### Built With

- [![Python][python.org]][python-url]

(back to top)


## Getting Started

This is an example of how you may give instructions on setting up your project locally.

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

### Prerequisites

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

- pip

  ```sh

  pip install --upgrade pip

  ```

### Installation

1. Clone the repo

   ```sh

   git clone https://github.com/ProjNull/n_sorrow_lyra.git

   ```

2. Install pip packages

   ```sh

   pip install json

   ```

3. Run the game

   ```sh

   python app/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](https://example.com)_

(back to top)


## Roadmap

- [x] UI

- [x] Game Loader

- [x] Fallback (Exception handling)

See the [open issues](https://github.com/ProjNull/n_sorrow_lyra/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

HyScript7 @ Mobilex1122 - [@null](https://twitter.com/null) - [email protected]

Project Link: [https://github.com/ProjNull/n_sorrow_lyra](https://github.com/ProjNull/n_sorrow_lyra)

(back to top)


## Acknowledgments

* [README Template](https://github.com/othneildrew/Best-README-Template/)

* [Shields.io](https://shields.io/)

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/ProjNull/n_sorrow_lyra.svg?style=for-the-badge

[contributors-url]: https://github.com/ProjNull/n_sorrow_lyra/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/ProjNull/n_sorrow_lyra.svg?style=for-the-badge

[forks-url]: https://github.com/ProjNull/n_sorrow_lyra/network/members

[stars-shield]: https://img.shields.io/github/stars/ProjNull/n_sorrow_lyra.svg?style=for-the-badge

[stars-url]: https://github.com/ProjNull/n_sorrow_lyra/stargazers

[issues-shield]: https://img.shields.io/github/issues/ProjNull/n_sorrow_lyra.svg?style=for-the-badge

[issues-url]: https://github.com/ProjNull/n_sorrow_lyra/issues

[license-shield]: https://img.shields.io/github/license/ProjNull/n_sorrow_lyra.svg?style=for-the-badge

[license-url]: https://github.com/ProjNull/n_sorrow_lyra/blob/master/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://linkedin.com/in/linkedin_username

[product-screenshot]: images/screenshot.png

[python.org]: https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54

[Python-url]: https://python.org/