1.0 Install Required Packages

These resources are required for to both run and develop the Hackystat Visual Studio Sensor.

NOTE:

This guide assumes that you have registered for Hackystat and possess both the email and password that are registered. If you have not registered or do not have the email and password combination please register here.

2.0 Check Out the Source

Check out the source from the trunk of the Google Project repository. The URL is:

The Hackystat Visual Studio Sensor Source Page has more instructions.

You can also download the latest distribution which is a featured download on the homepage.

The code needs to be checked out or unzipped to a directory that is contained in subdirectory of a base directory (shown below for clarification):

3.0 Setting Up Project for Development

3.1 Add-in Modifications

After finding the directory that you checked the Sensor Project out to:

• Open the directory that you checked out the sensor project to.
• Open the Solution .sln file to open the sensor project in Visual Studio.
• Rebuild the solution by going to "Build" menu and selecting "Rebuild Solution" or by right clicking on the Solution in the "Solution Explorer" and selecting the "Rebuild Solution" option.

Create the VisualStudioSensor.AddIn to allow the sensor to be used in development and debugging.

• Open the directory that you checked out the Sensor project to.
• Run the addin-create.bat to create the basic .AddIn file
• Edit the "VisualStudioSensor - For Testing.AddIn" that is created using a text editor

• Add the full path to

  <assembly>

  VisualStudioSensor.dll

  </assembly>

  (shown in the red box). The full path should be: {full path to the directory the project was checked out to}\VisualStudioSensor\bin\VisualStudioSensor.dll

Move the VisualStudioSensor.AddIn to the appropriate directories for debugging and use.

• Run the addin-setup.bat to move the.AddIn file to the appropriate places.

3.2 Checking the Debug Path

Some modifications may have to be made to the project so that it can be debugged on your computer.

• Go to the "Solution Explorer" window and right click on the VisualStudioSensor project in the solution and select the "Properties" option.

• On the GUI that appears click on the "Debug" tab and make sure that "Start external program" and "Working directory" paths match the location of your devenv.exe file. (NOTE: 32-bit OS users should have the path C:\Program Files\... and 64-bit OS users should have the path C:\Program Files (x86)\...)

• Now rebuild the solution by going to the Build menu and selecting "Rebuild Solution." You can also right click on the Solution in the "Solution Explorer" window and selecting "Rebuild Solution."

3.3 sensorshell.jar

• Place the sensorshell.jar into {full path to the directory the project was checked out to}\VisualStudioSensor\bin\. It should be in the same directory as the VisualStudioSensor.dll.

3.4 sensorshell.properties

Place the sensorshell.properties in the .hackystat directory.

• Place the sensorshell.properties in your {USERPROFILE}\.hackystat\sensorshell\ directory.
• Open the file in a text editor and put in the URL of the server, your email address (that is registered with the Hackystat server), and your Hackystat password. (More Information Here)

• The project should now be ready for development and use.

NOTE:

If the sensor cannot find your JavaHome path or the full path of the sensor shell it will display a GUI on startup that will allow you to point the sensor to correct path. If one of the paths are missing the sensor will show the other path that is okay. The GUI looks like this:

4.0 Creating a Distribution

• Use the dist.build.bat to create a directory named "VisualStudioSensor" that contains all the files needed in the distribution.
• The directory is located in

  {BASE_DIRECTORY}\build\dist\VisualStudioSensor

• The folder should be renamed to VisualStudioSensor-{Major_Version_Number}.{Minor_Version_Number}.{MMDD} where M = the month and D = the day the distribution was created
• The folder can now be zipped

5.0 Accessing the Logger

• To access the Logger for the sensor go to the "View" menu and select the "Output" option:

• At the bottom of the screen the logger should now be visible as shown below:

• If the logger is not selected as the output, use the drop down menu ("Show output from:") to select "Hackystat Sensor Log"