Curse of Mirra

Table of Contents

• Curse of Mirra
  • Table of Contents
  • About
  • Licensing
  • Requirements
  • Suggested Development Environment
  • Project and Unity Setup
  • Running the Backend
  • Documentation
  • Contact and Socials

About

Welcome to the realm of Curse of Mirra, crafted by LambdaClass.

Curse of Mirra is the inaugural game built on our groundbreaking Game Backend. This open source backend, meticulously developed by Lambda, ensures seamless and reliable gameplay.

Step into a universe where the destinies of heroes from four planets collide in an epic struggle for the favor of Mirra, a capricious deity known for manipulating entire societies by exploiting their deepest desires. Brace yourself for an immersive journey where every decision matters, and the pursuit of victory comes with the ever-present thrill of unpredictability.

Curse of Mirra is more than a game; it's an adventure into a world where strategy, skill, and a dash of chaos converge. Join the battle and confront the challenges that lie ahead in this captivating and dynamic gaming experience. The stage is set, and the Curse of Mirra awaits—embrace the challenge and become a legend!

Licensing

The code is licensed under the Apache 2 license, while the music and graphics are licensed under a CC attribution and share-alike license.

Find our open source 3D models, concept art, music, lore and more in our Curse of Mirra Open Game Assets repository.

Requirements

Ensure you have the following dependencies installed:

• Rust:
  • Install Rust
• Elixir and Erlang:
  • Install Elixir using ASDF
  • Erlang/OTP 26
  • Elixir 1.15.4
• Unity:
  • Download Unity
• Docker

Suggested Development Environment

Set up your environment with the following steps:

• Download the .NET SDK and Mono for your operating system.
• In Unity preferences, under "External Tools", check the following preferences:
  • Embedded packages
  • Local packages
  • Registry packages
  • Git packages
  • Built-in packages
• In VSCode, download the C# Dev Kit extension.

Your code should now autocomplete.

Project and Unity Setup

• Open a terminal and clone the project:

git clone https://github.com/lambdaclass/curse_of_mirra

• In Unity Hub, click on the add project button and select the curse_of_mirra/client folder.
• Choose the correct editor version.
• Download the following libraries and include them in the Assets/ThirdParty folder:
  • Top Down Engine by More Mountains. You need to purchase the license to use it.
  • SineVFX. You need to purchase the license to use it.
  • JMO Assets.
  • Top-Down Dungeons.
• To test the game, select the scene in Assets/Scenes/TitleScreen and run it by clicking the play button.

Local Testing

For local testing, use the mirra backend. Ensure you have the required dependencies installed and run:

git clone https://github.com/lambdaclass/mirra_backend
devenv up

Remember to set localhost as the server in the client.

Documentation

Explore our documentation here or run it locally. To run locally, install:

cargo install mdbook
cargo install mdbook-mermaid

Then run:

make docs

Open: http://localhost:3000/

Some key documentation pages:

• Message protocol
• Android build
• IOs builds

Contact and Socials

If you have any questions, feedback, or comments:

• Email: gamedev@lambdaclass.com

We share our development and creative process in the open, follow us for frequent updates on our game:

• Twitter: @CurseOfMirra
• Reddit: r/curseofmirra
• Discord: join link
• Telegram: t.me/curseofmirra