Skip to content

lambdaclass/champions_of_mirra

Repository files navigation

Champions of Mirra

Table of Contents

About

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

Champions 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.

Champions 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 Champions of Mirra awaits—embrace the challenge and become a legend!

Muflus 3D model Uma 3D model
Shinko hero concept art Concept art for a gang member dog in the planet of Otobi

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

Suggested Development Environment

Set up your environment with the following steps:

  • Download the .NET SDK and Mono for your operating system.
  • In VSCode, download the C# Dev Kit extension.
    • You must go to the C# extension and set the version to v1.25.9 in order for it to work
  • In Unity preferences, under "External Tools",
    1. Set "Visual Studio Code" as the external script editor
    2. check the following preferences:
      • Embedded packages
      • Local packages
      • Registry packages
      • Git packages
      • Built-in packages
    3. Then click on "Regenerate project files"

Project and Unity Setup

  • Open a terminal and clone the project:
git clone https://github.com/lambdaclass/champions_of_mirra
  • Open Unity Hub, if this is your first launching the Hub, you can skip the unity editor installation.
  • Click on the add project button and select champions_of_mirra/client folder.
  • Install the Unity editor suggested version (not latest).
    • You can then install optional tools (Android SDK, iOS Build Support, etc.). None of them are mandatory.
  • Download the following libraries and include them in the Assets/ThirdParty folder:
  • 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. Follow its README instructions to build and run the application. 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:https://localhost:3000/

Some key documentation pages:

Contact and Socials

If you have any questions, feedback, or comments:

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