From 4397ab4df3de2672e74725d0f98525d157941cbb Mon Sep 17 00:00:00 2001 From: Ludwig Wacker Date: Sun, 13 Dec 2015 14:23:13 +0100 Subject: [PATCH] LUNA: readme --- README.md | 28 +++++++++++++++++++++++++++- addon.xml | 2 +- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c2960fc..ba7fe11 100644 --- a/README.md +++ b/README.md @@ -1 +1,27 @@ -# luna +# Luna +Luna aims to be a one-size-fits-all Moonlight launcher for Kodi. Even though it's tailored for OSMC right now, it can be easily extended to support pretty much any platform where both Kodi and Moonlight (embedded or PC) are available. Probably OSX will be next, but let me know which platforms you'd like to see supported! If you feel like a specific feature is missing don't hesitate to tell me and I'll see what I can do ;) + +## Prerequisites +[Moonlight-Embedded](https://github.com/irtimmer/moonlight-embedded) needs to be installed. For setup instructions please follow irtimmer's wiki. + +## Installation +- Download as zip +- Copy to your OSMC installation or use a network share +- In Kodi: Settings > Addons > Install from zip file +- Before first starting the addon, you must enter at least the IP of the GameStream host in the addon settings. + +## Features +- GameStream Host Pairing can be done from within Luna +- Controller Mapping can be done there too (that's somewhat buggy though, at times I need to restart xboxdrv on my Pi before it works. Not sure if this is Luna or Moonlight ...) +- Dynamic Game Library (gets pulled from Moonlight every time you enter the 'Games' Section; so there's no persistence involved right now) +- the above allows for starting of specific games +- extensive configuration which supports nearly all of moonlight-embedded's launch options + +## Issues +- Games which contain spaces in their names have not been tested, so not sure if they're going to work properly right now +- Controller Mapping sometimes not working +- There's not a single icon currently +- Please keep in mind that Luna - while I guess it's working pretty good right now - is still alpha, so don't expect it to work perfectly + +## Bugs / Feature Requests +- Please report any bugs or feature requests on the issue tracker diff --git a/addon.xml b/addon.xml index 35fe0ac..22dd99a 100644 --- a/addon.xml +++ b/addon.xml @@ -1,5 +1,5 @@ - +