Skip to content

Commit

Permalink
Added readme sample instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Flagrare committed Nov 28, 2023
1 parent 79c70ea commit e202f38
Showing 1 changed file with 33 additions and 10 deletions.
43 changes: 33 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# About

**A lightweight and simple base structure for games, using *[Heaps](https://heaps.io)* framework and *[Haxe](https://haxe.org)* language.**
**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).

Expand All @@ -13,37 +13,60 @@ Latest release notes: [View changelog](CHANGELOG.md).

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.
- `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`
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`
- 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`
- 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
Expand Down

0 comments on commit e202f38

Please sign in to comment.