Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up documentation about hxml flags #100

Merged
merged 2 commits into from
Oct 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 9 additions & 21 deletions Flags.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,29 @@
# HXML flags

Common `-D` flags that can be used with Heaps:

```
```hxml
# flag to define the size of the window and default scene size:
-D windowSize=800x600

# define the window/process name
-D windowTitle=My game made with Heaps.io

# define the path to the game assets/resources
# (actually not recommended, just use `-p res` insead,
# but which demands assets to be in a directory called `res`)
-D resourcesPath=assets
# so rather use:
-p res
# if unset, the default path is "res"
-D resourcesPath=res

# other known flags (deprecated/legacy code)
-D heaps_emit_tile_buffering

```

Common flags coming from Haxe
```

```hxml
# dead code elimination (code that cannot be reached will be ditched):
-D dce=full

# Tail Recursion Elimination (TRE): Replace recursive programming
# (only `static` and `final` methods, as well as local/arrow functions)
# (https://haxe.org/manual/cr-tail-recursion-elimination.html):
#-D analyzer-optimize
```

---
## More

# Static analyzer, see: https://haxe.org/manual/cr-static-analyzer.html
-D analyzer-optimize
```
# Popular resolutions
-D windowSize=1920x1080
-D windowSize=1280x720
-D windowSize=1024x768
```
1 change: 0 additions & 1 deletion Simple-sprites.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,6 @@ This could be the hxml-file for HashLink:
-lib heaps
-lib hlsdl
-cp src
-p res
-main SimpleSprites
-hl simple_sprites_demo.hl

Expand Down