Awesome

Oak

A Pure Go game engine

Table of Contents

1. Installation

2. Features

3. Support

4. Quick Start

5. Examples

6. Finished Games

Installation <a name="installation"/>

go get -u github.com/oakmound/oak/v4

Features and Systems <a name="features"></a>

1. Window Management
   • Windows and key events forked from shiny
   • Support for multiple windows running at the same time
2. Image Rendering
   • Manipulation
     • render.Modifiable interface
     • Integrated with optimized image manipulation via gift
   • Built in Renderable types covering common use cases
     • Sprite, Sequence, Switch, Composite
     • Primitive builders, ColorBox, Line, Bezier
     • History-tracking Reverting
   • Primarily 2D
3. Particle System
4. Mouse Handling
5. Joystick Support
6. Audio Support
7. Collision
   • Collision R-Tree forked from rtreego
   • 2D Raycasting
   • Collision Spaces
     • Attachable to Objects
     • Auto React to collisions through events
8. 2D Physics System
9. Event Handler

Support <a name="support"></a>

For discussions not significant enough to be an Issue or PR, feel free to ping us in the #oak channel on the gophers slack. For insight into what is happening in oak see the blog.

Quick Start <a name="quick-start"></a>

This is an example of the most basic oak program:

package main

import (
    "github.com/oakmound/oak/v4"
    "github.com/oakmound/oak/v4/scene"
)

func main() {
    oak.AddScene("firstScene", scene.Scene{
        Start: func(*scene.Context) {
            // ... draw entities, bind callbacks ... 
        }, 
    })
    oak.Init("firstScene")
}

See below or navigate to the examples folder for demos. For more examples and documentation checkout godoc for reference documentation, the wiki, or our extended features in grove.

Examples <a name="examples"></a>

Games using Oak <a name="finished-games"></a>

To kick off a larger game project you can get started with game-template.

On Pure Go <a name="pure-go"/>

Oak has recently brought in dependencies that include C code, but we still describe the engine as a Pure Go engine, which at face value seems contradictory. Oak's goal is that, by default, a user can pull down the engine and create a fully functional game or GUI application on a machine with no C compiler installed, so when we say Pure Go we mean that, by default, the library is configured so no C compilation is required, and that no major features are locked behind C compliation.

We anticipate in the immediate future needing to introduce alternate drivers that include C dependencies for performance improvements in some scasenarios, and currently we have no OSX solution that lacks objective C code.