Skip to content

Commit

Permalink
Delete unnecessary dependencies and add useful information in README (#…
Browse files Browse the repository at this point in the history
…1819)

* Delete unnecessary dependencies and add useful information in README

* Rename .png files from curse to champions
  • Loading branch information
Nico-Sanchez committed Jun 6, 2024
1 parent e3db9fb commit 4c02415
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 21 deletions.
32 changes: 11 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,10 @@ Find our open source 3D models, concept art, music, lore and more in our [Curse

## Requirements

Ensure you have the following dependencies installed:

- **Rust:**
- **Rust:** _for docs_
- [Install Rust](https://www.rust-lang.org/tools/install)
- **Elixir and Erlang:**
- [Install Elixir using ASDF](https://thinkingelixir.com/install-elixir-using-asdf/)
- Erlang/OTP 26
- Elixir 1.15.4
- **Unity:**
- [Download Unity](https://unity.com/unity-hub)
- **Docker**
- **Unity Hub:**
- [Download Unity Hub](https://unity.com/unity-hub)

## Suggested Development Environment

Expand All @@ -76,8 +69,10 @@ Your code should now autocomplete.
git clone https://github.com/lambdaclass/champions_of_mirra
```

- In Unity Hub, click on the add project button and select the `champions_of_mirra/client` folder.
- Choose the correct editor version.
- 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:
- [Top Down Engine](https://assetstore.unity.com/packages/templates/systems/topdown-engine-89636) by [More Mountains](https://moremountains.com). You need to purchase the license to use it.
- [SineVFX](https://assetstore.unity.com/packages/vfx/particles/spells/top-down-effects-191455). You need to purchase the license to use it.
Expand All @@ -87,13 +82,8 @@ git clone https://github.com/lambdaclass/champions_of_mirra

## Local Testing

For local testing, use the [mirra backend](https://github.com/lambdaclass/mirra_backend). Ensure you have the required dependencies installed and run:

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

For local testing, use the [mirra backend](https://github.com/lambdaclass/mirra_backend).
Follow its README instructions to build and run the application.
Remember to set ```localhost``` as the server in the client.

## Documentation
Expand All @@ -116,8 +106,8 @@ Open: [http://localhost:3000/](http://localhost:3000/ios_builds.html)
Some key documentation pages:

- [Message protocol](https://docs.curseofmirra.com/message_protocol.html)
- [Android build](https://docs.curseofmirra.com/android_builds.html)
- [IOs builds](https://docs.curseofmirra.com/ios_builds.html)
- [Android builds](https://docs.curseofmirra.com/android_builds.html)
- [iOS builds](https://docs.curseofmirra.com/ios_builds.html)

## Contact and Socials

Expand Down

0 comments on commit 4c02415

Please sign in to comment.