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 The username will appear on your ouya main screen.
  34
  35
  36 Apache setup
  37 ============
  38 Virtual host configuration::
  39
  40   Script PUT /empty-json.php
  41   Script DELETE /api/v1/queued_downloads_delete.php
  42
  43 ``mod_actions`` and ``mod_expires`` need to be enabled for apache 2.4.
  44
  45 The virtual host's document root needs to point to the ``www`` folder.
  46
  47
  48 Building API data
  49 =================
  50 Download the OUYA game data repository from
  51 https://github.com/ouya-saviors/ouya-game-data
  52 and then generate the API files with it::
  53
  54     $ git clone https://github.com/ouya-saviors/ouya-game-data.git
  55     $ ./bin/import-game-data.php ouya-game-data/folders
  56
  57
  58 Building the web discover store
  59 ===============================
  60 After building the API files, generate the HTML::
  61
  62   $ ./bin/build-html.php
  63
  64
  65 ===============
  66 Push to my OUYA
  67 ===============
  68 stouyapi's HTML game detail page have a "Push to my OUYA" button that
  69 allows anyone to tell his own OUYA to install that game.
  70 It works without any user accounts, and is only based on IP addresses.
  71
  72 If your PC that you click the Push button on and your OUYA have the same
  73 public IP address (IPv4 NAT), or the same IPv6 64bit prefix, then
  74 the OUYA will install the game within 5 minutes.
  75
  76 It will also work if you run stouyapi inside your local network, because
  77 all private IP addresses are mapped to a special "local" address.
  78
  79 You can inspect your own download queue by simply opening
  80 ``/api/v1/queued_downloads`` in your browser.
  81
  82
  83 ========
  84 See also
  85 ========
  86
  87 - https://gitlab.com/devirich/BrewyaOnOuya - alternative storefront
  88 - https://archive.org/details/ouyalibrary - Archived OUYA games
  89 - https://github.com/ouya-saviors/ouya-game-data/ - OUYA game data repository
  90
  91
  92 ===========
  93 Discoveries
  94 ===========
  95
  96 - data/data/tv.ouya/cache/ion/
  97
  98   - image cache for main menu image
  99
 100 - Don't put a trailing slash into ``OUYA_SERVER_URL`` - it will make double slashes