hurricanerix / shade

Simple and easy to use 2.5D game SDK for the Go programming language

Shade SDK

NOTE: All work in master has currently stopped. There is a 'engine-rewrite' branch which is where all current work is happening.

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

A short video: https://www.youtube.com/watch?v=GlaKt9xPGCQ

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, easy to use, and supports dynamic lighting.

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.

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

Windows Specific Instructions (work in progress)

https://git-scm.com/download/win
https://golang.org/doc/install
https://cygwin.com/install.html
http://www.glfw.org/

To install:

Dependencies

$ go get -u github.com/jteeuwen/go-bindata/...
$ go get github.com/go-gl/gl/v{3.2,3.3,4.1,4.4,4.5}-{core,compatibility}/gl
$ go get github.com/go-gl/gl/v3.3-core/gl

NOTE: the first "go get" will produce an error because generated files are not generated yet.

$ go get github.com/hurricanerix/shade/...
package github.com/hurricanerix/shade/gen: cannot find package "github.com/hurricanerix/shade/gen" in any of:
	/usr/local/go/src/github.com/hurricanerix/shade/gen (from $GOROOT)
	/Users/hurricanerix/bin/usr/gocode/src/github.com/hurricanerix/shade/gen (from $GOPATH)
$ go generate github.com/hurricanerix/shade/...
$ go get github.com/hurricanerix/shade/...

To test your install:

cd $GOPATH/src/github.com/hurricanerix/examples/ex2-platform
go run main.go

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/hurricanerix/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.

shade's Issues

core: Window Interface

Currently the window package returns (*glfw.Window, error). This proposal is to create a window interface to be returned. This will allow a built in Window implementation to be available. This default implementation should be suitable for most games. If there is a case where it is not idea, a replacement implementation can be created to replace the provided one.

Proposed interface:

// Window to be rendered too.
type Window interface {
    SetMode(w, h, display int) error // SetMode for the window.  display should
    // be a positive value indicating the display to use fullscreen on.  A value
    // of -1 indicates to run in windowed mode.  If display is set to a value
    // out of range, an appropriate error should be returned.
    SwapBuffers()         // Swap buffers.
    Capture() *image.RGBA // Capture and return the image currently being rendered in the buffer.
    Destroy()             // Destroy and cleanup resources for the window.
    ShouldClose() bool    // ShouldClose due to a receiving an event.
}

Make shade work on Raspberry Pi

(render direct to frame buffer, so the apps will work on things like retropie)

Some (maybe) useful links:
https://solarianprogrammer.com/2015/01/22/raspberry-pi-raspbian-getting-started-sdl-2/
https://benosteen.wordpress.com/2012/04/27/using-opengl-es-2-0-on-the-raspberry-pi-without-x-windows/

ex2-platform: cpu power affects jump height

raspberry pi 2 (jumps way too high) (900 MHz qc ARM Cortex-A7, VideoCore IV)
macbook (jumps a reasonable hight) (2.9 GHz Intel Core i5, Intel Iris Graphics 6100)
desktop (does not jump high enough) (3.5 GHz Intel Core i7-4770K, NVIDIA GeForce GTX 970)

core: add hotkey to take in-game screenshots

screenshots should be tagged with metadata (possibly level, player stats, ...)
if running in dev mode, tag with advanced metadata (from the dev screen)

core: implement GLSL inverse function

core: rendering overhaul.

Redesign the rendering system to use a deferred shading model.

core: refactor go-gl-utils to be a part of shade

https://github.com/hurricanerix/go-gl-utils

core: svg support

core: create collider interface

Create a "Collider" interface moving Bounds() into it.

core: dev mode should support rendering hit boxes.

core: add gamepad support

core: add linear interpolation to camera

core: figure out why mv3Matrix * MCNormal does not work

shade/display/display.go

Line 216 in d47094e

vec3 n = normalize(MCNormal); // TODO: fix normalize(mv3Matrix * MCNormal);

ex2-platform: add enemies

Add enemies to level.

core: create GUI elements

Some simple things like buttons, check boxes and text boxes for menus and config screens.

ex2-platform: add platforms to level

Add platforms to jump on.

core: add directional light source

(rays can be considered parallel)

core: incorrect asset path in generated files

The command

go generate github.com/hurricanerix/shade/...

is causing assets names in the generated files to be prefixed with "../../", this should be removed.

03-collisions: fix collision detection

core: add positional light source

