Skip to content

Teifion/teiserver

Repository files navigation

Elixir middleware server designed for running games.
Game, engine and platform agnostic, the library focuses on solving common requirements.

Hex Version   Hex Docs   Apache 2 License

Note: This README is for the unreleased master branch, please reference the official documentation on hexdocs for the latest stable release.

Feature highlights

  • User connectivity
  • User to User communications
  • Lobby system (planned)
  • Telemetry/Event logging (planned)
  • Community management tools (planned)
  • Steam integration (planned)

Installation

First add to your dependencies in mix.exs.

def deps do
  [
    {:teiserver, "~> 0.0.3"}
  ]
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)}
]

About

Elixir middleware server library

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages