README
¶
Broks Ultimately Brings you a Basic Lua Engine => BUBBLE
Bubble Game Engine
This the base for the Game Engine. These are just imports. The actual files to build an executable binary are in another repo. In other words these files do nothing by themselves, but the files in the actual executables repos do.
Why this setup?
- Most of all for extendability. The bubble engine has been setup to be easily attachable other setups creating sub-engines that are more able to deal with certain tasks. Lua is as an interpreted lanugae not too fast (already faster than you'd expect from an interpreted language), plus the Go version of Lua is a bit slower, so allowing the engines to do more can be desirable, but at the same time why give users of the software made with Bubble more than they need? Only takes up RAM. Wll, I guess I motivated my approach enough now :P
- Please note that my Blitzmax engines are already a bit set up in this perspective. LAURA II was a combination of JCR6, GALE and small library with RPG specific routines that was actually meant for the DuCraL engine that never got finished, and of course Kthura :P
- With Kthura I already named a heavy system. It's not yet decided if Kthura makes it to Go, but if it does, I only want it in engines for projects that NEED Kthura.
Requirements to build
- Tricky units for Go
- veandco's SDL2 libraries for Go -- https://github.com/veandco/go-sdl2
- The libs deemed optional in the documentation of SDL are NOT optional as far as Bubble is concerned!!!
- Shopify's Lua engine -- https://github.com/Shopify/go-lua
- The jpbubble/Base library
Note
This stuff is still in development. Expect it to be buggy and unusable as long as this note is here. Stuff may appear and disappear randomly without deprecation notes. When this stuff is 'stable enough to use' I'll remove this notice. ;)
Note II
In Go this project has been cancelled, but I will very likely replace it soon with a project with the same goal, but only written in a different language. Although it's not official yet, C# is a very likely candidate, although I am still exploring my possibilities here.
Documentation
¶
Overview ¶
a-events.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.26
a-graphics.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.25
a-window.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.24
console.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.25
crash.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.24
globals.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.26
initstuff.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.26
lua.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.24
resource_linux.go
(c) 2017 Jeroen Petrus Broks.
This Source Code Form is subject to the terms of the
Mozilla Public License, v. 2.0. If a copy of the MPL was not
distributed with this file, You can obtain one at
http://mozilla.org/MPL/2.0/.
Version: 17.12.23
Index ¶
Constants ¶
This section is empty.
Variables ¶
var EngineCopyright = "(c) Jeroen P. Broks"
var EngineName string
This must be set prior it initizing. This string will be used to check the data in the ID/Identify.gini file
Functions ¶
func BDEFER ¶
func BDEFER(f func())
Similar to Go's "defer" keyword, but it only takes functions without parameters, returning nothing and they are used whenever bubble is closed dow in the way it should.
func Col ¶
A quick routine for quickly seeing color values. Most of use for the tricon support, but why not make it "public"? :P
func Crash ¶
func Crash(ec ...int)
Executes all BDEFER registered funcions in reversed order as they were given and closes Optionally the first parameter may contain the exit code
func InitBubble ¶
func InitBubble()
Reads the ID/Identify.gini file from the JCR resource. The JCR file can basically be any file JCR6 supports (except for WAD, as it has a limitation of 8 characters per entry name) but it must be named the same as the executable file running it with it's regular extension replaced with .jcr Please note that on Mac this file must be located inside the application bundle's Resources folder (mac users expect this).
Types ¶
This section is empty.
Source Files
Directories