Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nientedidecente/heaps-examples
cloned-rebased translated fork of the russian Beeblerox/Simplest-Heaps-Examples
https://github.com/nientedidecente/heaps-examples
Last synced: 13 days ago
JSON representation
cloned-rebased translated fork of the russian Beeblerox/Simplest-Heaps-Examples
- Host: GitHub
- URL: https://github.com/nientedidecente/heaps-examples
- Owner: nientedidecente
- Created: 2020-05-29T16:02:01.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-07-09T21:53:15.000Z (over 4 years ago)
- Last Synced: 2024-08-01T16:28:24.997Z (3 months ago)
- Language: Haxe
- Size: 3.44 MB
- Stars: 25
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# heaps-examples
cloned-rebased translated fork of the russian **Beeblerox/Simplest-Heaps-Examples**.
We did not directly fork this repo from the original one [Beeblerox/Simplest-Heaps-Examples](https://github.com/Beeblerox/Simplest-Heaps-Examples), We cloned it and rebased, in order to avoid having the full git history.
Apart from translating the existing docs from russian, we are also adding additional documentation and fixing some errors related to the old version of `heaps` used in some examples.
## How To Run the examples
To run the single codebases you need to have `haxe` and `heaps` installed.
[Download Haxe](https://haxe.org/download/)
In order to build/test the examples on this repo we have been using the following version
```
-> % haxe --version
4.0.5
```
every version above `4.x.x` should do fine.
**Installing libs**
```
haxelib install heaps hlsdl
```
Some examples require the package `differ` too.
```
haxelib install differ
```
If you want to run them on Windows with DirectX you will need to install `hldx`
```
haxelib install hldx
```
You will also need [Hashlink](https://hashlink.haxe.org/) to run the compiled bytecode.
If you are using **VSCode**, each folder exposes some tasks that will be executable from the IDE itself.
**How to run the examples**
Alternatively, if you want to run them on your cli, you will just need to type the following commands:
```
cd 01_heaps_color_tile
haxe game.hxml
```
If everything is setup correctly you will obtain a `game.hl` file.
You will be able to run that file by just typing:
```
hl game.hl
```
(You can find more info on how the compiler works in the [.hxml](https://github.com/nientedidecente/heaps-examples/blob/master/01_heaps_color_tile/game.hxml) file itself)
### JS Examples
Some examples, like `./12_heaps_bitmap_font` have a 2 `.hxml` files, the `game.hxml` one will be used, as in the other examples to build an `hashlink` bytecode, the `js.hxml` instead is used to transpile the heaps game to a javascript file.
You can run it, after running the haxe compiler with
```
haxe js.hxml
```
by just opening the `index.html` file in the same folder, if this won't work try to feed the directory to a web server.
**Example**
```
python3 -m http.server --directory .
```
# Links
## Haxe
- [Haxe Syntax Overview](https://learnxinyminutes.com/docs/haxe/)
- [Haxe Language tutorial](https://learn.haxe.org/)
## Heaps
- [Heaps Docs](https://heaps.io/api/)
- [Heaps Docs - 2D](https://heaps.io/api/h2d/)
## DeepNight Tutorials
- [Install Haxe/Heaps](https://deepnight.net/tutorial/a-quick-guide-to-installing-haxe/)
- Using gameBase, haxe-heaps template [tutorial](https://deepnight.net/tutorial/using-my-gamebase-to-create-a-heaps-game/)