From 6288057dca6aa0bf7a5d70d6e26338b2532f57d9 Mon Sep 17 00:00:00 2001 From: Joel H Date: Thu, 7 Dec 2017 23:11:53 -0600 Subject: [PATCH] Split install script into modular sections. Added carbon theme as it was missing --- .gitignore | 206 +-- GenerateGamesList.py | 202 +-- Install.sh | 194 +-- Install_Scripts.sh | 20 + Install_moonlight.sh | 43 +- Install_moonlight_menu.sh | 25 + Install_themes.sh | 10 +- LICENSE | 1348 ++++++++--------- Pair_moonlight.sh | 8 + README.md | 96 +- Refresh.sh | 8 +- menu_config.txt | 10 + sampleOutput.txt | 32 +- .../moonlight/art/controller.svg | 0 .../moonlight/art/moonlight.svg | 0 themes/{Carbon => carbon}/moonlight/theme.xml | 0 themes/minimal/layouts/V2.xml | 354 ++--- themes/minimal/theme.xml | 6 +- themes/simple-dark/moonlight/theme.xml | 334 ++-- themes/simple/moonlight/theme.xml | 340 ++--- 20 files changed, 1616 insertions(+), 1620 deletions(-) create mode 100644 Install_Scripts.sh create mode 100644 Install_moonlight_menu.sh create mode 100644 Pair_moonlight.sh create mode 100644 menu_config.txt rename themes/{Carbon => carbon}/moonlight/art/controller.svg (100%) rename themes/{Carbon => carbon}/moonlight/art/moonlight.svg (100%) rename themes/{Carbon => carbon}/moonlight/theme.xml (100%) diff --git a/.gitignore b/.gitignore index 7bbc71c..57ef8de 100644 --- a/.gitignore +++ b/.gitignore @@ -1,101 +1,105 @@ -# Byte-compiled / optimized / DLL files -__pycache__/ -*.py[cod] -*$py.class - -# C extensions -*.so - -# Distribution / packaging -.Python -env/ -build/ -develop-eggs/ -dist/ -downloads/ -eggs/ -.eggs/ -lib/ -lib64/ -parts/ -sdist/ -var/ -wheels/ -*.egg-info/ -.installed.cfg -*.egg - -# PyInstaller -# Usually these files are written by a python script from a template -# before PyInstaller builds the exe, so as to inject date/other infos into it. -*.manifest -*.spec - -# Installer logs -pip-log.txt -pip-delete-this-directory.txt - -# Unit test / coverage reports -htmlcov/ -.tox/ -.coverage -.coverage.* -.cache -nosetests.xml -coverage.xml -*.cover -.hypothesis/ - -# Translations -*.mo -*.pot - -# Django stuff: -*.log -local_settings.py - -# Flask stuff: -instance/ -.webassets-cache - -# Scrapy stuff: -.scrapy - -# Sphinx documentation -docs/_build/ - -# PyBuilder -target/ - -# Jupyter Notebook -.ipynb_checkpoints - -# pyenv -.python-version - -# celery beat schedule file -celerybeat-schedule - -# SageMath parsed files -*.sage.py - -# dotenv -.env - -# virtualenv -.venv -venv/ -ENV/ - -# Spyder project settings -.spyderproject -.spyproject - -# Rope project settings -.ropeproject - -# mkdocs documentation -/site - -# mypy -.mypy_cache/ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# dotenv +.env + +# virtualenv +.venv +venv/ +ENV/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ + +# Misc + +.idea/ diff --git a/GenerateGamesList.py b/GenerateGamesList.py index b323c2b..a757225 100644 --- a/GenerateGamesList.py +++ b/GenerateGamesList.py @@ -1,101 +1,101 @@ -""" -Script to generate a launch script for each game available in moonlight -""" -import sys -import os -import stat - -RefreshListScript = 'Refresh.sh' - -BashHeader = '#!/bin/bash\n' -StreamString = 'moonlight stream -720 -app ' -roms_directory = '/home/pi/RetroPie/roms/moonlight/' - - -def clear_directory(folder_path): - """ - Clears the directory of old game launching scripts - :param folder_path: The path to the folder to clear - """ - for the_file in os.listdir(folder_path): - try: - file_path = os.path.join(folder_path, the_file) - if os.path.isfile(file_path) \ - and the_file != RefreshListScript \ - and not the_file.endswith(('.txt', 'py')): - os.unlink(file_path) - except Exception as e: - print(e) - - -def read_games_list(file_path): - """ - Reads the contents of a file - :param file_path: path of the file to read in - :return: contents of the file - """ - input_data = "" - if os.path.isfile(file_path): - f = open(file_path, "r") - input_data = f.readlines() - f.close() - return input_data - - -def is_valid_listing(game_listing): - """ - Check to see if a single line from the listings is a valid game name - :param game_listing: A single line of text from the Moonlight List command - :return: True if it is a valid listing, False otherwise - """ - try: - int(game_listing.split(".")[0]) - return True - except Exception as e: - return False - - -def create_script(game_title): - """ - Creates the script to run a game title - :param game_title: The name of the game to launch - """ - script = '{}{}\"{}\"'.format(BashHeader, StreamString, game_title) - print('\nCreating a script for {}:'.format(game_title)) - print(script) - return script - - -def write_script(script, game_title): - """ - Writes a script string to disk - :param script: The string to be written as the script - :param game_title: The game title to be used as the file name - """ - try: - script_name = '{}{}.sh'.format(roms_directory, game_title.replace(":", "")) - print('Writing {} to disk...'.format(script_name)) - f = open(script_name, "w+") - f.write(script) - f.close() - - st = os.stat(script_name) - os.chmod(script_name, st.st_mode | stat.S_IEXEC) - except Exception as write_exception: - print(write_exception) - - -try: - RawInputList = read_games_list(sys.argv[1]) -except Exception as e: - exit(e) - - -clear_directory(roms_directory) - -for gameListing in RawInputList: - parsedListing = gameListing.strip() - if is_valid_listing(parsedListing) is False: - continue - parsedListing = parsedListing.strip().split('.')[1].strip() - write_script(create_script(parsedListing), parsedListing) +""" +Script to generate a launch script for each game available in moonlight +""" +import sys +import os +import stat + +RefreshListScript = 'Refresh.sh' + +BashHeader = '#!/bin/bash\n' +StreamString = 'moonlight stream -720 -app ' +roms_directory = '/home/pi/RetroPie/roms/moonlight/' + + +def clear_directory(folder_path): + """ + Clears the directory of old game launching scripts + :param folder_path: The path to the folder to clear + """ + for the_file in os.listdir(folder_path): + try: + file_path = os.path.join(folder_path, the_file) + if os.path.isfile(file_path) \ + and the_file != RefreshListScript \ + and not the_file.endswith(('.txt', 'py')): + os.unlink(file_path) + except Exception as e: + print(e) + + +def read_games_list(file_path): + """ + Reads the contents of a file + :param file_path: path of the file to read in + :return: contents of the file + """ + input_data = "" + if os.path.isfile(file_path): + f = open(file_path, "r") + input_data = f.readlines() + f.close() + return input_data + + +def is_valid_listing(game_listing): + """ + Check to see if a single line from the listings is a valid game name + :param game_listing: A single line of text from the Moonlight List command + :return: True if it is a valid listing, False otherwise + """ + try: + int(game_listing.split(".")[0]) + return True + except Exception as e: + return False + + +def create_script(game_title): + """ + Creates the script to run a game title + :param game_title: The name of the game to launch + """ + script = '{}{}\"{}\"'.format(BashHeader, StreamString, game_title) + print('\nCreating a script for {}:'.format(game_title)) + print(script) + return script + + +def write_script(script, game_title): + """ + Writes a script string to disk + :param script: The string to be written as the script + :param game_title: The game title to be used as the file name + """ + try: + script_name = '{}{}.sh'.format(roms_directory, game_title.replace(":", "")) + print('Writing {} to disk...'.format(script_name)) + f = open(script_name, "w+") + f.write(script) + f.close() + + st = os.stat(script_name) + os.chmod(script_name, st.st_mode | stat.S_IEXEC) + except Exception as write_exception: + print(write_exception) + + +try: + RawInputList = read_games_list(sys.argv[1]) +except Exception as e: + exit(e) + + +clear_directory(roms_directory) + +for gameListing in RawInputList: + parsedListing = gameListing.strip() + if is_valid_listing(parsedListing) is False: + continue + parsedListing = parsedListing.strip().split('.')[1].strip() + write_script(create_script(parsedListing), parsedListing) diff --git a/Install.sh b/Install.sh index 9f56a59..a86a521 100644 --- a/Install.sh +++ b/Install.sh @@ -1,142 +1,54 @@ -#!/bin/bash - -echo -e "\n****************************************************************" -echo -e "Welcome to the Moonlight Installer Script for RetroPie v1.0.0.0" -echo -e "****************************************************************\n" -echo -e "Select an option:" -echo -e " * 1: Install Moonlight, Pair, Install Scripts" -echo -e " * 2: Install Moonlight themes" -echo -e " * 3: Remove Launch Scripts" -echo -e " * 4: Re Pair Moonlight with PC" -echo -e " * 5: Exit" - - -read NUM -case $NUM in - 1) - echo -e "\nPHASE ONE: Add Moonlight to Sources List" - echo -e "****************************************\n" - - if grep -q "deb http://archive.itimmer.nl/raspbian/moonlight jessie main" /etc/apt/sources.list; then - echo -e "NOTE: Moonlight Source Exists - Skipping" - else - echo -e "Adding Moonlight to Sources List" - echo "deb http://archive.itimmer.nl/raspbian/moonlight jessie main" >> /etc/apt/sources.list - fi - - echo -e "\n**** PHASE ONE Complete!!!! ****" - - echo -e "\nPHASE TWO: Fetch and install the GPG key" - echo -e "****************************************\n" - - if [ -f /home/pi/itimmer.gpg ] - then - echo -e "NOTE: GPG Key Exists - Skipping" - else - wget http://archive.itimmer.nl/itimmer.gpg - chown pi:pi /home/pi/itimmer.gpg - apt-key add itimmer.gpg - fi - - echo -e "\n**** PHASE TWO Complete!!!! ****" - - echo -e "\nPHASE THREE: Update System" - echo -e "**************************\n" - apt-get update -y - echo -e "\n**** PHASE THREE Complete!!!! ****" - - echo -e "\nPHASE FOUR: Install Moonlight" - echo -e "*****************************\n" - apt-get install moonlight-embedded -y - echo -e "\n**** PHASE FOUR Complete!!!! ****" - - echo -e "\nPHASE FIVE: Pair Moonlight with PC" - echo -e "**********************************\n" - echo -e "Once you have input your STEAM PC's IP Address below, you will be given a PIN" - echo -e "Input this on the STEAM PC to pair with Moonlight. \n" - read -p "Input STEAM PC's IP Address here :`echo $'\n> '`" ip - sudo -u pi moonlight pair $ip - echo -e "\n**** PHASE FIVE Complete!!!! ****" - - echo -e "\nPHASE SIX: Create Moonlight Menu for RetroPie" - echo -e "*****************************************\n" - - if [ -f /home/pi/.emulationstation/es_systems.cfg ] - then - echo -e "Removing Duplicate Systems File" - rm /home/pi/.emulationstation/es_systems.cfg - fi - - echo -e "Copying Systems Config File" - cp /etc/emulationstation/es_systems.cfg /home/pi/.emulationstation/es_systems.cfg - - if grep -q "\n steam\n Steam\n ~/RetroPie/roms/moonlight\n .sh .SH\n bash %ROM%\n pc\n moonlight\n \n" /home/pi/.emulationstation/es_systems.cfg; then - echo -e "NOTE: Moonlight Entry Exists - Skipping" - else - echo -e "Adding Steam to Systems" - sudo sed -i -e 's|| \n steam\n Steam\n ~/RetroPie/roms/moonlight\n .sh .SH\n bash %ROM%\n pc\n moonlight\n \n|g' /home/pi/.emulationstation/es_systems.cfg - fi - echo -e "\n**** PHASE SIX Complete!!!! ****" - - echo -e "\nPHASE SEVEN: Create Refresh script in Moonlight" - echo -e "**********************************************************\n" - - echo -e "Create Scripts" - - bash ./Install_moonlight.sh - - echo -e "\n**** PHASE SEVEN Complete!!!! ****" - - echo -e "\nPHASE EIGHT: Making Everything PI Again :)" - echo -e "******************************************\n" - - echo -e "\n**** PHASE EIGHT Complete!!!! ****\n" - echo -e "Everything should now be installed and setup correctly." - echo -e "After loading RetroPie, use the \"Refresh\" rom listed in the Moonlight system." - echo -e "To be safe, it's recommended that you perform a reboot now." - echo -e "\nIf you don't want to reboot now, press N\n" - - read -p "Reboot Now (y/n)?" choice - case "$choice" in - y|Y ) shutdown -r now;; - n|N ) sudo bash ./Install.sh - ;; - * ) echo "invalid";; - esac - ;; - 2) - echo -e "\nInstalling Moonlight compatible themes" - echo -e "***********************************************\n" - - sudo bash ./Install_themes.sh - - sudo bash ./Install.sh - ;; - - 3) - echo -e "\nRemove All Moonlight Launch Scripts" - echo -e "***********************************\n" - - rm -rf /home/pi/RetroPie/roms/moonlight - - echo -e "\n**** Launch Script Removal Complete!!! ****" - sudo bash ./Install.sh - ;; - - 4) - echo -e "\nRe-Pair Moonlight with another PC" - echo -e "*********************************\n" - - echo -e "Once you have input your PC's IP Address below, you will be given a PIN" - echo -e "Input this on the PC to pair with Moonlight. \n" - read -p "Input PC's IP Address here :`echo $'\n> '`" ip - sudo -u pi moonlight pair $ip - - echo -e "\n**** Re-Pair Process Complete!!!! ****" - sudo bash ./Install.sh - ;; - - 5) exit 1;; - - *) echo "INVALID NUMBER!" ;; +#!/bin/bash + +echo -e "\n****************************************************************" +echo -e "Welcome to the Moonlight Installer Script for RetroPie" +echo -e "****************************************************************\n" +echo -e "Select an option:" +echo -e " * 1: Complete Install and Setup" +echo -e " * 2: Install Moonlight" +echo -e " * 3: Pair Moonlight to PC" +echo -e " * 4: Install Moonlight Menu in RetroPie" +echo -e " * 5: Install Moonlight Refresh Script in RetroPie" +echo -e " * 6: Install Moonlight themes" +echo -e " * 7: Remove Launch Scripts" +echo -e " * 8: Exit" + +read NUM +case $NUM in + 1) + sudo bash ./Install_moonlight.sh + sudo bash ./Pair_moonlight.sh + sudo bash ./Install_moonlight_menu.sh + sudo bash ./Install_Scripts.sh + sudo bash ./Install_themes.sh + ;; + 2) + sudo bash ./Install_moonlight.sh + sudo bash ./Install.sh + ;; + 3) + sudo bash ./Pair_moonlight.sh + sudo bash ./Install.sh + ;; + 4) + sudo bash ./Install_moonlight_menu.sh + sudo bash ./Install.sh + ;; + 5) + sudo bash ./Install_Scripts.sh + sudo bash ./Install.sh + ;; + 6) + sudo bash ./Install_themes.sh + sudo bash ./Install.sh + ;; + 7) + echo -e "\nRemoving all Moonlight launch scripts..." + rm -rf /home/pi/RetroPie/roms/moonlight + sudo bash ./Install.sh + ;; + 8) + exit 1 + ;; + *) echo "INVALID NUMBER!" ;; esac \ No newline at end of file diff --git a/Install_Scripts.sh b/Install_Scripts.sh new file mode 100644 index 0000000..ec20e17 --- /dev/null +++ b/Install_Scripts.sh @@ -0,0 +1,20 @@ +#!/bin/bash + +echo -e "\nCreating Refresh script in Moonlight..." + +if [ -d /home/pi/RetroPie/roms/moonlight ] +then + rm -rf /home/pi/RetroPie/roms/moonlight +fi + +mkdir -p /home/pi/RetroPie/roms/moonlight +chmod 775 /home/pi/RetroPie/roms/moonlight +chown pi:pi /home/pi/RetroPie/roms/moonlight + +chmod -x+ Refresh.sh + +/bin/cp ./Refresh.sh /home/pi/RetroPie/roms/moonlight/Refresh.sh +/bin/cp ./GenerateGamesList.py /home/pi/RetroPie/roms/moonlight/GenerateGamesList.py + +echo -e "Refresh script has been added to RetroPie\n" +echo -e "After loading RetroPie, use the \"Refresh\" rom listed in the Moonlight system.\n" diff --git a/Install_moonlight.sh b/Install_moonlight.sh index c1f78fe..2d7f1c3 100644 --- a/Install_moonlight.sh +++ b/Install_moonlight.sh @@ -1,15 +1,28 @@ -#!/bin/bash - -if [ -d /home/pi/RetroPie/roms/moonlight ] -then - rm -rf /home/pi/RetroPie/roms/moonlight -fi - -mkdir -p /home/pi/RetroPie/roms/moonlight -chmod 775 /home/pi/RetroPie/roms/moonlight -chown pi:pi /home/pi/RetroPie/roms/moonlight - -chmod -x+ Refresh.sh - -/bin/cp ./Refresh.sh /home/pi/RetroPie/roms/moonlight/Refresh.sh -/bin/cp ./GenerateGamesList.py /home/pi/RetroPie/roms/moonlight/GenerateGamesList.py +#!/bin/bash + +echo -e "\nAdding Moonlight to Sources List..." + +if grep -q "deb http://archive.itimmer.nl/raspbian/moonlight jessie main" /etc/apt/sources.list; then + echo -e "NOTE: Moonlight Source Exists - Skipping" +else + echo -e "Adding Moonlight to Sources List" + echo "deb http://archive.itimmer.nl/raspbian/moonlight jessie main" >> /etc/apt/sources.list +fi + +echo -e "\nFetching and installing the GPG key....\n" + +if [ -f /home/pi/itimmer.gpg ] +then + echo -e "NOTE: GPG Key Exists - Skipping" +else + wget http://archive.itimmer.nl/itimmer.gpg + chown pi:pi /home/pi/itimmer.gpg + apt-key add itimmer.gpg +fi + +echo -e "\nUpdating System..." +apt-get update -y + +echo -e "\nInstalling Moonlight..." +apt-get install moonlight-embedded -y +echo -e "\nMoonlight Installed!" \ No newline at end of file diff --git a/Install_moonlight_menu.sh b/Install_moonlight_menu.sh new file mode 100644 index 0000000..33abd24 --- /dev/null +++ b/Install_moonlight_menu.sh @@ -0,0 +1,25 @@ +#!/bin/bash + +echo -e "\nCreating Moonlight Menu for RetroPie..." + +CONFIG=$(<./menu_config.txt) +DIRECTORY=/home/pi/.emulationstation/es_systems.cfg + +if [ -f $DIRECTORY ] +then + echo -e "Removing Duplicate Systems File" + rm $DIRECTORY +fi + +echo -e "Copying Systems Config File" +cp /etc/emulationstation/es_systems.cfg $DIRECTORY + +if grep -q "$CONFIG" $DIRECTORY; then + echo -e "NOTE: Moonlight Entry Exists - Skipping" +else + echo -e "Adding Steam to Systems" + sed + sudo sed -i -e 's|| /r ./menu_config.txt' $DIRECTORY +fi + +echo -e "\nMoonlight menue added to RetroPie..." \ No newline at end of file diff --git a/Install_themes.sh b/Install_themes.sh index 72c0c91..960d680 100644 --- a/Install_themes.sh +++ b/Install_themes.sh @@ -1,3 +1,7 @@ -#!/bin/bash - -cp -R ./themes /etc/emulationstation/ \ No newline at end of file +#!/bin/bash + +echo -e "\nInstalling Moonlight compatible themes..." + +cp -R ./themes /etc/emulationstation/ + +echo -e "\nThemes installed" \ No newline at end of file diff --git a/LICENSE b/LICENSE index 94a9ed0..818433e 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,674 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/Pair_moonlight.sh b/Pair_moonlight.sh new file mode 100644 index 0000000..91c6111 --- /dev/null +++ b/Pair_moonlight.sh @@ -0,0 +1,8 @@ +#!/bin/bash + +echo -e "\nPairing Moonlight with another PC...\n" +echo -e "Once you have input your PC's IP Address below, you will be given a PIN" +echo -e "Input this on the PC to pair with Moonlight. \n" +read -p "Input PC's IP Address here :`echo $'\n> '`" ip +sudo -u pi moonlight pair $ip +echo -e "Pair Process Complete." \ No newline at end of file diff --git a/README.md b/README.md index ac15ce7..94ef8f7 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,48 @@ -# RetroPie Moonlight # - -This is a set of scripts with the intent of helping people stream games from their PC to their RetroPie. These scripts use [Moonlight](http://moonlight-stream.com/) to query your PC for your available games and generates a "Console" within RetroPi along with a set of "Roms" representing your games. Each rom is actually a shell script configured to tell moonlight to begin streaming the game of your choice. -![alt text](https://github.com/joelghill/retromoonlight/blob/master/Images/menu_eudora.png "Moonlight game collection in Eudora theme") - -## Why Use This? ## - -There is already a [solution available](https://github.com/TechWizTime/moonlight-retropie) for streaming Steam Big Picture Mode, why bother using this? There are a few reasons: - - 1. Using this script RetroPie will have a list of games it can display with scraped meta-data from the web. - 2. I've found Steam BPM to be unreliable when used with RetroPie and I wanted something better. - -## Setup ## - -On your raspberry pi: - - 1. git clone https://github.com/joelghill/retromoonlight.git - 2. cd retromoonlight - 3. sudo bash ./Install.sh - 4. emulationstation - -Once EmulationStation is running, navigate to the Steam console, select the "Refresh" rom, then reboot emultationstation after the script is finished. - -## Usage ## -Emulationstation should now have an entry for Moonlight. There will be a single "Rom" called refresh. Use this to update your games list. After using refresh command you will need to reboot emulationstation. - -## Themes ## - -I am gradually adding support for custom themes. The current version of retro moonlight works in: - - * Carbon (several variants) - * Simple - * Simple-Dark - * Clean-look - * minimal - * Eudora-Updated - * flat - * flat-dark - - ![alt text](https://github.com/joelghill/retromoonlight/blob/master/Images/menu_simple-dark_theme.PNG "Moonlight theme") - - -## Credits ## - -A huge thank you to [TechWizTime](https://github.com/TechWizTime) for his work in creating the install and setup script for moonlight in RetroPie. I am building on his work and could not have developed this without following his example! - - - +# RetroPie Moonlight # + +This is a set of scripts with the intent of helping people stream games from their PC to their RetroPie. These scripts use [Moonlight](http://moonlight-stream.com/) to query your PC for your available games and generates a "Console" within RetroPi along with a set of "Roms" representing your games. Each rom is actually a shell script configured to tell moonlight to begin streaming the game of your choice. +![alt text](https://github.com/joelghill/retromoonlight/blob/master/Images/menu_eudora.png "Moonlight game collection in Eudora theme") + +## Why Use This? ## + +There is already a [solution available](https://github.com/TechWizTime/moonlight-retropie) for streaming Steam Big Picture Mode, why bother using this? There are a few reasons: + + 1. Using this script RetroPie will have a list of games it can display with scraped meta-data from the web. + 2. I've found Steam BPM to be unreliable when used with RetroPie and I wanted something better. + +## Setup ## + +On your raspberry pi: + + 1. git clone https://github.com/joelghill/retromoonlight.git + 2. cd retromoonlight + 3. sudo bash ./Install.sh + 4. emulationstation + +Once EmulationStation is running, navigate to the Steam console, select the "Refresh" rom, then reboot emultationstation after the script is finished. + +## Usage ## +Emulationstation should now have an entry for Moonlight. There will be a single "Rom" called refresh. Use this to update your games list. After using refresh command you will need to reboot emulationstation. + +## Themes ## + +I am gradually adding support for custom themes. The current version of retro moonlight works in: + + * Carbon (several variants) + * Simple + * Simple-Dark + * Clean-look + * minimal + * Eudora-Updated + * flat + * flat-dark + + ![alt text](https://github.com/joelghill/retromoonlight/blob/master/Images/menu_simple-dark_theme.PNG "Moonlight theme") + + +## Credits ## + +A huge thank you to [TechWizTime](https://github.com/TechWizTime) for his work in creating the install and setup script for moonlight in RetroPie. I am building on his work and could not have developed this without following his example! + + + diff --git a/Refresh.sh b/Refresh.sh index 9455853..c35cb58 100644 --- a/Refresh.sh +++ b/Refresh.sh @@ -1,4 +1,4 @@ -#!/bin/bash -moonlight list > gameslist.txt -python3 ~/RetroPie/roms/moonlight/GenerateGamesList.py "./gameslist.txt" -rm ./gameslist.txt +#!/bin/bash +moonlight list > gameslist.txt +python3 ~/RetroPie/roms/moonlight/GenerateGamesList.py "./gameslist.txt" +rm ./gameslist.txt diff --git a/menu_config.txt b/menu_config.txt new file mode 100644 index 0000000..491a42f --- /dev/null +++ b/menu_config.txt @@ -0,0 +1,10 @@ + + steam + Steam + ~/RetroPie/roms/moonlight + .sh .SH + bash %ROM% + pc + moonlight + + \ No newline at end of file diff --git a/sampleOutput.txt b/sampleOutput.txt index c23bc41..1b712b3 100644 --- a/sampleOutput.txt +++ b/sampleOutput.txt @@ -1,16 +1,16 @@ -Searching for server... -Connect to 172.16.1.76... -1. Steam -2. steamcmd (buildbot_steam-relclient-win32-builder_steam_rel_client_win32@steam-relclient-win32-builder) -3. Rise of The Tomb Raider -4. XCOM: Enemy Unknown -5. Stardew Valley -6. Overwatch -7. Titanfall 2 -8. PlayerUnknown's Battle Grounds -9. Metal Gear Solid V: The Phantom Pain -10. PlayerUnknown's Battle Grounds -11. The Witcher 2: Assassins of Kings -12. Hearthstone: Heroes of Warcraft -13. INSIDE -14. Rocket League +Searching for server... +Connect to 172.16.1.76... +1. Steam +2. steamcmd (buildbot_steam-relclient-win32-builder_steam_rel_client_win32@steam-relclient-win32-builder) +3. Rise of The Tomb Raider +4. XCOM: Enemy Unknown +5. Stardew Valley +6. Overwatch +7. Titanfall 2 +8. PlayerUnknown's Battle Grounds +9. Metal Gear Solid V: The Phantom Pain +10. PlayerUnknown's Battle Grounds +11. The Witcher 2: Assassins of Kings +12. Hearthstone: Heroes of Warcraft +13. INSIDE +14. Rocket League diff --git a/themes/Carbon/moonlight/art/controller.svg b/themes/carbon/moonlight/art/controller.svg similarity index 100% rename from themes/Carbon/moonlight/art/controller.svg rename to themes/carbon/moonlight/art/controller.svg diff --git a/themes/Carbon/moonlight/art/moonlight.svg b/themes/carbon/moonlight/art/moonlight.svg similarity index 100% rename from themes/Carbon/moonlight/art/moonlight.svg rename to themes/carbon/moonlight/art/moonlight.svg diff --git a/themes/Carbon/moonlight/theme.xml b/themes/carbon/moonlight/theme.xml similarity index 100% rename from themes/Carbon/moonlight/theme.xml rename to themes/carbon/moonlight/theme.xml diff --git a/themes/minimal/layouts/V2.xml b/themes/minimal/layouts/V2.xml index 71ddc56..91dc685 100644 --- a/themes/minimal/layouts/V2.xml +++ b/themes/minimal/layouts/V2.xml @@ -1,178 +1,178 @@ - - - - 4 - - - - - 1 1 - 0 0 - 0 0 - ./../assets/bg.png - 0 - 10667f - - - - 00000000 - 00000000 - 1 1 - - - - ./../art/${system.theme}.svg - - - - - - - - 0.061 0.624 - 0.236 0.200 - ffffff - 0.025 - No Information Available - ./../assets/noto.ttf - - - - 0.5 0.5 - 0.1785 0.382 - 0.236 0.418 - ./../assets/no_boxart.png - - - - - - - - 1 1 - 0 0 - 0 0 - ./../assets/bg.png - 0 - 10667f - - - - ./../assets/gamelist.png - 0 0 - 2 - 1 1 - 0 0 - - - - ${system.fullName} - 0 - 0.5 0.025 - 0.02 0.025 - ffffff - ./../assets/SST.ttf - 0.04 - 2 - - - - 1 1 - - - - 1 1 - 0 0 - - - - 0f85a5 - ffffff - ffffff - ffffff - ./../assets/SST.ttf - 0.03 - 0.307 0.170 - 0.635 0.68 - left - 0.01 - 0 0 - 2.27 - ./../assets/box.png - -0.01 - 0.0675 - - - - 0.5 0.5 - 0.1785 0.382 - 0.236 0.418 - - - - 0.061 0.624 - 0.236 0.200 - ffffff - 0.025 - ./../assets/noto.ttf - - - - 1 1 - 00000000 - ./../assets/box.png - - - - - - - - - - - - - - - - - - horizontal - 00000000 - 1 - 0.25 0.155 - - - - 00000000 - ffffff - ./../assets/SST.ttf - 0.03 - - - - - - - - - + + + + 4 + + + + + 1 1 + 0 0 + 0 0 + ./../assets/bg.png + 0 + 10667f + + + + 00000000 + 00000000 + 1 1 + + + + ./../art/${system.theme}.svg + + + + + + + + 0.061 0.624 + 0.236 0.200 + ffffff + 0.025 + No Information Available + ./../assets/noto.ttf + + + + 0.5 0.5 + 0.1785 0.382 + 0.236 0.418 + ./../assets/no_boxart.png + + + + + + + + 1 1 + 0 0 + 0 0 + ./../assets/bg.png + 0 + 10667f + + + + ./../assets/gamelist.png + 0 0 + 2 + 1 1 + 0 0 + + + + ${system.fullName} + 0 + 0.5 0.025 + 0.02 0.025 + ffffff + ./../assets/SST.ttf + 0.04 + 2 + + + + 1 1 + + + + 1 1 + 0 0 + + + + 0f85a5 + ffffff + ffffff + ffffff + ./../assets/SST.ttf + 0.03 + 0.307 0.170 + 0.635 0.68 + left + 0.01 + 0 0 + 2.27 + ./../assets/box.png + -0.01 + 0.0675 + + + + 0.5 0.5 + 0.1785 0.382 + 0.236 0.418 + + + + 0.061 0.624 + 0.236 0.200 + ffffff + 0.025 + ./../assets/noto.ttf + + + + 1 1 + 00000000 + ./../assets/box.png + + + + + + + + + + + + + + + + + + horizontal + 00000000 + 1 + 0.25 0.155 + + + + 00000000 + ffffff + ./../assets/SST.ttf + 0.03 + + + + + + + + + \ No newline at end of file diff --git a/themes/minimal/theme.xml b/themes/minimal/theme.xml index ada2f20..6dc1647 100644 --- a/themes/minimal/theme.xml +++ b/themes/minimal/theme.xml @@ -1,4 +1,4 @@ - -4 -./layouts/V2.xml + +4 +./layouts/V2.xml \ No newline at end of file diff --git a/themes/simple-dark/moonlight/theme.xml b/themes/simple-dark/moonlight/theme.xml index 79aa4db..3916fa3 100644 --- a/themes/simple-dark/moonlight/theme.xml +++ b/themes/simple-dark/moonlight/theme.xml @@ -1,168 +1,168 @@ - - 3 - ./../simple-dark.xml - - - - - ./art/moonlight_art_blur.png - - - - ./art/moonlight.svg - - - - 00000077 - 00000077 - - - - - - - - Moonlight - 1 - 0.45 0.08 - 0.527 0.01 - 0098a6 - ./../art/Roboto-Light.ttf - 0.055 - right - - - - Streaming - 1 - 0.45 0.08 - 0.527 0.07 - 0098a6 - ./../art/Roboto-Light.ttf - 0.055 - right - - - - ./art/moonlight.svg - 0.025 0.0775 - 0.55 0.1 - 0 0.5 - - - - - - - - 0.025 0.22 - 0.950 0.68 - center - 0.01 - - - - - - - - - - 0.025 0.22 - 0.245 0.301 - 0 0 - - - - 0.292 0.21 - - - - 0.292 0.25 - - - - 0.292 0.29 - 0.133 0.04 - - - - 0.292 0.33 - 0.133 0.04 - - - - 0.292 0.37 - - - - 0.292 0.41 - - - - 0.292 0.45 - - - - 0.292 0.49 - - - - 0.425 0.49 - - - - 0.425 0.45 - - - - 0.425 0.41 - - - - 0.425 0.37 - - - - 0.425 0.33 - - - - 0.425 0.29 - - - - 0.425 0.25 - - - - 0.425 0.216 - 0.028 0.028 - ./../art/star_filled_spacing.svg - ./../art/star_hollow_3_spacing.svg - - - - 0.52 0.3 - 0.025 0.577 - - - - 0.615 0.22 - 0.359 0.68 - left - 0.01 - - - - + + 3 + ./../simple-dark.xml + + + + + ./art/moonlight_art_blur.png + + + + ./art/moonlight.svg + + + + 00000077 + 00000077 + + + + + + + + Moonlight + 1 + 0.45 0.08 + 0.527 0.01 + 0098a6 + ./../art/Roboto-Light.ttf + 0.055 + right + + + + Streaming + 1 + 0.45 0.08 + 0.527 0.07 + 0098a6 + ./../art/Roboto-Light.ttf + 0.055 + right + + + + ./art/moonlight.svg + 0.025 0.0775 + 0.55 0.1 + 0 0.5 + + + + + + + + 0.025 0.22 + 0.950 0.68 + center + 0.01 + + + + + + + + + + 0.025 0.22 + 0.245 0.301 + 0 0 + + + + 0.292 0.21 + + + + 0.292 0.25 + + + + 0.292 0.29 + 0.133 0.04 + + + + 0.292 0.33 + 0.133 0.04 + + + + 0.292 0.37 + + + + 0.292 0.41 + + + + 0.292 0.45 + + + + 0.292 0.49 + + + + 0.425 0.49 + + + + 0.425 0.45 + + + + 0.425 0.41 + + + + 0.425 0.37 + + + + 0.425 0.33 + + + + 0.425 0.29 + + + + 0.425 0.25 + + + + 0.425 0.216 + 0.028 0.028 + ./../art/star_filled_spacing.svg + ./../art/star_hollow_3_spacing.svg + + + + 0.52 0.3 + 0.025 0.577 + + + + 0.615 0.22 + 0.359 0.68 + left + 0.01 + + + + \ No newline at end of file diff --git a/themes/simple/moonlight/theme.xml b/themes/simple/moonlight/theme.xml index 33cd40b..1491229 100644 --- a/themes/simple/moonlight/theme.xml +++ b/themes/simple/moonlight/theme.xml @@ -1,171 +1,171 @@ - - 3 - ./../simple.xml - - - - - ./art/moonlight_art_blur.png - - - - ./art/moonlight.svg - - - - 00000088 - 00000088 - - - - - - - - Moonlight - 1 - 0.45 0.08 - 0.527 0.01 - 7b7d7f - ./../art/OPENSANS-LIGHT.TTF - 0.055 - right - - - - Streaming - 1 - 0.45 0.08 - 0.527 0.07 - 7b7d7f - ./../art/OPENSANS-LIGHT.TTF - 0.055 - right - - - - ./art/moonlight.svg - 0.025 0.079 - 0.45 0.1 - 0 0.5 - - - - - - - - 0.025 0.22 - 0.950 0.68 - center - 0.01 - - - - - - - - - - 0.025 0.22 - 0.125 0.301 - 0 0 - - - - 0.177 0.21 - - - - 0.177 0.25 - - - - 0.177 0.29 - 0.133 0.04 - - - - 0.177 0.33 - 0.133 0.04 - - - - 0.177 0.37 - - - - 0.177 0.41 - - - - 0.177 0.45 - - - - 0.177 0.49 - - - - 0.31 0.49 - - - - 0.31 0.45 - - - - 0.31 0.41 - - - - 0.31 0.37 - 0.24 0.04 - - - - 0.31 0.33 - 0.24 0.04 - - - - 0.31 0.29 - 0.24 0.04 - - - - 0.31 0.25 - - - - 0.31 0.216 - 0.028 0.028 - ./../art/star_filled_spacing.svg - ./../art/star_hollow_3_spacing.svg - - - - 0.52 0.3 - 0.025 0.577 - - - - 0.615 0.22 - 0.359 0.68 - left - 0.01 - - - - + + 3 + ./../simple.xml + + + + + ./art/moonlight_art_blur.png + + + + ./art/moonlight.svg + + + + 00000088 + 00000088 + + + + + + + + Moonlight + 1 + 0.45 0.08 + 0.527 0.01 + 7b7d7f + ./../art/OPENSANS-LIGHT.TTF + 0.055 + right + + + + Streaming + 1 + 0.45 0.08 + 0.527 0.07 + 7b7d7f + ./../art/OPENSANS-LIGHT.TTF + 0.055 + right + + + + ./art/moonlight.svg + 0.025 0.079 + 0.45 0.1 + 0 0.5 + + + + + + + + 0.025 0.22 + 0.950 0.68 + center + 0.01 + + + + + + + + + + 0.025 0.22 + 0.125 0.301 + 0 0 + + + + 0.177 0.21 + + + + 0.177 0.25 + + + + 0.177 0.29 + 0.133 0.04 + + + + 0.177 0.33 + 0.133 0.04 + + + + 0.177 0.37 + + + + 0.177 0.41 + + + + 0.177 0.45 + + + + 0.177 0.49 + + + + 0.31 0.49 + + + + 0.31 0.45 + + + + 0.31 0.41 + + + + 0.31 0.37 + 0.24 0.04 + + + + 0.31 0.33 + 0.24 0.04 + + + + 0.31 0.29 + 0.24 0.04 + + + + 0.31 0.25 + + + + 0.31 0.216 + 0.028 0.028 + ./../art/star_filled_spacing.svg + ./../art/star_hollow_3_spacing.svg + + + + 0.52 0.3 + 0.025 0.577 + + + + 0.615 0.22 + 0.359 0.68 + left + 0.01 + + + + \ No newline at end of file