⚡ Document History

The recommended way to set up your system and build Echo is to do the following. =Installing Dependencies= ==Prerequisites== # Ensure you have [[tools|Mercurial]] installed first. # Ensure you have access to [[/diffusion|the repositories]]. ==On Unix-like platforms (Linux, BSD)== # Clone the {rEE} Echo repository into the desired location: ## Open a Terminal and navigate to the directory where you want to clone into (e.g. `~/dev`) ## In a browser, navigate to the {rEE} page and click the {nav icon=download, name=Clone} button. This will show a URL to our server's copy of the project ## Run the command `hg clone` followed by the URL determined above; e.g. `hg clone https://developer.emblem.net.au/source/echo3/` # Navigate to the newly-cloned location in the Terminal (e.g. `~/dev/echo3`). # Run `./build.sh` ## Alternatively, after cloning, you can open the cloned folder as a workspace in [[https://code.visualstudio.com/|Visual Studio Code]] (a free and open source code editor [[https://linuxize.com/post/how-to-install-visual-studio-code-on-ubuntu-20-04/|installable via]] `sudo snap install --classic code`). ## Note that all options require build tools for C++, such as `cmake`, `make` and the `g++` compiler. If it doesn't work, see [[tools/gpp/|Installing g++]]. NOTE: Below instructions need to be reviewed as they are out of date. The build commands specifying the config below are old. NOTE: Before continuing with development you will need to logout then back in so your environment includes the Echo environment variables. Alternatively, when using a terminal you can type `source ~/.profile` and the environment variables will be set for that terminal session. Not doing one of these two things will result in compile and link errors as Echo and dependencies won't be found. ==On Windows== See [[projects/echo_3/building/windows/|Development on Windows]]. =Building Echo= The installer script will attempt to build Echo for all targets that were selected (including Debug and Release for Linux). If you want, or need to, to build manually you can do any one of the following: - Navigate to the cloned Echo directory and run `./BuildEcho.sh`. The default platform is linux. You can specify the platform you want using `PLATFORMS=platformname ./BuildEcho.sh` where `platformname` is the lowercase name of the platform. At the time of this writing the following were available: `linux, android, wii, windowscross`. - Navigate to the `echo3` project folder and issue the command `make CONF=Release` to build a Linux Release build, `CONF` can be set to the platform configuration you want to target. For example `make CONF=Wii` builds the Wii configuration. You can see possible configurations by opening `echo3/nbproject`. Each configuration has a makefile. - Open the `echo3` project in [[tools/netbeans|NetBeans]] and build using the IDE. **Note that the project will only open if the C++ NetBeans module is installed else Netbeans will error with `<unrecognized project; missing plug-in?>`. =Verifying things worked= You should receive output if there were errors to the above processes. The installer will output the build result to a `buildlogs` folder that you can inspect to find errors. Please Please [[https://developer.emblem.net.au/maniphest/task/edit/form/1/|report errors]] that you come across since we do want the process to be error free when possible. To verify that everything built and that you can run an Echo project you can run the tests. ``` make test ``` Will run through the unit tests for the library. A lot of these tests are graphical and are set to timeout after 30 seconds or so but you can close windows early. If 30 seconds elapses and the window doesn't close, chances are we forgot to add the timeout. Please [[/maniphest/task/edit/form/1/|report it]] so we can fix it. Once you're satisfied and have had fun playing with the tests you can move to the [[projects/echo_3/getting_started/|Getting started]] page for information on building an application.

