README.rst

   1 **************************
   2 stouyapi - Static OUYA API
   3 **************************
   4
   5 A static API for the OUYA gaming console that still lets you sign in
   6 and install games, despite the OUYA server shutdown in 2019.
   7
   8
   9 =====
  10 Setup
  11 =====
  12
  13 OUYA config change
  14 ==================
  15 - Mount via USB (Micro USB cable)
  16 - Create file ``ouya_config.properties``
  17 - Add::
  18
  19     OUYA_SERVER_URL=http://stouyapi.boo
  20     OUYA_STATUS_SERVER_URL=http://stouyapi.boo/api/v1/status
  21
  22 The changes should take effect immediately.
  23 If they do not, reboot the OUYA once.
  24
  25
  26 OUYA setup
  27 ==========
  28
  29 1. User registration: "Existing account"
  30 2. Enter any username, leave password empty. Continue.
  31 3. Skip credit card registration
  32
  33
  34 Apache setup
  35 ============
  36 Virtual host configuration::
  37
  38   Script PUT /empty-json.php
  39   Script DELETE /api/v1/queued_downloads_delete.php
  40
  41 ``mod_actions`` need to be enabled for apache 2.4.
  42
  43 The virtual host's document root needs to point to the ``www`` folder.
  44
  45
  46 Building API data
  47 =================
  48 Download the OUYA game data repository from
  49 https://github.com/ouya-saviors/ouya-game-data
  50 and then generate the API files with it::
  51
  52     $ git clone https://github.com/ouya-saviors/ouya-game-data.git
  53     $ ./bin/import-game-data.php ouya-game-data/folders
  54
  55
  56 Building the web discover store
  57 ===============================
  58 After building the API files, generate the HTML::
  59
  60   $ ./bin/build-html.php
  61
  62
  63 ===============
  64 Push to my OUYA
  65 ===============
  66 stouyapi's HTML game detail page have a "Push to my OUYA" button that
  67 allows anyone to tell his own OUYA to install that game.
  68 It works without any user accounts, and is only based on IP addresses.
  69
  70 If your PC that you click the Push button on and your OUYA have the same
  71 public IP address (IPv4 NAT), or the same IPv6 64bit prefix, then
  72 the OUYA will install the game within 5 minutes.
  73
  74 It will also work if you run stouyapi inside your local network, because
  75 all private IP addresses are mapped to a special "local" address.
  76
  77 You can inspect your own download queue by simply opening
  78 ``/api/v1/queued_downloads`` in your browser.
  79
  80
  81 ========
  82 See also
  83 ========
  84
  85 - https://gitlab.com/devirich/BrewyaOnOuya - alternative storefront
  86 - https://archive.org/details/ouyalibrary - Archived OUYA games
  87 - https://github.com/ouya-saviors/ouya-game-data/ - OUYA game data repository
  88
  89
  90 ===========
  91 Discoveries
  92 ===========
  93
  94 - data/data/tv.ouya/cache/ion/
  95
  96   - image cache for main menu image
  97
  98 - Don't put a trailing slash into ``OUYA_SERVER_URL`` - it will make double slashes