korok

README

Korok

Korok is a free lightweight, cross-platform, component-based 2D game engine written in Golang and released under the zlib license. Greatly inspired by bitsquid blog.

Homepage: korok.io Twitter: ntop

The latest release is beta-version which is not stable and will have breaking changes in the future. About the state and progress of the project, see Devlogs

Getting Started

go get korok.io/korok

Games

FlappyBird

GitHub

Shoot Stack

AppStore GooglePlay

Unstable Tower

GooglePlay

Demos Project

Some ScreenShot

Input Control - Show how to use InputSystem

Sprite Animation - Show how to use sprite animation system

Tween Animation - Show how to use tween animation system

ParticleSystem - Show how to use ParticleComp

Gui - Show how to use korok's imgui-api

License

This software is provided 'as-is', without any express or implied warranty. In no event will the authors be held liable for any damages arising from the use of this software.

Permission is granted to anyone to use this software for any purpose, including commercial applications, and to alter it and redistribute it freely, subject to the following restrictions:

1. The origin of this software must not be misrepresented; you must not claim that you wrote the original software. If you use this software in a product, an acknowledgment in the product documentation would be appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.

Note: To avoid fragmentation, it's not allowed to create and distribute korok-like libs.

Documentation

Index

• Constants
• Variables
• func Run(options *Options, sc game.Scene)
• type Options

Constants

const VERSION_CODE = 2

const VERSION_NAME = "0.2"

Variables

var Entity *engi.EntityManager

entity-api

var Flipbook *frame.FlipbookTable

animation system

var G *game.Game

var Input *input.InputSystem

input system

var Mesh *gfx.MeshTable

var ParticleSystem *effect.ParticleSystemTable

particle system

var SceneMan *game.SceneManager

var Script *game.ScriptTable

var Sprite *gfx.SpriteTable

shortcut component-api for rendering system

var Tag *game.TagTable

var Text *gfx.TextTable

var Transform *gfx.TransformTable

Functions

func Run

func Run(options *Options, sc game.Scene)

Types

type Options

type Options hid.WindowOptions