smith

README

smith

An ordinary guy in a not so ordinary world

smith is a simple 2D game written in Go and ebiten.

development

Currently, this game is just being written for fun. There are no direct goals with the development, but I do hope to have something resembling a finished product at some point.

Simple checklist

These are items that have been thought of but not necessarily required or fully realised. They are subject to change.

• Sprites
• Animations
• Health
• Death
• Saving
• Map loading
• Map editor
• Enemies
• Checkpoints
• Inventory
• Title screen
• Interactive environment
• Something resembling a story

Documentation

Index

• Constants
• Variables
• type Game
  • func NewGame(options WindowOptions) *Game
  • func (g *Game) Layout(outsideWidth, outsideHeight int) (int, int)
  • func (i Game) String() string
  • func (g *Game) Update(screen *ebiten.Image) error
• type WindowOptions

Constants

const (
	SpriteSize int = 10
)

Variables

var (
	//go:embed assets/smith.png
	PlayerSprite []byte

	//go:embed assets/heart.png
	HeartSprite []byte

	//go:embed assets/world.png
	WorldSprite []byte

	//go:embed assets/world.json
	WorldRawData []byte
)

Types

type Game

type Game struct {
	// contains filtered or unexported fields
}

func NewGame

func NewGame(options WindowOptions) *Game

func (*Game) Layout

func (g *Game) Layout(outsideWidth, outsideHeight int) (int, int)

func (Game) String

func (i Game) String() string

func (*Game) Update

func (g *Game) Update(screen *ebiten.Image) error

type WindowOptions

type WindowOptions struct {
	Scale int
}