Skip to content

K-mohameduuu/DeckBuilderRoguelikeEngine

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 

Repository files navigation

DeckBuilder Roguelike Engine 🎮🃏

DeckBuilder Logo GitHub Release

Welcome to the DeckBuilder Roguelike Engine! This repository serves as a structural playground for creating roguelike card battle systems. If you are passionate about game development and enjoy building unique gaming experiences, you've come to the right place!

Table of Contents

Introduction

The DeckBuilder Roguelike Engine provides a flexible framework for developers interested in creating card-based games with roguelike elements. Whether you are a seasoned developer or just starting, this engine allows you to explore and implement various mechanics in a straightforward manner.

Features

  • Modular Architecture: Easily add or modify game components.
  • Turn-Based Mechanics: Implement strategic gameplay with turn-based systems.
  • Card System: Create and manage unique cards with diverse abilities.
  • Roguelike Elements: Integrate procedurally generated levels and permadeath features.
  • Unity Integration: Built on Unity, ensuring compatibility with a wide range of platforms.
  • Open Source: Contribute and customize the engine to suit your needs.

Getting Started

To get started with the DeckBuilder Roguelike Engine, follow these steps:

  1. Download the latest version from the Releases section. You will need to download and execute the appropriate files to get started.
  2. Install Unity: Make sure you have Unity installed on your machine. You can download it from the Unity website.
  3. Open the Project: Once downloaded, open the project in Unity.
  4. Explore the Documentation: Familiarize yourself with the engine's features and capabilities.

How to Use

Using the DeckBuilder Roguelike Engine is straightforward. Here’s a brief overview of how to implement your first card game:

Step 1: Set Up Your Game

  • Create a new scene in Unity.
  • Use the provided prefabs to set up your game environment.
  • Customize the UI to fit your theme.

Step 2: Create Cards

  • Navigate to the Cards folder in the project.
  • Create new card scripts that define card properties and behaviors.
  • Use the card editor to visually design your cards.

Step 3: Implement Game Mechanics

  • Utilize the engine’s built-in systems for turn management and combat.
  • Adjust parameters in the GameManager to set game rules.
  • Test your game mechanics in the Unity editor.

Step 4: Playtest

  • Use Unity’s play mode to test your game.
  • Gather feedback and iterate on your design.

Step 5: Publish Your Game

  • Once satisfied with your game, you can build it for your desired platform using Unity's build settings.

Contributing

We welcome contributions from everyone! If you would like to contribute to the DeckBuilder Roguelike Engine, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with clear messages.
  4. Push your changes to your forked repository.
  5. Submit a pull request for review.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Contact

For questions, suggestions, or collaboration opportunities, feel free to reach out:

Additional Resources

  • Check the Releases section for the latest updates and downloadable content.
  • Join our community discussions and share your experiences in developing with the engine.

Thank you for your interest in the DeckBuilder Roguelike Engine! We hope you enjoy building your own card games and roguelike adventures. Happy coding!