app

type App interface {
	AddPlugin(id string, plugin *Plugin) error
	DataDir(subdirs ...string) string
	NumPlugins() int
	Plugin(index int) *Plugin
	PluginID(index int) string
	NumModules() shared.ModuleIndex
	ModuleAt(index shared.ModuleIndex) *modules.Module
	ModuleID(index shared.ModuleIndex) string
	ModulePluginIndex(index shared.ModuleIndex) int
	ModuleFor(pluginID, moduleID string) shared.ModuleIndex
	// ServerContext builds a server.Context with the given moduleIndex.
	ServerContext(moduleIndex shared.ModuleIndex) server.Context
	GetResources(moduleIndex shared.ModuleIndex,
		index resources.CollectionIndex) []resources.Resource
	GetTextures() []resources.Resource
	Font(fontFamily int, style api.FontStyle, size api.FontSize) *ttf.Font
	NumFontFamilies() int
	FontNames() []string
	Messages() []shared.Message
	MessageSenderFor(index shared.ModuleIndex) server.MessageSender
}

type GroupTemplate struct {
	Name, Description string
	// YAML content of the configuration. The group name contained herein will
	// always be overridden when applying the template.
	Config []byte
	// list of scenes in this group.
	//
	// At least one scene index must be defined for any GroupTemplate.
	// The reference defines the name of the scene in this group.
	Scenes []SceneTmplRef
}

type Plugin struct {
	// Name contains the name of the plugin.
	Name string
	// Modules contains the list of modules provided by this plugin.
	Modules []*modules.Module
	// SystemTemplates defines templates for creating systems.
	// It should provide a template for each system ID that is referenced from a
	// template in GroupTemplates.
	SystemTemplates []SystemTemplate
	// GroupTemplates defines templates for creating groups.
	// It should only reference system IDs for which templates exist in
	// SystemTemplates.
	GroupTemplates []GroupTemplate
	// SceneTemplates defines templates for creating scenes.
	// These scenes can be referenced from GroupTemplates.
	SceneTemplates []SceneTemplate
}

type SceneTemplate struct {
	Name, Description string
	// YAML content of the configuration. The scene name contained herein will
	// always be overridden when applying the template.
	Config []byte
}

type SceneTmplRef struct {
	// The name this scene should have in the containing group
	Name string
	// index of the plugin defining the scene template
	PluginIndex int
	// index of the template referred to in its plugin's list of templates
	TmplIndex int
}

type SystemTemplate struct {
	// YAML content of the configuration. the contained name should be equivalent
	// to the Name field.
	Config []byte
	ID     string
	Name   string
}

type TooManyRequests struct {
}