Update readme
[stouyapi.git] / 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
40 ``mod_actions`` need to be enabled for apache 2.4.
41
42 The virtual host's document root needs to point to the ``www`` folder.
43
44
45 Building API data
46 =================
47 Download the OUYA game data repository from
48 https://github.com/ouya-saviors/ouya-game-data
49 and then generate the API files with it::
50
51     $ git clone https://github.com/ouya-saviors/ouya-game-data.git
52     $ ./bin/import-game-data.php ouya-game-data/folders
53
54
55 ========
56 See also
57 ========
58
59 - https://gitlab.com/devirich/BrewyaOnOuya - alternative storefront
60 - https://archive.org/details/ouyalibrary - Archived OUYA games
61 - https://github.com/ouya-saviors/ouya-game-data/ - OUYA game data repository
62
63
64 ===========
65 Discoveries
66 ===========
67
68 - data/data/tv.ouya/cache/ion/
69
70   - image cache for main menu image
71
72 - Don't put a trailing slash into ``OUYA_SERVER_URL`` - it will make double slashes