README.md

Arena

Multiplayer 2D physics engine, matchmaking, market and leaderboard for 2D and 3D Games. Developed in Elixir for communication and Rust for the physics engine.

Table of Contents

• Arena
  • Table of Contents
  • Documentation
  • Running the Backend
    • Requirements
  • Contributing

Documentation

⚠️ Disclaimer ⚠️

We are currently working on a new version of the backend. The following documentation corresponds to a previous one, that can be found in the old branch.

You can find our documentation in docs folder, or run it locally.

To run locally, install:

cargo install mdbook
cargo install mdbook-mermaid

Then run:

make docs

Open: http://localhost:3000/

Collition Detection

You can find our documentation about this topic here.

Running the Backend

Requirements

• Rust >= 1.72.0
• Erlang OTP >= 26
• Elixir >= 1.15.4
• Docker and docker compose
• inotify-utils if using Linux (optional, for development live reload)

Ensure Docker is running and then...

Install protobuf dependency:

• brew install protobuf (MacOS)
• mix escript.install hex protobuf

Start phoenix server using:

• make deps
• make start

Contributing