Permalink
Browse files

Added package descriptions in java packages. Also typos

  • Loading branch information...
1 parent 10fbcae commit ae73dab60d7e37066540aeb9d83f793dd11afa3a @sparks sparks committed Jun 13, 2012
Showing with 26 additions and 1 deletion.
  1. +1 −1 README.md
  2. +12 −0 software/src/propinquity/hardware/package-info.java
  3. +13 −0 software/src/propinquity/package-info.java
View
@@ -3,4 +3,4 @@ Propinquity
Propinquity is a full-body game that is a hybrid between fighting and dancing games. Two players wear proximity sensors on different body parts and as they move to the music, different sensors patches on their bodies light up to indicate when they are active. The players attempt to get as close as possible to active patches on the other player’s body to score points. The longer s(he) can stay “in the sweet spot” (but without actually touching), the higher the resulting score.
-[Propinquity on the TAG webdsite](http://playpr.hexagram.ca/projects/?proj=2)
+[Propinquity on the TAG website](http://playpr.hexagram.ca/projects/?proj=2)
@@ -0,0 +1,12 @@
+/**
+ * <p>The low level hardware code and hardware abstractions have been decoupled and placed in this package. The intent is that many different hardware interface could be provided.</p>
+ *
+ * <p>Such hardware interface would implement the {@link propinquity.hardware.HardwareInterface} interface. For the moment there is the actual XBee implementation given in {@link propinquity.hardware.XBeeBaseStation} and the simulator which allows testing without XBees or actual hardware given in {@link propinquity.hardware.HardwareSimulator}. All data coming from hardware is passed back to registered listener objects which implement the {@link propinquity.hardware.ProxEventListener} interface.</p>
+ *
+ * <p>The package also contains the object which represent the actual hardware. Currently these are {@link propinquity.hardware.Glove} and {@link propinquity.hardware.Patch}.</p>
+ *
+ * <p>The {@link propinquity.hardware.Packet} object and the {@link propinquity.hardware.PacketType} enum, specify together the current packet format used for communication.</p>
+ *
+ * <p>Finally some rough debugging code is provided. In particular the {@link propinquity.hardware.HardwareDebugger} provided a rough interface to test hardware without running the full application.</p>
+ */
+package propinquity.hardware;
@@ -0,0 +1,13 @@
+/**
+ * <p>This software package is the graphical interface and command and control of the propinquity game. It is intended to be projected on the floor beneath the players. In addition controls all the customized hardware in the game. Finally it enforced where applicable game mechanics and scoring.</p>
+ *
+ * <p>Where possible the actual low level hardware code has been decoupled and placed in the {@link propinquity.hardware} package.</p>
+ *
+ * <p>The processing sketch file {@link propinquity.Propinquity} is the core of the program containing the draw loop and holding all the instantiated objects. Major components include the Level objects, Player objects. All level types subclass the abstract {@link propinquity.Level} object. Current implementations include {@link propinquity.ProxLevel} and the more rough {@link propinquity.BopperLevel} and {@link propinquity.HealthLevel}. The {@link propinquity.Player} represents a player, his score and it's visualisation. Setup and selections steps are done graphically using {@link propinquity.XBeeManager}, {@link propinquity.PlayerList}, {@link propinquity.PlayerSelect} and {@link propinquity.LevelSelect}.</p>
+ *
+ * <p>Propinquity is a full-body game that is a hybrid between fighting and dancing games. Two players wear proximity sensors on different body parts and as they move to the music, different sensors patches on their bodies light up to indicate when they are active. The players attempt to get as close as possible to active patches on the other player's body to score points. The longer s(he) can stay "in the sweet spot" (but without actually touching), the higher the resulting score.</p>
+ *
+ * <p><a href="http://playpr.hexagram.ca/projects/?proj=2">Propinquity on the TAG website</a></p>
+ */
+
+package propinquity;

0 comments on commit ae73dab

Please sign in to comment.