This is an old revision of the document!
Table of Contents
OpenBEAT Developer guide
Building from subversion
OpenBEAT uses multimodule projects as proposed by the Apache Maven project. We use Maven to build our project and create distributable binaries. To be able to build the code from subversion it should suffice to follow the direction on this page. However, we recommend that you get aquinted with Maven by reading up on the project on its website as well as the online book Maven: The Definitive Guide.
Getting OpenBEAT
When you are building OpenBEAT you should check out the current development branch on trunk. As of May 19 2009 there additional folders in trunk, not directly related to the source code of the project. Hence, we recommend you only checkout the openbeat folder in trunk with the following command:
svn co http://cadia.ru.is/svn/repos/OpenBEAT/trunk/openbeat
This will give you a directory structure like this:
- openbeat/
- openbeat/pom.xml
- openbeat/openbeat-behavior
- openbeat/openbeat-bml
- openbeat/openbeat-bmlrealizer
- openbeat/openbeat-core
- openbeat/openbeat-discourse
- openbeat/openbeat-dist
- openbeat/…
We will focus on working in the top level directory which enforces default settings for all submodules, e.g. plugin settings and versioning of 3rd party dependencies. There is however a one special submodule, openbeat-dist which is the distribution module. From that location we have to invoke a special assembly command which creates a zip bundle with all dependencies and runnable scripts to launch OpenBEAT.
Building from command line
The current development release of OpenBEAT expects at least JDK 1.6 to be present on the development machine. Building OpenBEAT is as easy as executing
mvn clean install
which will compile, test, package and install the OpenBEAT modules into your local Maven repository, including source packages. Following commands are very useful:
| Command | Description |
|---|---|
mvn clean | to remove all build artifacts |
mvn compile | to compile sources |
mvn test | to run all tests |
mvn install | to install artifacts into local repository |
Developing with IntelliJ
The team used IntelliJ IDEA while developing OpenBEAT. IntelliJ integrates nicely with Maven and can generate IntelliJ projects based on the maven projects. Let's assume we have checked out the source as described above and have IntelliJ running. Let's create an IntelliJ project to build and develop further on OpenBEAT.
Create new IntellIJ project
Screenshots.
Make changes to OpenBEAT
Screenshots.
Create 3rd party extension
Screenshots.