amore

README

Amore

A game library for Go, inspired by Love 2D. Currently in Beta. This is a hobby library and support should not be expected.

Objectives

• Enable making games easy, fast and fun
• Making games portable
• Single executable deployment strategy.

Aimed Platform Support:

• OS X
• Linux
• Windows
• iOS
• Android

Installation

Install the amore package by running the go get command

go get -u github.com/tanema/amore/...

Requirements

Amore requires SDL2 to operate on PC. You can install it by doing the following.

Ubuntu 14.04 and above, type: apt-get install libsdl2-dev

Fedora 20 and above, type: yum install SDL2-devel

Arch Linux, type: pacman -S sdl2

Mac OS X, via Homebrew: brew install sdl2

Windows, via Msys2: pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-SDL2

Amore Command

Install the command line helper with the go install tool

go install github.com/tanema/amore/cmd

• amore new will generate initial files for a game in the current folder
• amore bundle will generate a file called asset_bundle.go with all the assets and config in ziped byte array to be included in the binary

Example

See more examples at github.com/tanema/amore-examples

// Basic hello world program
package main

import (
  "github.com/tanema/amore"
  "github.com/tanema/amore/gfx"
)

func main() {
  amore.Start(update, draw)
}

func update(deltaTime float32) {
}

func draw() {
  gfx.Print("Hello World",50, 50)
}

TODO

• font rendering, especially spacing is bad
• audio seeking broken
• use runtime.SetFinalizer to release assets so that the develop does not have to manage volatiles.

Documentation

Overview

The base amore package is simply for stopping and starting your game. It will also automatically lock the os thread and set the application to use all available cpus.

Index

• Variables
• func Quit()
• func Start(update func(float32), draw func()) error

Variables

var OnLoad func()

OnLoad will be called after the context is all setup but before the game loop has started. This is a good time to get information like screen size from the window and setup environment. Set this variable with amore.OnLoad = func() {}

Functions

func Quit

func Quit()

Quit will prepare the window to close at the end of the next game loop. This will allow a nice clean destruction of all object that are allocated in OpenGL, SDL, and OpenAl

func Start

func Start(update func(float32), draw func()) error

Start creates a window and context for the game to run on and runs the game loop. As such this function should be put as the last call in your main function. update and draw will be called synchronously because calls to OpenGL that are not on the main thread will crash your program.