https://github.com/felixangell/strife

a simple 2d game framework
https://github.com/felixangell/strife

2d game-framework game-frameworks game-library go

Last synced: about 1 month ago
JSON representation

a simple 2d game framework

• Host: GitHub
• URL: https://github.com/felixangell/strife
• Owner: felixangell
• License: mit
• Created: 2016-12-02T18:40:35.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-07-07T14:29:06.000Z (about 2 years ago)
• Last Synced: 2024-06-20T05:16:23.242Z (3 months ago)
• Topics: 2d, game-framework, game-frameworks, game-library, go
• Language: Go
• Homepage: https://strife.felixangell.com
• Size: 371 KB
• Stars: 251
• Watchers: 9
• Forks: 12
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - felixangell/strife - a simple 2d game framework (Go)
• awesome-golang-repositories - strife

README

        
# [strife](https://strife.felixangell.com) [![Build Status](https://travis-ci.org/felixangell/strife.svg?branch=master)](https://travis-ci.org/felixangell/strife)

A simple game framework that wraps around SDL2.

## example

The largest example use of the Strife framework is the [Phi text editor](//phi.felixangell.com), a text editor written entirely from scratch with syntax highlighting, a command palette, multiple buffer support, etc.



Though there are some smaller examples demonstrating components of the Strife API in the `examples/` folder.

## note/disclaimer

This is a work in progress. It provides a very minimal toolset for rendering shapes, images, and text

as well as capturing user input. This is not at a production level and is mostly being worked on when the

needs of my other projects (that depend on this) evolve.

There is no documentation either! If you want to use it you will have to check out the examples. I may

get round to writing some documentation but the API is very volatile at the moment.

## installing

Simple as

	$ go get github.com/felixangell/strife

Make sure you have SDL2 installed as well as the ttf and img addons:

	$ brew install SDL2 SDL2_ttf SDL2_image

## getting started

This is a commented code snippet to help you get started:

```go

func main() {

	// create a nice shiny window

	window := strife.SetupRenderWindow(1280, 720, strife.DefaultConfig())

	window.SetTitle("Hello world!")

	window.SetResizable(true)

	window.Create()

	// this is our event handler

	window.HandleEvents(func(evt strife.StrifeEvent) {

		switch event := evt.(type) {

		case *strife.CloseEvent:

			println("closing window!")

			window.Close()

		case *strife.WindowResizeEvent:

			println("resize to ", event.Width, "x", event.Height)

		}

	})

	// game loop

	for {

		// handle the events before we do any

		// rendering etc.

		window.PollEvents()

		// if we have a window close event

		// from the previous poll, break out of

		// our game loop

		if window.CloseRequested() {

			break

		}

		// rendering context stuff here

		// clear and display is typical

		// all your rendering code should

		// go...

		ctx := window.GetRenderContext()

		ctx.Clear()

		{

			// ...in this section here

			ctx.SetColor(strife.Red)

			ctx.Rect(10, 10, 50, 50, strife.Fill)

			// check out some other examples!

		}

		ctx.Display()

	}

}

```

## license

[MIT](/LICENSE)