teiserver

defmodule Teiserver do
  alias Teiserver.Helpers.PubSubHelper

  @type user_id :: non_neg_integer()
  @type lobby_id :: non_neg_integer()
  @type party_id :: non_neg_integer()

  @moduledoc """
  Teiserver is a middleware server library; designed for usage with games. Its role is to handle the common and game-agnostic issues (chat, searching for games, match history) while allowing you to implement the game-specific items you care about. Teiserver has generic handling for users, lobbies, chat and more.

  In a peer-to-peer setting each client will communicate to each other client as and when they need to. With a middleware server every client communicates via the middleware server and the server acts as a single source of truth.

  ```mermaid
  graph TD;
    srv{{Teiserver}};
    srv <--> User1;
    srv <--> User2;
    srv <--> User3;
    srv <--> User4;
    Host1 <--> srv;
    Host2 <--> srv;
    Bot1 <--> srv;
    Bot2 <--> srv;
  ```

  To use Teiserver you write an endpoint which your game connects to over a network. The endpoint handles the messages from client apps and makes calls to Teiserver; acting as wrapper around the Teiserver API.

  ## Main guides:
  - [Installation](guides/installation.md)
  - [Hello world](guides/hello_world.md)
  - [Program structure](guides/program_structure.md)
  - [Snippets](guides/snippets.md)

  ## Contexts
  These are the main modules you will be interacting with in Teiserver. They typically delegate all their functions to something more specific but the context module will be the preferred point of contact with the Teiserver library.

  Teiserver has some other publicly accessible functions for those who want to write more advanced or complex functionality but in theory everything you need should be accessible from the relevant context.

  ### Context overview
  - **Accounts**: Users
  - **Communication**: Chat
  - **Community**: Social interactions between players
  - **Connections**: User activity
  - **Game**: Game functionality (e.g. matchmaking)
  - **Lobby**: Game lobbies
  - **Logging**: Logging of events and numbers
  - **Moderation**: Handling disruptive users
  - **Settings**: Key-Value pairs for users and the system
  - **Telemetry**: Moment to moment events
  """

  @doc false
  @spec repo() :: Module
  def repo() do
    Application.get_env(:teiserver, :repo)
  end

  # PubSub delegation
  @doc false
  @spec broadcast(String.t(), map()) :: :ok
  defdelegate broadcast(channel, message), to: PubSubHelper
end