Skip to content

Commit

Permalink
Add troubleshooting and Moving Forward page
Browse files Browse the repository at this point in the history
  • Loading branch information
kb5 committed May 9, 2018
1 parent 7794bbb commit b5ebdc3
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 1 deletion.
Binary file added docs/_static/SongMatch.pdf
Binary file not shown.
Binary file removed docs/_static/cube_jam.pdf
Binary file not shown.
14 changes: 13 additions & 1 deletion docs/index.rst
Expand Up @@ -32,7 +32,7 @@ Each round the length of the sequence increases, until you reach the end of the

Please view our `User's Guide <_static/cube_jam.pdf>`_ for detailed information on how to play the game.

:download:`Download User's Guide <_static/cube_jam.pdf>`
:download:`Download User's Guide <_static/SongMatch.pdf>`

.. toctree::
:caption: Getting Started
Expand All @@ -56,6 +56,18 @@ Please view our `User's Guide <_static/cube_jam.pdf>`_ for detailed information

pages/dependencies

.. toctree::
:maxdepth: 1
:caption: Troubleshooting

pages/troubleshoot

.. toctree::
:maxdepth: 1
:caption: Future Expansion

pages/moving_forward

.. toctree::
:maxdepth: 1
:caption: About
Expand Down
21 changes: 21 additions & 0 deletions docs/pages/moving_forward.rst
@@ -0,0 +1,21 @@
Moving Forward
==============

Some Ideas for Moving Forward with the Project
----------------------------------------------

We had many great ideas for this project, unfortunately, the semester is only so long and we could not fit all of our ideas in this package.
We coded this project with the thought of making it easy to make changes or expanding in the future.

We originally were going to name the project "Cube Jam" with the thought that we would have multiple games to play based on the sense of hearing.

Other game ideas included:
* An Ear Training game: This would be a game where a note would be played, and the player would have to guess what the note was by tapping the appropriate cube. This game mode could also train relative pitches.
* A duet mode: In duet mode, the player would play along WITH Cozmo, not so much against him. A game based on collaboration and not so much competition.

Other ideas on how to expand could include:
* Add a cube pagination menu
* Add additional difficulty levels
* Add more instruments
* Add additional songs
* Add a baton prop that Cozmo could use to point to the cubes
24 changes: 24 additions & 0 deletions docs/pages/troubleshoot.rst
@@ -0,0 +1,24 @@
TroubleShooting
===============

Problems with Cozmo
-------------------
If the game does not start after running the correct command:

* Cozmo will not start the game if he can not see the cubes. Most of the time this is because he is not back far enough to see all the cubes, or his arm bar is blocking his view. To fix this, make the appropriate adjustments and the game should start. More information for this can be found in the user guide "Basic Set-up Instructions" on page 5.

:download:`Download User's Guide </_static/SongMatch.pdf>`

Problems with Cubes
-------------------
If you tried #1 and the game is still not starting:

* If you tried the above and the game still is not starting, it is possible that the cubes ran out of juice. Try replacing the batteries. From Anki's website, they claim the batteries in the cubes will last about 40 hours. The cubes take a N, E90, LR1 1.5Volt battery. For more information, check out:

https://support.anki.com/hc/en-us/articles/115000439767-COZMO-How-to-replace-a-Cube-battery

Problems with the Application
-----------------------------
If Cozmo or the game becomes unresponsive in the middle of playing:

* Close the application and re-launch the game using the python command ``python3 main.py``.

0 comments on commit b5ebdc3

Please sign in to comment.