IDE Setup for CS 465 Ray I Assignment

This is a guide aimed at people who are familiar with Java, but not familiar with software development. After reading this document, you will be able to use Eclipse to complete the programming assignments in this course.

What is an IDE, and why do I need one?

IDE stands for integrated development environment. An IDE is a program that combines a source code editor, a compiler, and usually a debugger. You could solve all of the programming assignments in this course using nothing more than Windows Notepad and javac. But that would be painful. An IDE provides all sorts of nice features that a basic text editor, and the command line compiler, don't.

What IDE should I use?

There are several choices for a Java IDE. The course staff recommends Eclipse, and most of the support will be geared towards Eclipse. You are still welcome to use any other IDE that you prefer, but bear in mind that the TA's might not be familiar with IDE's other than Eclipse.

How do I get Eclipse?

Eclipse is available under a free, open-source license from You want the Eclipse SDK for the platform of your choice. It's a big file (120 MB for Windows), but is available by bittorrent. It is possible (even probable) that Eclipse is already installed on some of the lab machines, but you would need to check on a machine-by-machine basis.

How do I install Eclipse?

Extract the zip file that you downloaded somewhere. It should contain an eclipse directory. Inside that directory, there should be an eclipse executable. Run it. That's all there is!

OK, I'm running Eclipse. Now what?

Everything in Eclipse is centered around projects. A project basically corresponds to a related set of software. For example, you will probably setup a project for each programming assignment in this course. The first thing you will need to do is create a new project. (Note: these instructions are based on Eclipse 3.1. The current version is 3.2, and may be slightly different, but should be pretty much the same).

  1. Go to File->New->Project...
  2. Select "Java Project" and hit Next.
  3. Give your project a name. "CS465 Ray1" or whatever you like.
  4. Choose "Create project from existing source"
  5. Enter the directory where your copy of the assignment code is (you should have already downloaded the assignment code from the course webpage, and extracted the zipfile). Note that this is NOT the ray/ directory in the framework code zip file. It is whatever directory contains the ray/ directory. Note that this should not be on the hard drive of a lab machine -- they are not backed up, and are subject to be wiped at any time. If you are using a lab machine, use your network drive to store your files.
    /wherever/you/put/this/on/your/machine/    <--- eclipse project root points here
        etc. etc.
  6. Under JDK Compliance, select "Use a project specific compliance." Choose 1.4. (Technical digression: The Ray1 project is written in Java 1.4, and you will get warnings if you use Java 1.5. You can ignore these warnings, but I prefer my code to not have any warnings. Alternatively, you could edit the framework code to bring it up to Java 1.5 compliance.)
  7. Hit Finish.

I have an Eclipse project setup. Now how do I use it to write code?

Another Eclipse notion that you need to understand besides projects is perspectives. A perspective is a way of laying out the frames in the Eclipse window, and what data those frames contain. The Java perspective is the one you will probably want to use.

The Window menu allows you to Open Perspective. There's also a button that does the same thing in the upper right part of the screen. Open the Java perspective if it isn't already open.

On the left side of the screen, you should see the Package Explorer (if you don't, go to Window->Open View->Package Explorer). This shows the tree of java packages in your project. Hit the + sign next to an element to expand it. You should see files, which you can double click to open. Now you can start writing code.

The File->New menu will let you add a new class to your project. Follow the instructions in the dialog box -- it's pretty self-explanatory if you are familiar with Java.

Play around with the menus, and right click on things. You'll find features that you like. Most of it is pretty intuitive. And the Eclipse Help files are extensive.

I've written some code, and I want to test it. How do I run my application?

The main method of the assignment is located in Right click on that file in Package Explorer, and choose Run As->Java Application. You can also do this from the Run->Run... menu. The program takes in command line arguments, which you will need to provide. This can be done from the Run... dialog. Choose the Arguments tab, and provide your command line arguments. For this project, the program expects the names of XML scene files as its arguments.

If you have any questions, contact the staff mailing list, or come to a help session, or office hours.