rpgmaker

Documentation

Index

• func DetectGameLocale(projectRoot string) string
• type Engine
  • func New() *Engine
  • func (e *Engine) AddGame(ctx context.Context, dir string) (*game.Game, error)
  • func (e *Engine) FollowGameText(ctx context.Context, g *game.Game, opts ...engine.FollowGameOptions) (chan engine.Line, error)
  • func (e *Engine) GetDefaultPlugin() string
  • func (e *Engine) GetFile(g *game.Game, file string) (*engine.EngineFileInfo, error)
  • func (e *Engine) GetTextractor(game *game.Game) *textractor.Client
  • func (e *Engine) InstallGame(dir string) (*game.Game, error)
  • func (e *Engine) InstallHook(ctx context.Context, g *game.Game) error
  • func (e *Engine) InstallTextHook(g *game.Game) error
  • func (e *Engine) IsDirEngine(dir string) bool
  • func (e *Engine) IsEngine(dir string) bool
  • func (e *Engine) ManagedGames() []*game.Game
  • func (e *Engine) Name() string
  • func (e *Engine) RunGame(ctx context.Context, g *game.Game) (*gr.Process, error)
  • func (e *Engine) SetCustomPlugin(data string) error
  • func (e *Engine) Shutdown() error
  • func (e *Engine) StopGame(ctx context.Context, proc *gr.Process) (*gr.Process, error)

Functions

func DetectGameLocale

func DetectGameLocale(projectRoot string) string

Types

type Engine

type Engine struct {
	PrefixRoot    string
	CurrentPlugin string
}

func New

func New() *Engine

New returns an RPG Maker engine installer with sane defaults. You can override fields directly if your caller already resolved runner/prefix.

func (*Engine) AddGame

func (e *Engine) AddGame(ctx context.Context, dir string) (*game.Game, error)

func (*Engine) FollowGameText

func (e *Engine) FollowGameText(ctx context.Context, g *game.Game, opts ...engine.FollowGameOptions) (chan engine.Line, error)

func (*Engine) GetDefaultPlugin

func (e *Engine) GetDefaultPlugin() string

func (*Engine) GetFile

func (e *Engine) GetFile(g *game.Game, file string) (*engine.EngineFileInfo, error)

func (*Engine) GetTextractor

func (e *Engine) GetTextractor(game *game.Game) *textractor.Client

func (*Engine) InstallGame

func (e *Engine) InstallGame(dir string) (*game.Game, error)

func (*Engine) InstallHook

func (e *Engine) InstallHook(ctx context.Context, g *game.Game) error

func (*Engine) InstallTextHook

func (e *Engine) InstallTextHook(g *game.Game) error

func (*Engine) IsDirEngine

func (e *Engine) IsDirEngine(dir string) bool

func (*Engine) IsEngine

func (e *Engine) IsEngine(dir string) bool

func (*Engine) ManagedGames

func (e *Engine) ManagedGames() []*game.Game

func (*Engine) Name

func (e *Engine) Name() string

func (*Engine) RunGame

func (e *Engine) RunGame(ctx context.Context, g *game.Game) (*gr.Process, error)

func (*Engine) SetCustomPlugin

func (e *Engine) SetCustomPlugin(data string) error

func (*Engine) Shutdown

func (e *Engine) Shutdown() error

func (*Engine) StopGame

func (e *Engine) StopGame(ctx context.Context, proc *gr.Process) (*gr.Process, error)