Home

Useful guide for Flambe.

Flambe is a Haxe powered 2D game engine that makes cross-platform development actually fun. Spend less time dealing with platform-specific bugs, and more time building great games.

Installation

🔸 STEP 1: Program installation

Haxe 3	NodeJS 0.8 or higher
Restart computer after installation, continue to step 2.

🔸 STEP 2: Flambe installation and setup

Download and setup Flambe by running: npm install -g flambe flambe update On windows use powershell to run the commandlines. On Mac and Linux, you'll need to run both these commands as root using sudo. Also remember to pass the -g flag to npm install.

Thats it! You can use Flambe now!

🔸 STEP 3 Create, build and run!

🔹 Create a new project flambe new <directory>	🔹 Build the project flambe build html flash --debug You can use html, flash, ios,android or firefox as target.
🔹 Run the project flambe run html --debug After making a change, you can use this command to rebuild and refresh your web browser in a single step. For iOS and Android, you need the AIR SDK installed.	🔹 Start the project flambe serve to start a webserver, and open http://localhost:7000 in your web browser. The Flash or HTML5 build will run depending on what your browser best supports. The webserver also provides Live asset reloading.

> * Get the most out of your app Using Native Extensions > * Read this info to Setup for iOS

⛳ Ready to release?

When you're ready to distribute your game, do a release build by omitting the --debug param. Release builds are smaller and faster, but are slower to build and harder to debug.

Editors

Download: FlashDevelop

The Project.hxproj generated by flambe new can be opened in FlashDevelop. The commandline instructions are integrated in the projectfile. To easily change the platform FlashDevelop builds, open flambe.yaml and edit the default_platform. Note that to debug Flash from within FlashDevelop, your browser needs the Flash debug player. For HTML, Javascript Source Maps will be generated.

• Flambe plugins for FlashDevelop
• Details for Yaml file

Download: Sublime Text + Sublime Text Haxe package

Sublime's Haxe package has excellent support for Flambe out of the box.

Once installed, just drag the root folder of your Flambe project into the Sublime icon, and it will recognize it as a Flambe project. Open a .hx-file and use the Control-Shift-B keyboard shortcut on the Mac to select your desired build target. Then, hit Control-Enter to compile. Sublime's Haxe package gives you great auto-completion, snippets and code hinting.

Demo projects

Compiling and hacking the demos is a great way to learn by example.

For help on how to perform some common tasks, see other pages in this wiki.

---

• Want Flambe next to your project? Flambe in custom folder.
• Trouble with installation? Check Troubleshooting.