README.rst

   1 ===================================
   2 louyapi - Local OUYA API server app
   3 ===================================
   4
   5 An application for the OUYA that runs an OUYA API server.
   6 With it, the OUYA brings its own API server it can talk to.
   7
   8 Game detail pages and the disover store are served by the OUYA itself.
   9 Only images and .apk files are requested from http://statics.ouya.world
  10
  11 It utilizes the static API files generated by stouyapi__
  12 from the `OUYA game meta data repository`__
  13
  14 __ https://github.com/cweiske/stouyapi/
  15 __ https://github.com/ouya-saviors/ouya-game-data
  16
  17
  18 Development
  19 ===========
  20
  21 Building stouyapi files
  22 -----------------------
  23 ``git clone`` the game data and stouyapi repositories.
  24 Then generate the API files::
  25
  26   $ cd stouyapi
  27   $ ./bin/clean-generated-keep-qr.sh
  28   $ ./bin/import-game-data.php --mini --noqr ../game-data/folders
  29
  30 Now copy the generated files into louyapi's ``src/main/assets/stouyapi-www/``
  31 directory:
  32
  33   $ cd louyapi
  34   $ ./bin/copy-from-stouyapi.sh
  35
  36 Now the apk can be compiled.
  37
  38
  39 Building a release
  40 ------------------
  41 At first add a path to a signing configuration file into ``gradle.properties``::
  42
  43   signingconfigfile=/path/to/signing-config.gradle
  44
  45 The signing configuration file should look as shown in
  46 `Handling signing configs with Gradle`__
  47
  48 __ https://www.timroes.de/2013/09/22/handling-signing-configs-with-gradle/
  49
  50
  51 Now build the signed apk file in ``build/outputs/apk/release/louyapi-release.apk``::
  52
  53    $ ./gradlew assembleRelease
  54
  55
  56 Helpful information for implementation
  57 ======================================
  58 - https://github.com/NanoHttpd/nanohttpd/tree/nanohttpd-project-2.3.1
  59 - https://fabcirablog.weebly.com/blog/creating-a-never-ending-background-service-in-android
  60
  61
  62 About louyapi
  63 =============
  64 ``louyapi`` was written by Christian Weiske, cweiske+ouya@cweiske.de.
  65
  66
  67 License
  68 -------
  69 ``louyapi`` is licensed under the AGPL v3.