api/configuration.rst

   1 =====================
   2 Configuration options
   3 =====================
   4
   5 It is possible to modify the behavior of the OUYA console by setting config
   6 options.
   7
   8 They can be set in two ways:
   9
  10 1. In an ini-style file ``ouya_config.properties`` in the root OUYA directory
  11    when attached via USB to a PC (``/sdcard/`` on the OUYA itself).
  12 2. On the server, via the `GET https://devs.ouya.tv/api/v1/console_configuration`_
  13    JSON file.
  14
  15
  16 Available options
  17 =================
  18
  19 ``ATTRACT_LOOP_FILENAME``
  20 -------------------------
  21 Full path to the not-in-use-autoplay video in kiosk mode.
  22
  23 Default: ``/sdcard/ouya_attract_loop.mp4``
  24
  25
  26 ``CCTEST``
  27 ----------
  28 When set to ``1``, the "Manage" menu shows a "[DEBUG] Test CC signup" entry.
  29
  30
  31 ``CRASH_REPORTS``
  32 -----------------
  33 When set to ``1``, the "Manage" menu shows a "[DEBUG] Send crash reports" entry.
  34 It immediately sends stored crash reports to the server.
  35
  36
  37 ``DEBUG``
  38 ---------
  39 When set to ``1``, additional output is shown in ``adb logcat``.
  40 You will see the remote server URLs that the OUYA is trying to fetch.
  41
  42
  43 ``DELETE_ACCOUNTS``
  44 -------------------
  45 When set to ``1``, the "Manage" menu shows a "[DEBUG] Delete user accounts" entry
  46 that immediately deletes the user account.
  47
  48
  49 ``DONT_DELETE_OTA``
  50 -------------------
  51 When an over-the-air update has been downloaded, it gets moved to
  52 ``/cache/update.zip``.
  53 After moving, the original file gets deleted.
  54 This option disabled this deletion.
  55
  56 Default: ``0``
  57
  58 (in ``ouya-framework.jar``)
  59
  60
  61 ``DUMP_DISCOVER_PAGES``
  62 -----------------------
  63 Store the downloaded API responses for discover category pages on
  64 ``/sdcard/``.
  65
  66
  67 ``ENABLE_AGREEMENTS``
  68 ---------------------
  69 When disabled, the regular fetch of ``/api/v1/gamers/me/agreements`` will not happen.
  70
  71 Also does not show the agreements during user registration in OOBE.
  72
  73 Default: ``1``
  74
  75
  76 ``ENABLE_BUY_NOW``
  77 ------------------
  78 When set to ``1``, the store details view shows a "buy now" button
  79 for games that have the "premium" flag set and a promoted product.
  80
  81 Default: ``1``
  82
  83
  84 ``ENABLE_BUY_NOW_PRICE``
  85 ------------------------
  86 When set to ``1``, the store details view shows the product price on
  87 the "buy now" button (see ``ENABLE_BUY_NOW``).
  88
  89 Default: ``1``
  90
  91
  92 ``ENABLE_BUY_NOW_PRICE_GUIDE``
  93 ------------------------------
  94 When set to ``1``, the guide menu
  95 (that appears when double-clicking the ouya logo button)
  96 shows the price of the promoted product.
  97
  98
  99 ``ENABLE_UPLOAD_LOGS``
 100 ----------------------
 101 Automatically update system logs. Needs super user access for uploading.
 102
 103 Default: ``1``
 104
 105
 106 ``FORCE_OTA``
 107 -------------
 108 When set to ``1``: Force the OUYA to install an over-the-air update.
 109
 110 Default: ``0``
 111
 112
 113 ``FORCE_VIDEO_ERROR``
 114 ---------------------
 115 When set to ``1``: Show an error whenever a video shall be played.
 116
 117 Default: ``0``
 118
 119
 120 ``KIOSK_MODE``
 121 --------------
 122 When set to ``1``, the OUYA is set to a read-only mode.
 123
 124 Only the "play" menu is visible, and it only allows to start games - not even see their
 125 details.
 126
 127 Upon inactivity after some minutes, a video
 128 ``/storage/sdcard0/ouya_attract_loop.mp4`` is being played.
 129 (See ``ATTRACT_LOOP_FILENAME``)
 130
 131
 132 ``LOC_MULTIPLIER``
 133 ------------------
 134 Float value between 1.0 and 3.0
 135
 136 Increases the string length by the given factor by repeating the letters
 137 in translatable strings.
 138
 139
 140 ``LOC_XXX``
 141 -----------
 142 When set to ``1``, all letters in translatable strings are replaced with ``X``.
 143
 144 Needs a reboot.
 145
 146
 147 ``METRIC_APP_DETAILS``
 148 ----------------------
 149 When set to ``1``: Send a tracking notification whenever a details page
 150 in the store is shown, along with the app UUID.
 151
 152
 153 ``OE_MAX_DOWNLOADS``
 154 --------------------
 155 Number of maximum downloads in the queue for non-ouya devices.
 156
 157 Default: ``10``
 158
 159
 160 ``OUYA_MAX_DOWNLOADS``
 161 ----------------------
 162 Number of maximum downloads in the queue for original OUYA devices.
 163
 164 Default: ``5``
 165
 166
 167 ``OUYA_SERVER_URL``
 168 -------------------
 169 Base URL of the API server to connect.
 170 By modifying this value, you can switch the OUYA to another server.
 171
 172 Default: ``https://devs.ouya.tv``
 173
 174
 175 ``OUYA_STATUS_SERVER_URL``
 176 --------------------------
 177 Used to check if the OUYA can reach the internet.
 178
 179 This URL needs to return a "204" HTTP status code.
 180
 181 Default: ``http://status.ouya.tv/api/v1/status``
 182
 183
 184 ``QUERY_GENDER_DOB``
 185 --------------------
 186 Show the gender and birthday input fields during registration in OOBE.
 187
 188 Default: ``1``
 189
 190
 191 ``RATING_PROMPT_DELAY``
 192 -----------------------
 193 Number of game launches until the "rate this game" prompt is shown.
 194
 195 Default: ``0`` (after the first launch)
 196
 197
 198 ``RATING_PROMPT_FREQ``
 199 ----------------------
 200 When rating a game has been skipped, it will be tried again after X launches.
 201
 202 ``0`` to disable rating popups.
 203
 204 Default: ``5``
 205
 206
 207 ``RATING_PROMPT_MAX``
 208 ---------------------
 209 Maximum number of "Rate this game" popups per game.
 210
 211 Default: ``0`` (infinite)
 212
 213
 214 ``SAFE_ZONE``
 215 -------------
 216 Show a grey border around the OOBE screen.
 217
 218 Default: ``0``
 219
 220
 221 ``UPDATE_TEXT_URL``
 222 -------------------
 223 When installing an update, funny messages are shown.
 224 They are downloaded from this URL.
 225
 226 Default: ``https://devs.ouya.tv/update_strings.txt``
 227
 228
 229 ``USER_MESSAGES``
 230 -----------------
 231 Comma-separated list of URLs to show to the user.
 232 See `GET https://devs.ouya.tv/api/v1/gamers/me/user_messages`_.
 233
 234 Default: empty
 235
 236
 237 ``WIFI_STATUS_DISPLAY``
 238 -----------------------
 239 When set to ``1``:
 240 Shows the current wifi status on the top right of all screens.
 241
 242 Example:
 243
 244   Wifi: INTERFACE_DISABLED, Strenght (0-8): 0
 245
 246
 247
 248 Undocumented options
 249 ====================
 250 Only the name of this variables is known::
 251
 252   BTC_LAUNCHER_PACKAGES
 253   BTC_PARAMS_APP
 254   BTC_PARAMS_LAUNCHER
 255   COMPARE_OTA_SETTINGS
 256   UPDATE_READY_UI_TIMEOUT
 257   UPLOAD_LOGS_SEQ_NUM
 258
 259
 260 Unused options
 261 ==============
 262 They are defined in the code, but not used anywhere in ``OUYALauncher.apk``::
 263
 264   APP_UPDATE_CHECK_INTERVAL
 265   ATTRACT_LOOP_TIMEOUT
 266   COMMUNITY_CONTENT_ENABLED
 267   DEBUG_PICASSO
 268   DISCOVER_HEADER_TEXT
 269   ENABLE_REMOTES
 270   ENABLE_TRACES
 271   INPUT_REMAPPING_JSON_FILE
 272   LOCALE
 273   METRIC_EXIT_GENRE
 274   METRIC_EXIT_STORE
 275   METRICS_SPEW
 276   NUM_RECENT_DOWNLOADS_IN_DISCOVER
 277   OUYA_RENAME_CONTROLLER
 278   SESSION_UPDATE_DELAY_SEC
 279   SHOW_DISCOUNTS
 280   SYSTEM_MESSAGE_URL
 281   THEME_CHECK_INTERVAL
 282   USE_FAKE_VIDEOS