(exact position determines it's effects)

core: load assets from tar file rather than building them into the bin

ex2-platform: create intro animation

When the game is first loaded, a intro animation should be played.

core: dev mode should support showing meshes.

you should be able to turn on and off boundaries polygons.

core: support multiple lights instead of one

core: make better normal maps

03-collisions: balls escape from the room

They bounce around for a while, then hit a edge and get out.

ex2-platform: create title screen

After the game plays the intro animation, the title screen should be displayed. The title screen should provide the player with options such as "1 player", "2 player", "options", ...

core: install is still a little odd

Currently when installing with "go get github.com/hurricanerix/shade/..." an error is produced because the gen package does not exist yet.

It would be nice to figure out a way to have "go get" run "go generate" before looking for packages to install.

$ go get github.com/hurricanerix/shade/...
package github.com/hurricanerix/shade/gen: cannot find package "github.com/hurricanerix/shade/gen" in any of:
    /usr/local/go/src/github.com/hurricanerix/shade/gen (from $GOROOT)
    /Users/hurricanerix/bin/usr/gocode/src/github.com/hurricanerix/shade/gen (from $GOPATH)

ex2-platform: allow player to combat enemeis

The player needs a way to eliminate the enemies added to the level in:

• #21

Missing packages

When following the installation instructions from README.md, I got errors about missing packages from go get github.com/aeonurutu/shade/...:

package github.com/aeonurutu/shade/entity: cannot find package "github.com/aeonurutu/shade/entity" in any of:
/usr/lib/go/src/github.com/aeonurutu/shade/entity (from $GOROOT)
/home/anonymous/my-projects/shade-engine/src/github.com/aeonurutu/shade/entity (from $GOPATH)
package github.com/aeonurutu/shade/fonts: cannot find package "github.com/aeonurutu/shade/fonts" in any of:
/usr/lib/go/src/github.com/aeonurutu/shade/fonts (from $GOROOT)
/home/anonymous/my-projects/redpanda/shade-engine/src/github.com/aeonurutu/shade/fonts (from $GOPATH)
package github.com/aeonurutu/shade/shapes: cannot find package "github.com/aeonurutu/shade/shapes" in any of:
/usr/lib/go/src/github.com/aeonurutu/shade/shapes (from $GOROOT)
/home/anonymous/my-projects/shade-engine/src/github.com/aeonurutu/shade/shapes (from $GOPATH)
package github.com/aeonurutu/shade/sprite: cannot find package "github.com/aeonurutu/shade/sprite" in any of:
/usr/lib/go/src/github.com/aeonurutu/shade/sprite (from $GOROOT)
/home/anonymous/my-projects/shade-engine/src/github.com/aeonurutu/shade/sprite (from $GOPATH)

I'm not sure how to fix the issue since apparently go generate github.com/aeonurutu/shade/... does nothing. Neither scripts/gen.sh generates those missing files.

ex-top-down: create new example

Create a top down example.

ex2-platform: fix boundary detection

player sometimes gets stuck on walls, also falls through some arbitrarily placed blocks.

Cleanup Old Issues

ex2-platform: load levels from tmx files

Level should be loaded from Tiled Map Editor files.

core: load normal maps

Easily load normal maps in addition when loading the color maps.

ex1-platform: fix input

doesn't work very well, sometimes jumps are ignored. also seems to run faster to the right than left.

core: code should be idiomatic Go

A lot of code was not written with the proper Go mindset, everything should be examined to see if it can be re-written in a way that makes sense to Go developers and takes advantages of the Go language.

ex2-platform: add exit to level

Give the player a way to "win"

core: Logging Expectations

Come to a consensus on what the logging expectations are.

core: add depth based drawing

currently layering sprites by drawing over things. it would be better to set a depth, and and not draw if something in front of it was already drawn.

04-lighting: should demo lighting effects

Can't be done until some of the following are implemented:

• #8
• #9
• #10
• #11

core: set ambient lighting

Should be able to set a ambient lighting value for the scene.

core: should easy to install

ideally it should be as easy as "go get github.com/hurricanerix/shade/..."

Must be in directory with resources to execute

$ ./examples/platformer/platformer
Traceback (most recent call last):
File "./examples/platformer/platformer", line 136, in
Game().main(640, 480)
File "./examples/platformer/platformer", line 95, in main
background = sprites.build('background.png')
File "/home/rhawkins/workspace/transylvania/transylvania/sprites.py", line 135, in build
raise Exception('file {0} does not exist.'.format(filename))
Exception: file background.png does not exist.

core: fonts not rendering in color

core: text alignment

When drawing fonts, the fonts are drawn slightly to the left and down from where they should be drawn.

core: extended sprite modification

Currently you can tweak sprite colors with addColor and subColor. It would be nice to be able to also do things like hue, lightness and saturation.

ex2-platform: replace sprites

Replace the sprites with something that looks a little nicer and has some animations.

03-collisions: balls should also collide with each other.