=Installing Prerequisites=The recommended way to set up your system and build Echo is to do the following. =Installing Dependencies= ==Prerequisites== # Ensure you have [[tools|Mercurial]] installed first. # Ensure you have access to [[/diffusion|the repositories]]. ==On Unix-like platforms (Linux, BSD)== # Clone the {rEE} Echo repository into the desired location: ==On Ubuntu-based Linux==## Open a Terminal and navigate to the directory where you want to clone into (e.g. `~/dev`) Enter these commands into the Terminal:## In a browser, navigate to the {rEE} page and click the {nav icon=download, name=Clone} button. This will show a URL to our server's copy of the project sudo apt-get update## Run the command `hg clone` followed by the URL determined above; e.g. `hg clone https://developer.emblem.net.au/source/echo3/` sudo apt-get install g++ build-essential -y# Navigate to the newly-cloned location in the Terminal (e.g. `~/dev/echo3`). sudo apt-get install libbullet-dev libmodplug-dev libogg-dev libfreetype6-dev libopenal-dev libsigc++-2.0-dev \# Run `./build.sh` libgtkglext1-dev libboost-all-dev libpng12-dev libprotobuf-dev libvorbis-dev libglew-dev libgtkmm-2.4-dev \## Alternatively, after cloning, you can open the cloned folder as a workspace in [[https://code.visualstudio.com/|Visual Studio Code]] (a free and open source code editor [[https://linuxize.com/post/how-to-install-visual-studio-code-on-ubuntu-20-04/|installable via]] `sudo snap install --classic code`). libgtkglextmm-x11-1.2-dev libtinyxml-dev libutfcpp-dev libgtkmm-2.4-dev libgtkglextmm-x11-1.2-dev -y## Note that all options require build tools for C++, such as `cmake`, `make` and the `g++` compiler. If it doesn't work, see [[tools/gpp/|Installing g++]]. NOTE: Below instructions need to be reviewed as they are out of date. The build commands specifying the config below are old. NOTE: Before continuing with development you will need to logout then back in so your environment includes the Echo environment variables. Alternatively, when using a terminal you can type `source ~/.profile` and the environment variables will be set for that terminal session. Not doing one of these two things will result in compile and link errors as Echo and dependencies won't be found. This should install the Boost Libraries; however, if you're having difficulties, see [[technical_documents/installing_or_upgrading_boost/|Installing or upgrading boost]]. See also [[tools/gpp/|Installing `g++`]]. ==On Windows== See [[projects/echo_3/building/windows/|Development on Windows]]. =Building Echo= The installer script will attempt to build Echo for all targets that were selected (including Debug and Release for Linux). If you want, or need to, to build manually you can do any one of the following: - Navigate to the cloned Echo directory and run `./BuildEcho.sh`. The default platform is linux. You can specify the platform you want using `PLATFORMS=platformname ./BuildEcho.sh` where `platformname` is the lowercase name of the platform. At the time of this writing the following were available: `linux, android, wii, windowscross`. Ensure you have Mercurial installed:- Navigate to the `echo3` project folder and issue the command `make CONF=Release` to build a Linux Release build, `CONF` can be set to the platform configuration you want to target. For example `make CONF=Wii` builds the Wii configuration. You can see possible configurations by opening `echo3/nbproject`. Each configuration has a makefile. sudo apt-get install mercurial- Open the `echo3` project in [[tools/netbeans|NetBeans]] and build using the IDE. **Note that the project will only open if the C++ NetBeans module is installed else Netbeans will error with `<unrecognized project; missing plug-in?>`. You should have access to [[diffusion|the repositories]].=Verifying things worked= Clone [[diffusion/EE|Echo3 ]] (assuming a working directory of `~/Projects`):You should receive output if there were errors to the above processes. The installer will output the build result to a `buildlogs` folder that you can inspect to find errors. Please Please [[https://developer.emblem.net.au/maniphest/task/edit/form/1/|report errors]] that you come across since we do want the process to be error free when possible. hg clone https://phabricator.seantasker.com/diffusion/EE/echo3/ ~/Projects/To verify that everything built and that you can run an Echo project you can run the tests. These instructions assume that you now have the following directory structure: - `~` (home or user directory)``` -- `Projects`make test --- `echo3` Open the `echo3` project in [[tools/netbeans|NetBeans]] and Build from there``` Will run through the unit tests for the library. A lot of these tests are graphical and are set to timeout after 30 seconds or so but you can close windows early. If 30 seconds elapses and the window doesn't close, chances are we forgot to add the timeout. Please [[/maniphest/task/edit/form/1/|report it]] so we can fix it. Once you're satisfied and have had fun playing with the tests you can move to the [[projects/echo_3/getting_started/|Getting started]] page for information on building an application.

Version 4 vs 37

Edits

Content Changes