README
¶
goARRG - go Assembly RequiRed Game-engine
goARRG is a assembly required game engine where the pieces may or may not be provided and it is up to you to put them together.
This allows the user to customize the engine almost exactly to their needs.
It is not a goal however to make it easy to rip out a piece and replace it later.
Development Roadmap
*Not in actual development order
MVP for engine developmentPlatform initialization and setupMathsGlue APIsBasic Tooling
- Renderer
- ECS
- Editor
Supported Platforms
Currently goarrg only supports Ubuntu (tested on 20.04 LTS) and Windows 10, 386 and amd64. Vulkan is only supported on amd64. However, there is nothing preventing you from creating a platform package to support other platforms.
Dependencies
goarrg requires go 1.21+
The following list of dependencies assume you are using the make package to install the rest.
| OS | Dependencies |
|---|---|
| Ubuntu | sudo apt-get install build-essential cmake libxext-dev libpulse-dev |
| Windows | mingw-w64, cmake |
Graphics API Specific
| OS | API | Dependencies |
|---|---|---|
| Ubuntu | gl | sudo apt-get install libglu1-mesa-dev mesa-common-dev |
Cross Compile
There is cross compile support for the supported platforms, assuming you installed a C/C++ cross compiler with the correct file names. To cross compile to other platforms, or to use a non default toolchain, you need to set the CC/CXX/AR environmental variables. For Windows, you also need to set RC.
The toolchain/gcc package is there to help setup these environmental variables.
Default Compiler Selection
| Taraget Platform | Prefix |
|---|---|
| linux_386 | i686-linux-gnu |
| linux_amd64 | x86_64-linux-gnu |
| windows_386 | i686-w64-mingw32 |
| windows_amd64 | x86_64-w64-mingw32 |
CC={{.Prefix}}-gcc
CXX={{.Prefix}}-g++
AR={{.Prefix}}-gcc-ar
Windows Only:
RC={{.Prefix}}-windres
Install instructions
Install Go manually to ensure you have the latest version.
https://golang.org/doc/install
mkdir projectfolder
cd projectfolder
go mod init github.com/username/projectname
go get -d goarrg.com/...
After which you write a ./cmd/make program that imports the goarrg.com/make package to build dependencies and to build your project.
Examples
Examples can be found at https://github.com/goarrg/examples
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Running ¶
func Running() bool
Running reports whether the engine is considered to still be running. It will only return true when the main loop is running and before shutdown confirmation from Program.Shutdown(). This is so that you can depend on Running() to terminate your loops/threads.
SIGINT will bypass Program.Shutdown() and force a terminate. This is so we have a easy way to terminate the engine in the event of deadlocks.
Types ¶
type Audio ¶
type Audio interface {
AudioConfig() AudioConfig
Init(AudioConfig) error
Mix() (int, audio.Track)
Update()
Destroy()
}
type AudioConfig ¶
type AudioConfig struct {
Spec audio.Spec
// Length of the buffer in terms of samples, this is usually a power of 2
BufferLength int
}
Refer to driver's documentation on the valid value ranges
type GLInstance ¶
type GLInstance interface {
ProcAddr() uintptr
SwapBuffers()
}
type GLRenderer ¶
type GLRenderer interface {
Renderer
GLConfig() GLConfig
GLInit(GLInstance) error
}
type VkInstance ¶
type VkRenderer ¶
type VkRenderer interface {
Renderer
VkConfig() VkConfig
VkInit(VkInstance) error
}
Source Files
Directories