GT

README

GT

Summary

Game Toolkit

Getting Started

The current installation procedure:

• Install Go and configure your workspace

• Windows Only: Install MinGW (64 bit) using Win-builds

  • needed for 64 bit gcc
  • ensure that your path is updated with the bin contents after installing

• Clone this repo in your $GOPATH/src directory

• Install some Go dependancies (may need less depending on your go set-up):

  • go get github.com/go-gl/gl/v3.2-core/gl
  • go get github.com/go-gl/mathgl/mgl32
  • go get github.com/golang/freetype/truetype
  • go get github.com/veandco/go-sdl2/sdl

• Validate the install

  • Navigate to $GOPATH/src/GT/Examples
  • go run SimpleWindow.go -Assets "../Assets"
  • Close the Window or press 'Escape'

Installation Troubleshooting

If you encounter any issues after / during installation check out these pointers:

• It is important to have the 64 bit version of MinGW installed for Windows developers
• Ensure that all go dependencies have been resolved
• This engine uses OpenGL and SDL, so updated graphics drivers may be necessary
  • Because of this, running this engine within a virtual machine could be difficult
• Sometimes Debian/Ubuntu install opengl (libGL.so.x.x) libraries in the wrong format and go-gl cannot find them. Need to symlink libGL.so.x.x to libGL.so in /usr/lib or where ever your libraries are located.

Other Notes

We will likely have Travis CI set up at some point for builds and will include MinGW dlls and whatnot. So hopefully the installation process will require less work on the user's end.

We also plan to make dev installation as easy as "go get github.com/Triangle345/GT" but at the moment the project needs to be cloned (or download the zip)

Documentation

Index

• Variables
• func EngineStart()

Variables

var (
	Assets       = flag.String("Assets", "./Assets", "Location of Assets folder")
	OGL_VERSION  = flag.String("OGL_VERSION", "130", "OpenGL version used. The actual version in shaders")
	AssetsFonts  string
	AssetsImages string
	AssetsModels string
)

Functions

func EngineStart

func EngineStart()

EngineStart initializes everything in order within the engine. Should be called first