Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/deepnight/gameBase
Base structure for my games, using Heaps framework and Haxe language.
https://github.com/deepnight/gameBase
game haxe heaps webgl
Last synced: 5 days ago
JSON representation
Base structure for my games, using Heaps framework and Haxe language.
- Host: GitHub
- URL: https://github.com/deepnight/gameBase
- Owner: deepnight
- License: mit
- Created: 2018-12-10T18:02:37.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T07:56:05.000Z (6 months ago)
- Last Synced: 2024-08-01T16:28:25.507Z (3 months ago)
- Topics: game, haxe, heaps, webgl
- Language: Haxe
- Homepage: https://deepnight.net
- Size: 20.4 MB
- Stars: 593
- Watchers: 27
- Forks: 145
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-game-engine-dev - gameBase - Base structure for Haxe games, using _Heaps_ graphics framework. [[Tutorial](https://deepnight.net/tutorial/using-my-gamebase-to-create-a-heaps-game/)] (Libraries / Haxe)
README
# About
**A lightweight and simple base structure for games, using _[Heaps](https://heaps.io)_ framework and _[Haxe](https://haxe.org)_ language.**
Latest release notes: [View changelog](CHANGELOG.md).
[](https://github.com/deepnight/gameBase/actions/workflows/test.js.yml)
[](https://github.com/deepnight/gameBase)
# Install
## Legacy or master?
Two separate branches exist for GameBase:
- `master`: latest GameBase version, actively maintained.
- `legacy`: the previous Gamebase version. This one is much more minimalistic but it could be useful if you were looking for a very basic framework for Heaps+Haxe.
The following document will only refer to the `master` branch.
## Getting master
1. Install **Haxe** and **Hashlink**: [Step-by-step tutorial](https://deepnight.net/tutorial/a-quick-guide-to-installing-haxe/)
2. Install required libs by running the following command **in the root of the repo**: `haxe setup.hxml`
# Compile
From the command line, run either:
- For **DirectX**: `haxe build.directx.hxml`
- For **OpenGL**: `haxe build.opengl.hxml`
- For **Javascript/WebGL**: `haxe build.js.hxml`
The `build.dev.hxml` is just a shortcut to one of the previous ones, with added `-debug` flag.
Run the result with either:
- For **DirectX/OpenGL**: `hl bin\client.hl`
- For **Javascript**: `start run_js.html`
# Full guide
An in-depth tutorial is available here: [Using gamebase to create a game](https://deepnight.net/tutorial/using-my-gamebase-to-create-a-heaps-game/). Please note that this tutorial still refers to the `legacy` branch, even though the general idea is the same in `master` branch.
## Sample examples
The samples are the recommended places to start for the latest `GameBase` version (`main`).
They should give a pretty hands-on understanding of how entities work and how to integrate `ldtk` to development.
`SamplePlayer.hx`[SamplePlayer.hx]
SamplePlayer is an Entity with some extra functionalities:
- user controlled (using gamepad or keyboard)
- falls with gravity
- has basic level collisions
- some squash animations, because it's cheap and they do the job
`SampleWorld.hx`
A small class that just creates a SamplePlayer instance in the sample level.
## Localization
For **localization support** (ie. translating your game texts), you may also check the [following guide](https://deepnight.net/tutorial/part-4-localize-texts-using-po-files/).
## Questions
Any question? Join the [Official Deepnight Games discord](https://deepnight.net/go/discord).
# Cleanup for your own usage
You can safely remove the following files/folders from repo root:
- `.github/`
- `LICENSE`
- `README.md`
- `CHANGELOG.md`