Getting Started with Code

From AvoCADoWiki

Jump to: navigation, search

This page is meant to help new developers get setup with avoCADo's code.

Anyone can play with avoCADo's code on their own system. However, if you would like to submit your changes back to the code repository, just send an email with a short description of your ideas to whollyguacamole. We are always looking for new members to join the avoCADo team!

Setting up avoCADo in Eclipse

There are many IDE's and editors, but Eclipse is probably the easiest and most straight-forward way to get things up and running quickly.

Eclipse is an Integrated Development Environment (IDE) written in java that allows programmers to quickly build java applications. avoCADo was originally built using Eclipse so things should behave nicely if you choose to do the same.

If you do not have it already, download and install Eclipse SDK.

avoCADo uses Subversion (SVN) to handle version control of the code. Each update is indexed and changes can easily be undone at any time if new changes to the code produce unwanted effects. SVN also adds a nice safety net against someone potentially trying to erase or maliciously modify large amounts of code since all of their changes can be reverted with just a few simple commands. You will need subversion, so check out the subversion packages to download things and get started.


Eclipse does not initially support projects using SVN version control, but a simple plug-in (Subclipse) can be used to allow it.

  • load Eclipse
  • click on Help -> software updates -> Find and install -> Search for new features
  • click "new remote site" and add "http://subclipse.tigris.org/update"
  • do as indicated to install the plugin


Now it's time to add avoCADo as a project in Eclipse!

  • load Eclipse
  • click File -> Import
  • click on Other -> Checkout project form SVN
  • click create a new repository location
  • use the url: https://avocado-cad.svn.sourceforge.net/svnroot/avocado-cad
  • checkout the folder "Trunk" since that contains all of avoCADo's code
  • checkout as a project in the workspace and give it a name (like "avoCADo")


You should now have access to the code.. but it probably won't compile yet for a few reasons...

  • JOGL is needed (Java Open GL library, to handle all of the lower-level 3D graphics)
    • get JOGL.
    • include JOGL in the avoCADo build path by right clicking on the project and selecting properties.
    • add jogl.jar to the buildpath.
  • SWT is needed (to handle the OS dependent look and feel of buttons, interactions, and event handling)
    • get SWT from www.eclipse.org/swt.
    • In Eclipse goto: File -> Import... -> Existing Projects into Workspace
    • select "Select archive file:" and point to the swt-3.4-xxxx.zip file you downloaded.
    • verify that org.eclipse.swt now exists as a project in your workspace.
    • right click on the avoCADo project and select Build Path -> Configure Build path...
    • select the "projects" tab and add org.eclipse.swt.
  • Java 1.6 or above is needed (get the latest version of java. avoCADo will not work with java 1.5 and before)
Personal tools