How To Build Emma

From Emma

Contents

[edit]

Emma WIN32 - Microsoft Visual Studio .NET 2003 ( 7.1 )

1) Get the emma tree (emma/mainline)

2) Download and install latest DirectX SDK from microsoft.com/directx. 

  NOTE: Make sure to download the SDK, and not just the runtime!

3) Install some Cygwin packages:

3a) Go to http://www.cygwin.com/ and select "Install or update now!!!"
3b) Double click on the setup.exe icon and make all the default selections until you get to "Choose a download site". I always use ftp://mirrors.kernel.org. But you choose whichever one you like.
3c) When it gets to "select packages" leave everything default, except go into Devel and click on the arrows for bison, until it says 1.875-1.
3d) Click Next and wait for it to finish
3e) Cygwin is now installed. Now go into MSDev and select Tools->Options. Then select Projects->VC++ Directories. Then select the Executable files dropdown and add the path 'C:\cygwin\bin'. Make sure to add it last!

4) If you have checked out the subversion tree and are building out of that tree you can include your current subversion changelist in the build ID (printed in the console on startup). To do this follow these steps:

4a) Install the svn command line app. Get it from: 
  http://subversion.tigris.org/project_packages.html
and install the latest version of the win32 command line app from there. Make sure you install this in the default place. To check for proper installation, open a cygwin shell and type 'svn'. It should respond with "Type 'svn help' for usage." If not, please post a question on the emma3d mailing list.
4b) Add a directory to your MSDev executable directories list. This is at Tools->Options->Projects->VC++ Directories. Select Show Directories for: "Executable files" and add: 
c:\Program Files\Subversion\bin
Now sync, build, run emma and open a file. You should see Version and Build lines in the console.

5) If you want to use the Emma Mozilla Plugin, you should create a registry key: 

key         : HKEY_CURRENT_USER\\SOFTWARE\\emma3d.org\\Emma
string value: "Install Directory" 
data        : C:\svn\emma\mainline\emma\bin\debug

or wherever your debug output location is. Debug version of npemma.dll is copied into the plugins directory of Firefox by default.

In Mozilla, type "about:plugins" and make sure you see 'Emma plugin' in the list of plugins.

If you want the 'Debug' build to automatically copy the plugin to the Mozilla Firefox plugins folder, define this environment variable on your PC: EMMA_BUILD_INSTALLS_PLUGINS=1

6) Run mainline/emma/InstallDependencies.bat

7) Open emma/mainline/emma/emma.sln and build all.

8) If you had no build errors, try loading some content (e.g. a .ema file) from emma\mainline\emma\content. You can either run emma\mainline\emma\debug\EmmaMFCApp.exe or if you set up the Mozilla Plugin, open up the file in Mozilla. If it loads, congratulations!

[edit]

EMMA WIN32 - CodeBlocks

1) Run all the steps above, ignoring the Visual Studio specific actions.

2) Add the executables directory of Cygwin at the end of your PATH, for example PATH= ... ;C:\cygwin\bin;

3) Open emma/mainline/emma/emma.workspace and build.

[edit]

Emma MacOS - automake


[edit]

Emma Linux - automake


[edit]

Emma Documentation

1) Download and install the latest doxygen : 

http://www.stack.nl/~dimitri/doxygen/[1]

2) Run emma\mainline\docs\doxygen\CDK\doxygen.bat and emma\mainline\docs\doxygen\SDK\doxygen.bat

3)Open these: 

mainline/docs/doxygen/CDK/output/html/index.html
mainline/docs/doxygen/SDK/output/html/index.html

for Emma CDK and SDK documentation.

Retrieved from "http://emma3d.sourceforge.net/wiki/index.php/How_To_Build_Emma"