frontend

Documentation

Overview

Package frontend contains the HTTP endpoints for delivering the official web client. In order to register the endpoints you have to call SetupRoutes.

Index

• func SetupRoutes()
• type BasePageConfig
• type LobbyCreatePageData

Functions

func SetupRoutes

func SetupRoutes()

SetupRoutes registers the official webclient endpoints with the http package.

Types

type BasePageConfig

type BasePageConfig struct {
	// RootPath is the path directly after the domain and before the
	// scribble.rs paths. For example if you host scribblers on painting.com
	// but already host a different website, then your API paths might have to
	// look like this: painting.com/scribblers/v1.
	RootPath string `json:"rootPath"`
}

BasePageConfig is data that all pages require to function correctly, no matter whether error page or lobby page.

type LobbyCreatePageData

type LobbyCreatePageData struct {
	*BasePageConfig
	*game.SettingBounds
	Translation       translations.Translation
	Locale            string
	Errors            []string
	Languages         map[string]string
	Public            string
	DrawingTime       string
	Rounds            string
	MaxPlayers        string
	CustomWords       string
	CustomWordsChance string
	ClientsPerIPLimit string
	EnableVotekick    string
	Language          string
}

LobbyCreatePageData defines all non-static data for the lobby create page.