Begin documenting configuration options

diff --git a/README.rst b/README.rst
index f56f31605cd7704e37b7c207e7976ca5362ed0c0..f91c458fbdf6b357a5c7204377e6aac64ee46be7 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -48,6 +48,7 @@ speak with ``devs.ouya.tv``.
 .. include:: api/devs.ouya.tv/agreements-marketplace.html.rst
 .. include:: api/devs.ouya.tv/update_strings.txt.rst
 .. include:: api/www.ouya.tv/system_message.rst
+.. include:: api/configuration.rst
 
 
 =====
@@ -88,4 +89,3 @@ You need to install ``rst2html5`` before::
 Rendering the docs is done via a build script::
 
     $ ./build.sh
-

diff --git a/api/configuration.rst b/api/configuration.rst
new file mode 100644 (file)
index 0000000..2d8a6e2
--- /dev/null
+++ b/api/configuration.rst
@@ -0,0 +1,104 @@
+=====================
+Configuration options
+=====================
+
+It is possible to modify the behavior of the OUYA console by setting config
+options.
+
+They can be set in two ways:
+
+1. In an ini-style file ``ouya_config.properties`` in the root OUYA directory
+   when attached via USB to a PC (``/sdcard/`` on the OUYA itself).
+2. On the server, via the `GET https://devs.ouya.tv/api/v1/console_configuration`_
+   JSON file.
+
+
+Available options
+=================
+
+``DEBUG``
+---------
+When set to ``1``, additional output is shown in ``adb logcat``.
+You will see the remote server URLs that the OUYA is trying to fetch.
+
+
+``KIOSK_MODE``
+--------------
+When set to ``1``, the OUYA is set to a read-only mode.
+
+Only the "play" menu is visible, and it only allows to start games - not even see their
+details.
+
+Upon inactivity after some minutes, a video
+``/storage/sdcard0/ouya_attract_loop.mp4`` is being played.
+
+
+``OUYA_SERVER_URL``
+-------------------
+Base URL of the API server to connect.
+By modifying this value, you can switch the OUYA to another server.
+
+Default: ``https://devs.ouya.tv``
+
+
+``OUYA_STATUS_SERVER_URL``
+--------------------------
+Used to check if the OUYA can reach the internet.
+
+This URL needs to return a "204" HTTP status code.
+
+Default: ``http://status.ouya.tv/api/v1/status``
+
+
+Undocumented options
+====================
+Only the name of this variables is known::
+
+  APP_UPDATE_CHECK_INTERVAL
+  ATTRACT_LOOP_FILENAME
+  ATTRACT_LOOP_TIMEOUT
+  BTC_LAUNCHER_PACKAGES
+  BTC_PARAMS_APP
+  BTC_PARAMS_LAUNCHER
+  CCTEST
+  COMPARE_OTA_SETTINGS
+  CRASH_REPORTS
+  DEBUG_PICASSO
+  DELETE_ACCOUNTS
+  DISCOVER_HEADER_TEXT
+  DONT_DELETE_OTA
+  ENABLE_AGREEMENTS
+  ENABLE_BUY_NOW
+  ENABLE_BUY_NOW_PRICE
+  ENABLE_BUY_NOW_PRICE_GUIDE
+  ENABLE_LIKE_BUTTON
+  ENABLE_REMOTES
+  ENABLE_TRACES
+  ENABLE_UPLOAD_LOGS
+  FORCE_OTA
+  FORCE_VIDEO_ERROR
+  INPUT_REMAPPING_JSON_FILE
+  LOCALE
+  LOC_MULTIPLIER
+  LOC_XXX
+  METRICS_SPEW
+  METRIC_APP_DETAILS
+  METRIC_EXIT_GENRE
+  METRIC_EXIT_STORE
+  NUM_RECENT_DOWNLOADS_IN_DISCOVER
+  OUYA_RENAME_CONTROLLER
+  QUERY_GENDER_DOB
+  RATING_PROMPT_DELAY
+  RATING_PROMPT_FREQ
+  RATING_PROMPT_MAX
+  SAFE_ZONE
+  SESSION_UPDATE_DELAY_SEC
+  SHOW_DISCOUNTS
+  SYSTEM_MESSAGE_URL
+  THEME_CHECK_INTERVAL
+  UPDATE_READY_UI_TIMEOUT
+  UPDATE_TEXT_URL
+  UPLOAD_LOGS_SEQ_NUM
+  USER_MESSAGES
+  USE_FAKE_VIDEOS
+  WIFI_STATUS_DISPLAY

diff --git a/api/devs.ouya.tv/api-v1-console_configuration.rst b/api/devs.ouya.tv/api-v1-console_configuration.rst
index bb47436a536cd980a11a62d633c8245db7e6bcc1..e254f59e96f70de93e9e336440cb0d12adb7c8f5 100644 (file)
--- a/api/devs.ouya.tv/api-v1-console_configuration.rst
+++ b/api/devs.ouya.tv/api-v1-console_configuration.rst
@@ -2,7 +2,12 @@
 ``GET https://devs.ouya.tv/api/v1/console_configuration``
 =========================================================
 
-FIXME: What is this used for?
+Sets Android system properties.
+Allows to enable debug or kiosk mode remotely.
+
+This file is downloaded every hour.
+
+See `Configuration options`_.
 
 
 HTTP request