yaq

README

yaq

A terminal game engine for learning programming, inspired by spx.

Features

• Develop games with only config files
• Play games with users' inputted code

Install

go install github.com/zrcoder/yaq/cmd/yaq@latest

Usage

The first thing is defining your game with toml files.

mygame-dir
├── Scene1
│   └── index.toml
├── Scene2
│   ├── Level1.toml
│   ├── Level2.toml
│   └── index.toml
└── index.toml

Run the game

cd mygame-dir
yaq

Games powered by yaq

• yaqs

Documentation

Index

• func Register(mode string, g Game)
• func Run(path string)
• type Base
  • func (b *Base) ErrorView(msg string) string
  • func (b *Base) Init(data []byte)
  • func (b *Base) KeysView() string
  • func (b *Base) SucceedView(msg string) string
• type Game
  • func Get(mode string) (Game, error)
• type KeyMap
  • func (k KeyMap) FullHelp() [][]key.Binding
  • func (k KeyMap) ShortHelp() []key.Binding

Functions

func Register

func Register(mode string, g Game)

func Run

func Run(path string)

Types

type Base

type Base struct {
	Editor    textarea.Model
	CfgPath   string
	Name      string `toml:"name"`
	Mode      string `toml:"mode"`
	IndexData []byte
	Rows      int `toml:"rows"`
	Columns   int `toml:"columns"`
	Keys      KeyMap
	KeysHelp  help.Model
}

func (*Base) ErrorView

func (b *Base) ErrorView(msg string) string

func (*Base) Init

func (b *Base) Init(data []byte)

func (*Base) KeysView

func (b *Base) KeysView() string

func (*Base) SucceedView

func (b *Base) SucceedView(msg string) string

type Game

type Game interface {
	SetBase(*Base)
	Run()
}

func Get

func Get(mode string) (Game, error)

type KeyMap

type KeyMap struct {
	Quit key.Binding
	Run  key.Binding
}

func (KeyMap) FullHelp

func (k KeyMap) FullHelp() [][]key.Binding

func (KeyMap) ShortHelp

func (k KeyMap) ShortHelp() []key.Binding