/WhiteStar-UML

The project develops a complex, interactive adventure game set in a mythical underground library where players control monks searching for the Holy Grail.

Underground Library Adventure Game

Overview

This repository hosts the comprehensive documentation and UML diagrams for the Underground Library Adventure Game, a strategic and interactive simulation where players guide monks on a quest to locate the Holy Grail within a sprawling underground library. The project is part of a software engineering course assignment by Artem Kopach, known by Neptun code JQBOLI. The repository includes a full suite of use cases, class diagrams, and descriptions necessary for understanding and potentially developing the game based on the provided models.

Repository Contents

  • Documentation (.pdf): Detailed game rules, functionalities, and system requirements.
  • WhiteStarUML Files: Diagram files that can be opened with WhiteStarUML software to view the detailed UML diagrams including class diagrams, sequence diagrams, and state machine diagrams.

Viewing the Documentation

To view the documentation and UML diagrams:

  • Microsoft Word Documents: Ensure you have Microsoft Word installed or any compatible word processor that supports .docx files.
  • WhiteStarUML Diagrams:
    • Download and install WhiteStarUML from WhiteStarUML Official Website.
    • Open the UML diagram files using WhiteStarUML to view and interact with the diagrams.

Game Description

The game features a complex environment with multiple types of rooms, interactive elements, and dynamic obstacles:

  • Monks navigate through rooms, collect up to five types of relics including the Holy Grail, and avoid or combat daemons using special relics.
  • Rooms vary in function and capacity, affecting gameplay with specific traits such as poison, disappearing doors, or daemon transferring capabilities.

UML Diagrams

The UML diagrams provide a structured visual representation of the system’s architecture and behavior:

  • Class Diagrams outline the classes involved in the game along with their attributes and methods.
  • Sequence Diagrams depict the interactions between objects over time, providing insight into the flow of gameplay and events.
  • State Machine Diagrams show the states and transitions of game elements, particularly focusing on the lifecycle of monks and game-winning conditions.

Contributing

Contributions to the documentation or diagrams are welcome! Please follow these steps:

  1. Fork the repository.
  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.

Contact

For any queries or further information, please contact:

Artem Kopach - koapch.artem@edu.bme.hu Project Link: https://github.com/kopach-artem/SE-UML

This README provides all necessary instructions and information for engaging with the documentation and diagrams provided in the repository, ensuring clarity and accessibility for users interested in the game's design and mechanics.