firmware + agreements
[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 Notes:
23
24 - "important note, don't put trailing slash into OUYA_SERVER_URL, it will make double slashes"
25 - I had to reboot to make that change in the file active
26
27
28 OUYA setup
29 ==========
30
31 1. User registration: "Existing account"
32 2. Enter any username, leave password empty. Continue.
33 3. Skip credit card registration
34
35
36 Apache setup
37 ============
38 Virtual host configuration::
39
40   Script PUT /empty-json.php
41
42 ``mod_actions`` need to be enabled for apache 2.4.
43
44
45 ===========
46 Information
47 ===========
48 By default, OUYA uses HTTPS to devs.ouya.tv.
49 (status.ouya.tv is HTTP only, no SSL)
50 DNS mapping does not work, except when creating an own SSL certificate
51 and registering the root CA at the OUYA itself.
52
53 IPv6 used -> custom domain needs IPv6 DNS entry
54
55 https://rabid.ouya.tv/ - was OUYA's sandbox instance
56
57 DEBUG=1
58 DEBUG_SPAM=1
59
60 ========
61 See also
62 ========
63
64 - https://gitlab.com/devirich/BrewyaOnOuya
65 - https://archive.org/details/ouyalibrary
66 - https://github.com/cweiske/ouya-game-data/