File	Date	Author	Commit
colorbox	2014-06-13	Z. Cliffe Schreuders	[b597fa] view review submissions in a lightbox
images	2014-01-02	Z. Cliffe Schreuders	[94f50a] Initial commit
ims-blti	2014-01-02	Z. Cliffe Schreuders	[94f50a] Initial commit
jqplot	2014-01-02	Z. Cliffe Schreuders	[94f50a] Initial commit
spreadsheet example	2014-01-02	Z. Cliffe Schreuders	[94f50a] Initial commit
templates	2014-10-22	Z. Cliffe Schreuders	[bb74fc] regexp filter updates
.gitignore	2014-01-02	Z. Cliffe Schreuders	[94f50a] Initial commit
LICENSE	2014-06-13	Z. Cliffe Schreuders	[6bad54] GNU Affero General Public License
README	2014-06-06	Z. Cliffe Schreuders	[26a55e] file uploads feature (configured via cell next ...
config.php	2014-11-03	Z. Cliffe Schreuders	[7e5334] targetted spreadsheet range requests, to reduce...
download_submissions.php	2014-09-02	Z. Cliffe Schreuders	[7574b4] timeout and log out
helpers.php	2014-11-03	Z. Cliffe Schreuders	[7e5334] targetted spreadsheet range requests, to reduce...
logout.php	2014-09-02	Z. Cliffe Schreuders	[7574b4] timeout and log out
php.ini	2014-09-18	Z. Cliffe Schreuders	[f1df4c] allow more memory usage
submit_review.php	2014-10-22	Z. Cliffe Schreuders	[bb74fc] regexp filter updates
upload.php	2014-09-03	Z. Cliffe Schreuders	[ceebc3] cyberciege submissions and win condition flagging
upload_cyberciege_logs.php	2014-10-22	Z. Cliffe Schreuders	[2c24eb] don't show cc upload feedback
view_submissions.php	2014-09-02	Z. Cliffe Schreuders	[7574b4] timeout and log out
xp.php	2015-06-29	Z. Cliffe Schreuders	[b6d6c0] clearer error message when failing to connect t...

Read Me

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
                               My XP                               

               Copyleft (ↄ) 2014 Z. Cliffe Schreuders               
                   z.cliffe {-at-} schreuders.org                   
                   http://z.cliffe.schreuders.org                   

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Please let me know if you make use of this code.

Small donations welcome.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

My XP is a virtual learning environment (VLE) for gamification of 
education, and is implemented as a Basic LTI extension.

My XP has been tested with Blackboard, but should also be compatible 
with other VLEs.

--------------------------------------------------------------------

To use My XP:
  1) Using your everyday or corporate Google account, upload a copy 
     of the example spreadsheet (converting to a Google spreadsheet).
  2) Enter student details, matching the IDs used in your VLE.
  3) Create a new Google account, and share a copy of the 
     spreadsheet with your new Google account (your new account only 
     needs read access to the spreadsheet).
  4) Upload My XP to a Web server.
  5) Edit the php.ini file to point to where you want to save tempory
     files.
  6) Edit the My XP config file (config.php), and enter:
    - a new shared consumer key and secret (just randomly generate 
      some nicely random strings)
    - the username and password for your new Google account, which 
      has read access to your spreadsheet
    - the spreadsheet URL
    - the date the semester starts and ends
    - the location on the Web server of the Zend library path
  7) Replace the banner image in images/banner.png
  8) In your VLE, configure it to add a Basic LTI tool provider, and
     enter the URL of xp.php, and the various shared secrets.
  9) Define quests, including descriptions, feedback and XP rewards 
     in the spreadsheet.
  10) Expose a link to the My XP Basic LTI tool to students.
  11) Mark students work by copying a quest feedback item into the 
      student row. XP rewards will be automatically applied.
  12) Enjoy.


--------------------------------------------------------------------

Note that the contents of the back end spreadsheet are not validated 
before use, and cell contents are rendered directly within the HTML. 
This means that the spreadsheet contents need to be carefully 
considered, tested, and protected.

--------------------------------------------------------------------

Please share your experiences, and any improvements to the code.

--------------------------------------------------------------------