An open API service indexing awesome lists of open source software.

https://github.com/haxeflixel/game-jam-template

HaxeFlixel game jam template with automated HTML5 build deployment to GitHub Pages
https://github.com/haxeflixel/game-jam-template

Last synced: over 1 year ago
JSON representation

HaxeFlixel game jam template with automated HTML5 build deployment to GitHub Pages

Awesome Lists containing this project

README

          

# game-jam-template

[![CI](https://img.shields.io/github/actions/workflow/status/HaxeFlixel/game-jam-template/main.yml?branch=dev&logo=github)](https://github.com/HaxeFlixel/game-jam-template/actions?query=workflow%3ACI)

This is a HaxeFlixel template that is particularly helpful for game jams. It consists of:

- An empty HaxeFlixel project generated with the `flixel template` command (with config files for Visual Studio Code).
- Automated HTML5 builds after each commit using GitHub Actions with deployment to GitHub Pages, so the playable game shows up on `http://.github.io//`. In this case the URL is http://haxeflixel.github.io/game-jam-template/. Very handy if you want feedback from others mid-jam!

This is a [template repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template), simply click "Use this template" to create a copy of it on your own GitHub account!

![](https://help.github.com/assets/images/help/repository/use-this-template-button.png)

**Notes:**
- For the first GitHub pages deployment, it can take around 10 minutes for the page to show up. Also, the repository needs to be public.
- The HTML5 builds are made [with the `-final` flag](https://github.com/HaxeFlixel/game-jam-template/blob/105be8f21d3880736ab056da22cb9e4d04d5536c/.github/workflows/main.yml#L19), which means [Dead Code Elimination](https://haxe.org/manual/cr-dce.html) and Minification are active to create smaller `.js` files. However, your code needs to be DCE-safe (avoid reflection or use `@:keep`).