Raylib Golang "GameFramework"

A simple template for making games with raylib in 300 lines. with WEB SUPPORT

You are expected to modify this codebase to suit your needs.

Featuring Seperate "Scenes" with their own state

---

Table of Contents

• Getting started

• Running

• Web Builds

• Adding Scenes

  • Scene Interface
  • Scene Structure Example
  • Demo Scenes

• Code description

  • main.go
  • engine/engine.go

• What next?

---

Getting started

Just create a repository using this as the template. By default it includes a spinning cube demo. and a main menu. See below on how to run it.

Running

If you are on windows, you only need to place raylib.dll next to the main.go file. See PureGo

For linux and mac you will need some dependencies. See raylib-go for instructions.

Once you have the dependencies, run go mod tidy and then go run .

Web Builds

To build for web, run go run build/web*.

Notes:

• It is important that you use the assets folder for storing your assets.
• Every scene has a context passed to it. This context contains a fs.FS that represents the assets folder.
• variable called IsWeb to detect if we are on web is also inside the context.

---

Adding Scenes

A scene is just a struct that holds the data for your game, updates the logic and draws things to the screen.

Scene Interface

// a scene must implement the engine.scene interface
type scene interface {
	Load(Context)                        // called when this Scene is switched to
	Update(Context) (unload bool)        // called every frame
	Unload(Context) (nextSceneID string) // called after Update returns true. Switches to nextSceneID
}

Put your scenes inside of its own seperate package: scenes/<MyScenePackage> for example:

scenes/
├── RegisteredScenes.go // register your scenes in this file (more info later)
| // cube scene package
├── cube 
│   └── cube.go // spinning cube
| // start scene package (loaded first)
└── start 
    ├── start.go
    └── systems.go

Scenes must be registered inside of scenes/RegisteredScenes.go

// register all your scenes in here
var Registered = engine.Scenes{
	"start": &start.Scene{},
	"cube": &cube.Scene{},
}

Scene Structure Example

Here is a blank scene that will never quit:

package myscene

import "GameFrameworkTM/engine"

type Scene struct {
}
// Load is called once the scene is switched to
func (scene *Scene) Load(ctx engine.Context) {
}
// update is called every frame
func (scene *Scene) Update(ctx engine.Context) (unload bool) {
	return false // if true is returned, Unload is called
}
// called after Update returns true
func (scene *Scene) Unload(ctx engine.Context) (nextSceneID string) {
	return "someOtherSceneId"  // the engine will switch to the scene that is registered with this id
}

Demo scenes

• scenes/cube/cube.go This scene features a spinning cube (wow!)

• scenes/start/start.go This is the main menu scene that is loaded first, press enter to select an option.

---

Code description

main.go

The main.go file isn't important, you can only change the window title here.

engine/engine.go

The engine.Run function initializes a window and centers it. It’s only 100 lines. Looking at the code comments is recommended. The engine.Context, which is supposed to be used by you to implement features, is defined here.

---

What next?

Add what you need. Here are some features you could implement:

• Letterboxing (black bars)
• Asset management
• Save Files
• Anything else your game may need

---