README.rst

   1 PlayJam GameStick API server
   2 ****************************
   3
   4 Makes PlayJam GameSticks usable after the official server had been shut down
   5 in 2017.
   6
   7
   8 Setup
   9 =====
  10
  11 1. Copy ``config.php.dist`` to ``config.php``
  12 2. Clone the `game data repository <https://codeberg.org/gamestick-fans/game-data>`_::
  13
  14      $ git clone https://codeberg.org/gamestick-fans/game-data.git
  15 3. Unpack one of the cache files::
  16
  17      $ gunzip -k game-data/caches/2017-01-12T00\:19\:12-alex.shorts.pretty.json.gz
  18 4. Generate the popular and featured menus from the cache file,
  19    and extract the translation strings::
  20
  21      $ ./bin/exract-all.sh 'game-data/caches/2017-01-12T00:19:12-alex.shorts.pretty.json'
  22 5. Fill the caches for this API::
  23
  24      $ ./bin/generate-apps-cache.php game-data/classic/
  25 6. Setup the Apache web server and point the virtual host to the ``www/`` directory.
  26
  27
  28 Firmware updates
  29 ================
  30 Firmware update diff files are needed.
  31 It is possible to send out full firmware files, but they
  32 will reset the user data.
  33
  34 When you have such an update, put it into ``www/firmware/$version/update.img``
  35 and run ``./bin/prepare-firmware.sh www/firmware/$version/``.
  36
  37
  38 About
  39 =====
  40 This server software was written by `Christian Weiske <https://cweiske.de/>`_
  41 and is licensed under the AGPL v3.