README

G3N Banner

Godoc Go Report Card

G3N - Go 3D Game Engine

G3N (pronounced "gen") is an OpenGL 3D Game Engine written in Go. It can be used to write cross-platform Go applications that show rich and dynamic 3D representations - not just games. A basic integrated GUI framework is provided, and 3D spatial audio is supported through OpenAL.

To see G3N in action try the G3N demo or the Gokoban award winning game.

G3ND In Action

Highlighted Projects

Gokoban - 3D Puzzle Game (1st place in the 2017 Gopher Game Jam)

Dependencies

Go 1.8+ is required. The engine also requires the system to have an OpenGL driver and a GCC-compatible C compiler.

On Unix-based systems the engine depends on some C libraries that can be installed using the appropriate distribution package manager. See below for OS specific requirements.

Ubuntu/Debian-like

$ sudo apt-get install xorg-dev libgl1-mesa-dev libopenal1 libopenal-dev libvorbis0a libvorbis-dev libvorbisfile3

Fedora

$ sudo dnf -y install xorg-x11-proto-devel mesa-libGL mesa-libGL-devel openal-soft openal-soft-devel libvorbis libvorbis-devel glfw-devel libXi-devel

CentOS 7

Enable the EPEL repository:

$ sudo yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

Then install the same packages as for Fedora - remember to use yum instead of dnf for the package installation command.

Windows

The necessary audio libraries sources and DLLs are supplied but they need to be installed manually. Please see Audio libraries for Windows for details. We tested the Windows build using the mingw-w64 toolchain (you can download this file in particular).

macOS

Install the development files of OpenAL and Vorbis using Homebrew:

brew install libvorbis openal-soft

Installation

The following command will download and install the engine along with all its Go dependencies:

go get -u github.com/g3n/engine/...

Features

  • Cross-platform: Windows, Linux, and macOS
  • Integrated GUI (graphical user interface) with many widgets
  • Hierarchical scene graph - nodes can contain other nodes
  • 3D spatial audio via OpenAL (.wav, .ogg)
  • Real-time lighting: ambient, directional, point, and spot lights
  • Physically-based rendering: fresnel reflectance, geometric occlusion, microfacet distribution
  • Model loaders: glTF (.gltf, .glb), Wavefront OBJ (.obj), and COLLADA (.dae)
  • Geometry generators: box, sphere, cylinder, torus, etc...
  • Geometries support morph targets and multimaterials
  • Support for animated sprites based on sprite sheets
  • Perspective and ortographic cameras
  • Text image generation and support for TrueType fonts
  • Image textures can be loaded from GIF, PNG or JPEG files
  • Animation framework for position, rotation, and scale of objects
  • Support for user-created GLSL shaders: vertex, fragment, and geometry shaders
  • Integrated basic physics engine (experimental/incomplete)
  • Support for HiDPI displays

G3N Banner

Hello G3N

The code below is a basic "hello world" application (hellog3n) that shows a blue torus. You can download and install hellog3n via:

go get -u github.com/g3n/demos/hellog3n

For more complex demos please see the G3N demo program.

package main

import (
    "github.com/g3n/engine/util/application"
    "github.com/g3n/engine/geometry"
    "github.com/g3n/engine/material"
    "github.com/g3n/engine/math32"
    "github.com/g3n/engine/graphic"
    "github.com/g3n/engine/light"
)

func main() {

    app, _ := application.Create(application.Options{
        Title:  "Hello G3N",
        Width:  800,
        Height: 600,
    })

    // Create a blue torus and add it to the scene
    geom := geometry.NewTorus(1, .4, 12, 32, math32.Pi*2)
    mat := material.NewPhong(math32.NewColor("DarkBlue"))
    torusMesh := graphic.NewMesh(geom, mat)
    app.Scene().Add(torusMesh)

    // Add lights to the scene
    ambientLight := light.NewAmbient(&math32.Color{1.0, 1.0, 1.0}, 0.8)
    app.Scene().Add(ambientLight)
    pointLight := light.NewPoint(&math32.Color{1, 1, 1}, 5.0)
    pointLight.SetPosition(1, 0, 2)
    app.Scene().Add(pointLight)

    // Add an axis helper to the scene
    axis := graphic.NewAxisHelper(0.5)
    app.Scene().Add(axis)

    app.CameraPersp().SetPosition(0, 0, 3)
    app.Run()
}

hellog3n Screenshot

Documentation

The complete engine API reference can be found here: GoDoc.

There is also the beginning of a Getting Started Guide, and a newly created list of Guides and Tutorials:

Along with those, a good way to learn how to use the engine is to see the source code of G3ND - the G3N demo.

Contributing

If you find a bug or create a new feature you are encouraged to send pull requests!

Community

Join our channel on Gophers Slack (Click here to register for Gophers Slack). It's a great way to have your questions answered quickly by the G3N community.

Expand ▾ Collapse ▴

Directories

Path Synopsis
animation Package animation
audio Package audio contains sub packages for binding to external audio libraries and implements a spatial audio player.
audio/al Package al implements the Go bindings of a subset of the functions of the OpenAL C library.
audio/ov Package ov implements the Go bindings of a subset of the functions of the Ogg Vorbis File C library.
audio/vorbis Package vorbis implements the Go bindings of a subset (only one function) of the functions of the libvorbis library See API reference at: https://xiph.org/vorbis/doc/libvorbis/reference.html
camera Package camera contains common camera types used for rendering 3D scenes.
camera/control Package control implements controllers for cameras
core Package core implements some basic types used by other packages.
experimental/collision Package collision implements collision related algorithms and data structures.
experimental/collision/shape
experimental/physics Package collision implements collision related algorithms and data structures.
experimental/physics/constraint Package constraint implements physics constraints.
experimental/physics/equation Package equation implements SPOOK equations based on the 2007 PhD thesis of Claude Lacoursière titled "Ghosts and Machines: Regularized Variational Methods for Interactive Simulations of Multibodies with Dry Frictional Contacts"
experimental/physics/object
experimental/physics/solver Package physics implements a basic physics engine.
geometry Package geometry implements several primitive geometry generators.
gls Package gls implements a loader of OpenGL functions for the platform and a Go binding for selected OpenGL functions.
gls/glapi2go
graphic Package graphic implements scene objects which have a graphic representation.
gui Package gui implements the GUI infraestructure and several widgets.
gui/assets Code generated by go-bindata.
gui/assets/icon
light Package light contains common light types which can be add to a 3D scene to illuminate it.
loader/collada Package collada
loader/gltf Package gltf
loader/obj Package obj is used to parse the Wavefront OBJ file format (*.obj), including associated materials (*.mtl).
material Package material contains several types of materials which can be used to set the appearance of graphic object
math32 Package math32 implements basic math functions which operate directly on float32 numbers without casting and contains types of common entities used in 3D Graphics such as vectors, matrices, quaternions and others.
renderer Package renderer implements the scene renderer.
renderer/shaders Package shaders contains the several shaders used by the engine
text Package text implements text font support.
texture Package texture contains several types of textures which can be added to materials.
tools/g3nicodes
tools/g3nshaders g3nshaders reads shaders files with ".glsl" extensions and generates a Go file containing strings with the content of these files.
util/application
util/logger Package logger implements an hierarchical logger used by other packages.
util/stats
window Package window abstracts the OpenGL Window manager Currently only "glfw" is supported