shade

Shade SDK

A simple and easy to use 2.5D game SDK for the Go programming language.

NOTE: This SDK should be considered very experimental as it is still under development. It is currently being modeled after some aspects of the PyGame SDK, but this will probably change some as it matures. The project will not have its "experimental" status removed until it is easy to install and to use.

While the above should work without needing to work with the OpenGL SDK, the packages of this SDK should be extendable such that more advanced uses are possible.

For usage/help using Shade, please see the shade-engine google group.

Installing

Linux (Debian based) Specific Instructions

# Install Go 1.6
$ sudo apt-get install git-core libgl1-mesa-dev libxrandr-dev libxcursor-dev libxinerama-dev libxi-dev

For the Raspberry Pi you will also need to install

sudo apt-get install libgles2-mesa-dev

Windows Specific Instructions (work in progress) TODO: Figure this out.

To install:

Dependencies

$ go get github.com/aeonurutu/shade/...

To test your install:

cd $GOPATH/src/github.com/aeonurutu/shade/examples/demos/platformer
go run main.go

Dev Build

To compile your app with the Shade's dev option available:

go build -ldflags="-X github.com/aeonurutu/shade.ldDevBuild=true" main.go

Contributing

Join the dev discussions via the shade-engine-dev google group.

To run tests:

$ go test ./...

To view the CI status

$ go test ./... | awk -f ci.awk

Attribution

This project was inspired by the article "Normal Mapping with Javascript and Canvas".

Some aspects of the SDK are inspired by the PyGame SDK.

assets/gopher* adapted from creations by Renee French under a Creative Commons Attributions 3.0 license.

Helpful Tools

Pyxel Edit - Very nice pixel art editor.

Sprite DLight - Instant normal maps for 2D graphics

Tiled - Your free, easy to use and flexible tile map editor.

sfxr/cfxr - Simple means of getting basic sound effects.

Troubleshooing

cannot find package "github.com/aeonurutu/shade/gen"

Some variables/assets are packaged into a generated code file, if you get this error run the bindata.sh script to generate that file.

Slow saves in VIM

Sometimes, go-imports inserts the the wrong things. VIM was hanging for me for about 10~20 seconds after saving. I'm not sure why, but switching from v2.1 to v4.1-core fixed the issue.

-       "github.com/go-gl/gl/v2.1/gl"
+       "github.com/go-gl/gl/v4.1-core/gl"

Error: "could not decode file player.png: image: unknown format"

The following line will not be auto-imported since our code does not call anything in the png, library directly. In order to ensure that the library loads (so image.decode("somefile.png") works), we must have the following import to load the PNG package.

+	_ "image/png" // register PNG decode

... has no field or method ...

And it just does not make sense why it is not found, check that go-imports imported the correct thing.