The official Echo project uses the NetBeans Integrated Development Environment (IDE). Please [[tools/netbeans/|download and install NetBeans]] before continuing.
Please [[projects/echo_3/building/|install and build the Echo engine]]. You can begin doing this while waiting for NetBeans to install.
Once you have installed Echo and NetBeans, you should also install the [[projects/echo_3/netbeans_modules/|Emblem NetBeans Modules]]. This will allow you to configure Tool chains automatically and also provide new project templates to get started faster.
=Your first project=
Now that you have everything installed. We'll create a new project:
1. Open NetBeans and File -> New Project.
2. Select the C/C++ category
3. You should see Echo project templates listed in the Projects list. Select Echo Application.
{F4375 size=full}
4. Choose a project name and project location then click Finish
5. Right click the project in the project list and click Build. The project should build without errors.
6. Right click the project in the project list and click Run.
The Echo Application template has a simple menu and main game state that you can switch between using the on screen buttons. The game state scene is made up of a spinning Cube and some lights.
{F4377 sizze=full}
Congratulations, you have created your first Echo project!
=What next?=
Have a look at the project source code. The ProjectNameApplication.cpp file contains documentation about some Echo fundamentals and details the project Task structure. Game.cpp contains code to build the game scene, viewports and the in game menu.
Here are some suggestions for moving forward:
- Familiarise yourself with Scene objects: Modify the scene. Add another `SceneEntity` to the scene, give it a Sphere mesh (hint the `Mesh` class contains some helper methods for generating certain meshes).
- Familiarise yourself with `Cameras`, `Renderers` and `Viewports`: Modify the Game state to include a third `Viewport`.
- Familiarise yourself with GUI scripts: in the resources folder you'll find a folder named Menu that contains various .gui files. These define GUI layouts of images, buttons, text etc. The element types correspond to Echo GUI classes. Play around with the menu elements. Try creating a couple of new buttons to click on in the Game state to speed up or slow down the spinning cube. You will need to create a function to change the speed and set up a new binding to make it available for GUI buttons (see the application file on how to set up bindings, but set the bindings up in Game.cpp using the provided `FunctionBinder`).
- Familiarise yourself with Tasks: Create a custom `Task` to periodically toggle the visibility of the Sphere (or if you didn't create one, the cube).
If you're happy with your progress so far you can move onto a more advanced project by creating a third person game using the provided project template. The third person game template is a little more complicated that the simple application. It provides examples of:
- Using a `ContextSwitcher` to manage application states.
- How you can get values from a `Configuration` object,
- Creating a custom `Camera` controller task to follow a character
- How to create and use `MappedInputDevices`
- How to create a generic game entity class that has discrete states defined by animations, physics bodies
- How to create a `BulletPhysicsWorld` and add `PhysicsBody` instances to it.