Skip to content

ProblematicToucan/Eternity-Saga-Monogame

Repository files navigation

Eternity Saga 2D RPG

Overview

Eternity Saga is a 2D RPG game developed using the Monogame framework and the Nez library. It offers an immersive gameplay experience with captivating visuals and an engaging storyline. This README file provides essential information to get started with the project.

Table of Contents

Getting Started

Prerequisites

To run this project, you need to have the following framework or repository cloned on your local machine:

Installation

  1. Clone this repository to your local machine or download the ZIP file.
  2. Open the project in your preferred IDE.
  3. Clone Nez repository and fix/link Nez project with this EternitySaga project.
  4. Build the solution to ensure all dependencies are resolved.

Project Structure

The project follows a structured organization to maintain code readability and scalability. Here is an overview of the project structure:

├── Content
│   ├── Fonts
│   ├── Images
│   ├── Sounds
│   └── Tilemap
├── Source
│   ├── Components
│   ├── Entities
│   ├── Systems
│   └── Utility
├── .gitignore
├── EternitySaga.csproj
├── EternitySaga.sln
├── Icon.bmp
├── Icon.ico
├── LICENSE
├── Program.cs
└── README.md
  • Content: Contains the game's assets, such as tilemap, fonts, images, and sounds.
  • Source: Contains the source code of the game, organized into various folders:
    • Components: Contains reusable components used in entity systems.
    • Entities: Contains the game entities, each representing an interactive object in the game.
    • Systems: Contains the systems responsible for controlling the game logic and behavior.
    • Utility: Contains utility classes and helper functions used throughout the project.

Usage

To run the game, follow these steps:

  1. Build the project to ensure all necessary files are generated.
  2. Run the compiled executable or start the game from your IDE.
  3. Use the keyboard or gamepad controls to navigate through the game and interact with various objects and characters.

Contributing

Contributions to the Eternity Saga project are welcome! If you find any issues or have suggestions for improvement, please open an issue on the GitHub repository. Feel free to fork the repository and submit pull requests to contribute code changes.

License

This project is licensed under the MIT License.

Contact

For any inquiries or feedback, you can reach out to the author:

Author: Gamal Abdul Aziz Email: gamal.aziz1000@gmail.com

Feel free to contact me for any further assistance or questions related to the project.