README
¶
Gobatch
Go powered engine that offers features from low level opengl abstraction to UI framework. I created this to separate lot of logic from game am working on.
Structure
Engine contains lot of packages and most of them are not even that big. Reason for this is simple. I consider lot more convenient to write key.A instead of ggl.KeyA, some packages like rgba (offers lot of colors) are also generated then there are two package for interpolation lerp anc lerpc, one focuses on floating points other on colors but actual struct names are same. Another example is particle, this way you write particle.System and not drw.ParticleSystem. Whole engine is thus modular. It prefers components over maybe nice slow abstraction and can be more of a backend.
Dependencies
I have to mention that engine depends two "languages", goml and goss. Yes they are named after html and css as they resemble them. You don't have to use them, but they make ui lot easier to develop. See this repo for documentation of the "languages". I also made vscode extensions for syntax highlighting, link to them can be found in readme of mentioned repository. Errors are handles by sterr, using it directly might be useful when testing things that depend on gobatch.
Examples
Nothing is better the learn from code so I wrote couple of examples to show off what engine can do for reference. You can find them all here.
How to create a window or draw a sprite is also documented.
Documentation
I am going to be absolutely honest, some comments can be outdated. When i was developing ui package (ant its still in progress), i tried multiple different approaches and commented things too early. There is a lot of documentation and i have to clean it up, document new features and so on. Please open an issue if doc is unclear or is missing so i can prioritize things.
Contribution
When contributing please keep conventions. If you end up naming lot of struct fields with same prefix, extract them into separate struct and embed/add it to the parent (it has no runtime cost and makes code cleaner). Don't be afraid to introduce new package just to make naming nicer (again you notice it by same prefixes on items). Write tests if possible or add a exhaustive example of feature use. I have to first understand what code does to decide if its reasonable.
UI bugs
Ui can contain lot of bugs because of how flexible feature it is. It is just hard to test everything. If something behaves inconveniently open the issue and i will 1) fix it or 2) show you a work around if i cannot fix it (that can happen too).
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
examples
|
|
|
Package ggl defines essential abstraction over opengl types, you should use this and dodge gl calls to make you code cleaner.
|
Package ggl defines essential abstraction over opengl types, you should use this and dodge gl calls to make you code cleaner. |
|
key/binding
Package binding implements simple B system on top of window input methods
|
Package binding implements simple B system on top of window input methods |
|
ui
Package ui brings robust ui system based on elements.
|
Package ui brings robust ui system based on elements. |
|
logic
|
|
|
memory
Package memory offers gogen templates for memory managemant, structs can help to compose structure that takes garbage collection into account it gets rid of pointers, or lowers the allocations
|
Package memory offers gogen templates for memory managemant, structs can help to compose structure that takes garbage collection into account it gets rid of pointers, or lowers the allocations |
|
Package mat focuses on mathematics, in case of more intense operations related to ray cast i left some documentation inside functions in case you want to understand how math here works missing features: Circle, Polygon
|
Package mat focuses on mathematics, in case of more intense operations related to ray cast i left some documentation inside functions in case you want to understand how math here works missing features: Circle, Polygon |
|
mat3
Package mat3 is still in progress and will documented after its finished
|
Package mat3 is still in progress and will documented after its finished |