Elixir middleware server designed for running games.
Game and engine agnostic, the library focuses on solving common issues.
Note: This README is for the unreleased main branch, please reference the official documentation on hexdocs for the latest stable release.
Feature highlights
- User authentication and authorization
- Tracking online users
- Lobby management
- Telemetry
- Community management tools
- Steam integration (planned)
Installation
First add to your dependencies in mix.exs.
def deps do
[
{:teiserver, "~> 0.0.2"}
]
end
Now add a migration
mix ecto.gen.migration add_teiserver_tables
Open the generated migration and add the below code:
defmodule MyApp.Repo.Migrations.AddTeiserverTables do
use Ecto.Migration
def up do
Teiserver.Migration.up()
end
# We specify `version: 1` in `down`, ensuring that we'll roll all the way back down if
# necessary, regardless of which version we've migrated `up` to.
def down do
Teiserver.Migration.down(version: 1)
end
end
Add this to your Application supervision tree:
children = [
{Teiserver, Application.get_env(:my_app, Teiserver)}
]