https://github.com/juan-medina/gosge
Go Simple Game Engine
https://github.com/juan-medina/gosge
Last synced: 3 months ago
JSON representation
Go Simple Game Engine
- Host: GitHub
- URL: https://github.com/juan-medina/gosge
- Owner: juan-medina
- License: apache-2.0
- Created: 2020-08-14T07:15:57.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2020-10-21T06:39:35.000Z (over 4 years ago)
- Last Synced: 2025-01-13T00:19:42.942Z (5 months ago)
- Language: Go
- Size: 43.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# gosge
Go Simple Game Engine using an [ECS](https://github.com/juan-medina/goecs)
[](/LICENSE)
[](https://pkg.go.dev/mod/github.com/juan-medina/gosge?tab=versions)
[](https://pkg.go.dev/github.com/juan-medina/gosge?tab=doc)
[](https://travis-ci.com/juan-medina/gosge)
[](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)
## Info
gosge is an opinionated 2D only game engine the uses [GOECS](https://github.com/juan-medina/goecs) for _easily_ develop games
with an ECS paradigm.
Internally uses the go [port](https://github.com/gen2brain/raylib-go) of [raylib](https://www.raylib.com/) for most of the device functionalities, including rendering.
## Simple Hello World
```go
package main
import (
"github.com/juan-medina/gosge"
"github.com/juan-medina/gosge/components/color"
"github.com/juan-medina/gosge/components/geometry"
"github.com/juan-medina/gosge/components/ui"
"github.com/juan-medina/gosge/options"
"log"
)
// game options
var opt = options.Options{
Title: "Hello Game",
BackGround: color.Black,
}
const (
fontName = "resources/go_regular.fnt"
fontSize = 100
)
var (
// designResolution is how our game is designed
designResolution = geometry.Size{Width: 1920, Height: 1080}
)
// Simple Usage
func main() {
if err := gosge.Run(opt, loadGame); err != nil {
log.Fatalf("error running the game: %v", err)
}
}
func loadGame(eng *gosge.Engine) error {
// Preload font
if err := eng.LoadFont(fontName); err != nil {
return err
}
// get the ECS world
world := eng.World()
// gameScale from the real screen size to our design resolution
gameScale := eng.GetScreenSize().CalculateScale(designResolution)
// add the centered text
world.AddEntity(
ui.Text{
String: "Hello World",
HAlignment: ui.CenterHAlignment,
VAlignment: ui.MiddleVAlignment,
Font: fontName,
Size: fontSize * gameScale.Min,
},
geometry.Point{
X: designResolution.Width / 2 * gameScale.Point.X,
Y: designResolution.Height / 2 * gameScale.Point.Y,
},
color.White,
)
return nil
}
```
## Run examples
The examples are available on [this folder](/examples), and can be run using make:
```bash
$ make run example=hello
$ make run example=eyes
$ make run example=layers
$ make run example=stages
$ make run example=animation
$ make run example=audio
$ make run example=tiled
$ make run example=draw
$ make run example=draw
$ make run example=collision
$ make run example=ui
```
Alternatively you could run them with :
```bash
$ go run examples/hello/hello.go
$ go run examples/eyes/eyes.go
$ go run examples/layers/layers.go
$ go run examples/stages/stages.go
$ go run examples/animation/animation.go
$ go run examples/audio/audio.go
$ go run examples/tiled/tiled.go
$ go run examples/draw/draw.go
$ go run examples/collision/collision.go
$ go run examples/ui/ui.go
```
## Requirements
### Ubuntu
#### X11
apt-get install libgl1-mesa-dev libxi-dev libxcursor-dev libxrandr-dev libxinerama-dev
#### Wayland
apt-get install libgl1-mesa-dev libwayland-dev libxkbcommon-dev
### Fedora
#### X11
dnf install mesa-libGL-devel libXi-devel libXcursor-devel libXrandr-devel libXinerama-devel
#### Wayland
dnf install mesa-libGL-devel wayland-devel libxkbcommon-devel
### macOS
On macOS, you need Xcode or Command Line Tools for Xcode.
### Windows
On Windows, you need C compiler, like [Mingw-w64](https://mingw-w64.org) or [TDM-GCC](http://tdm-gcc.tdragon.net/).
You can also build binary in [MSYS2](https://msys2.github.io/) shell.
## Installation
```bash
go get -v -u github.com/juan-medina/gosge
```
## Build Tags
- `opengl21` : uses OpenGL 2.1 backend (default is 3.3)
- `wayland` : builds against Wayland libraries
## Examples Resources
- Gopher Graphics
- https://awesomeopensource.com/project/egonelbre/gophers
- Game art 2D:
- https://www.gameart2d.com
- Mobile Game Graphics
- https://mobilegamegraphics.com/product/free-parallax-backgrounds
- Of Far Different Nature Music Loops
- https://fardifferent.itch.io/loops
- freesound.org
- https://freesound.org/people/SKKreativ/sounds/456255/