Get Started

Install NME

The first step is to install Haxe, NME and other dependencies. The recommend way is to use the native installers for Windows, Mac or Linux. If you prefer, you can follow manual instructions instead.

You will need additional SDKs or supporting tools depending on the platforms you target. The NME command-line tools provide a setup command that will help download and install these tools for you.

nme setup windows
nme setup linux
nme setup android
nme setup webos

If you are targeting Mac or iOS, you will need XCode but it cannot be installed automatically.

Troubleshooting: "nme" is a shortcut for "haxelib run nme". If the command does not appear to be available, run "sudo haxelib run nme setup" and try again.

Example Project

If you are new to NME, you may be interested in building an example project to make sure everything is working properly. You can download the Actuate Example, which uses the Actuate animation library to animate colored circles.

DSC00787_resize.jpg

The example requires Actuate, which can be installed using haxelib from a command-line or terminal

haxelib install actuate 

If you have FlashDevelop installed, open the project file and press Ctrl+Enter to compile the project. You should be able to change the target in FD4 by going to Project > Properties and changing Test Project to a different text value.

You can also compile using the NME command-line tools directly. To build, package and run the example, use one of the following commands

nme test "Actuate Example.nmml" flash
nme test "Actuate Example.nmml" ios -simulator
nme test "Actuate Example.nmml" webos
nme test "Actuate Example.nmml" android
nme test "Actuate Example.nmml" windows
nme test "Actuate Example.nmml" mac
nme test "Actuate Example.nmml" linux
nme test "Actuate Example.nmml" html5

You can also discover more commands and flags by running "nme help"

Note: The "test" command installs and runs applications on connected webOS or Android devices, but cannot run iOS applications automatically unless you are targeting the simulator. To install to an iOS device, you can either use the "build" command then install the IPA using the XCode organizer, or use the "update" command to generate an XCode project.

Next Steps

You can find a great code editor, read more about NME in the documentation, or try one of the easy tutorials.

If you are using FlashDevelop, you can also use this project template that can make it easier to generate new NME projects in the future. Run the file to install the template, then select "NME Project" when you are creating a new project.