├── src ├── __init__.py ├── gui │ ├── __init__.py │ ├── imgServe.py │ ├── fetchData.py │ └── gui.py ├── gameList.py ├── usrOps.py ├── egResponse.json └── gameOps.py ├── plei.png ├── data ├── dirList.plei └── gameList.plei ├── resources ├── Plei.ico ├── close.png ├── minus.png ├── xbox.png ├── pacman.png ├── tic-tac-toe.png └── credits.txt ├── app.py ├── requirements.txt ├── .gitignore ├── README.md └── LICENSE /src/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /src/gui/__init__.py: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /plei.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/plei.png -------------------------------------------------------------------------------- /data/dirList.plei: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/data/dirList.plei -------------------------------------------------------------------------------- /data/gameList.plei: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/data/gameList.plei -------------------------------------------------------------------------------- /resources/Plei.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/resources/Plei.ico -------------------------------------------------------------------------------- /resources/close.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/resources/close.png -------------------------------------------------------------------------------- /resources/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/resources/minus.png -------------------------------------------------------------------------------- /resources/xbox.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/resources/xbox.png -------------------------------------------------------------------------------- /resources/pacman.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/resources/pacman.png -------------------------------------------------------------------------------- /resources/tic-tac-toe.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sakshatshinde/Plei/HEAD/resources/tic-tac-toe.png -------------------------------------------------------------------------------- /app.py: -------------------------------------------------------------------------------- 1 | # from usrOps import * 2 | from src.gui.gui import plei 3 | 4 | if __name__ == "__main__": 5 | plei() 6 | 7 | 8 | -------------------------------------------------------------------------------- /resources/credits.txt: -------------------------------------------------------------------------------- 1 | All credits for the icons in this project go to : https://www.flaticon.com/ 2 | Plei Icon made by : https://www.flaticon.com/authors/freepik -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | nested-lookup==0.2.19 2 | pip-tools==4.3.0 3 | pipreqs==0.4.12 4 | python-dotenv==0.10.3 5 | six==1.12.0 6 | steamfiles==0.1.4 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | -------------------------------------------------------------------------------- /src/gameList.py: -------------------------------------------------------------------------------- 1 | import enum 2 | 3 | class Game: 4 | def __init__(self, name, gameId, gameStore): 5 | self.name = name 6 | self.gameId = gameId 7 | self.gameStore = gameStore 8 | 9 | class GameStore(enum.Enum): 10 | STEAM = "steam://rungameid/" 11 | EGS = "com.epicgames.launcher://apps/" # + ?action=launch&silent=true" 12 | UPLAY = "uplay://launch/" # launch/ID/0 13 | ORIGIN = "origin://launchgame/" 14 | STANDALONE = "STANDALONE" 15 | 16 | -------------------------------------------------------------------------------- /src/gui/imgServe.py: -------------------------------------------------------------------------------- 1 | import urllib.request 2 | 3 | def retrieveImg(gameName, imgURL): 4 | gameName = legalFileName(gameName) # Windows doesn't like weird stuff in filenames 5 | location = 'data\\img\\' 6 | urllib.request.urlretrieve(imgURL, (location + gameName + ".png")) 7 | 8 | # Making sure windows doesn't cry if : or similar characters appear in the game name 9 | def legalFileName(inString): 10 | checkList = ['<', '>', ':', '"', '/', '\\', '|', '?', '?', '*', '.', ','] 11 | for i in checkList: 12 | if i in inString: 13 | inString = inString.replace(i, '') 14 | return inString 15 | 16 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.gitignore.io/api/visualstudiocode 2 | # Edit at https://www.gitignore.io/?templates=visualstudiocode 3 | 4 | ### VisualStudioCode ### 5 | .vscode/* 6 | !.vscode/settings.json 7 | !.vscode/tasks.json 8 | !.vscode/launch.json 9 | !.vscode/extensions.json 10 | 11 | ### VisualStudioCode Patch ### 12 | # Ignore all local history of files 13 | .history 14 | 15 | ### Python ### 16 | # Byte-compiled / optimized / DLL files 17 | __pycache__/ 18 | *.py[cod] 19 | *$py.class 20 | 21 | ### ignore ### 22 | data/ 23 | build/ 24 | *.rar 25 | *.plei 26 | *.log 27 | *.env 28 | # End of https://www.gitignore.io/api/visualstudiocode 29 | 30 | -------------------------------------------------------------------------------- /src/gui/fetchData.py: -------------------------------------------------------------------------------- 1 | # This DATA is grabbed from GIANT BOMB 2 | # Vist them at : https://www.giantbomb.com/ 3 | # import json 4 | 5 | import pybomb, os 6 | from nested_lookup import nested_lookup 7 | from dotenv import load_dotenv 8 | from imgServe import retrieveImg 9 | 10 | # Client 11 | load_dotenv() # secure way to access API keys 12 | API_KEY = os.getenv('API_KEY') 13 | client = pybomb.GamesClient(API_KEY) 14 | 15 | # Funcs 16 | def gameSearch(gameName: str): 17 | response = client.quick_search( 18 | name = gameName, 19 | platform = pybomb.PC, 20 | sort_by = 'original_release_date', 21 | desc = False 22 | ) 23 | return response.results 24 | 25 | def gameImgSearch(gameName: str): 26 | query = gameSearch(gameName) 27 | try : 28 | result = nested_lookup("medium_url", query)[0] # returns a list 29 | return result 30 | except : 31 | raise Exception('Game not found') 32 | # print(gameImgSearch('Star Wars Jedi: fallen order')) 33 | 34 | def gameRating(gameName: str): 35 | query = gameSearch(gameName) 36 | try : 37 | result = nested_lookup("original_game_rating", query)[0][0] # returns a dict 38 | rating = nested_lookup("name", result)[0] # extracting data 39 | return rating 40 | except : 41 | rating = 'None' 42 | return rating 43 | # print(gameRating('Warframe')) 44 | 45 | def imageCache(gameName: str): 46 | imgURL = gameImgSearch(gameName) 47 | retrieveImg(gameName, imgURL) 48 | # imageCache('Star Wars Jedi: fallen order') #// look in gui/imgServe 49 | 50 | -------------------------------------------------------------------------------- /src/usrOps.py: -------------------------------------------------------------------------------- 1 | import pickle 2 | 3 | # Read the dirList data file and dump into a dict 4 | def readDirList(): 5 | with open('data\\dirList.plei', 'rb') as f: 6 | # print(pickle.load(f)) 7 | return pickle.load(f) #returns dict 8 | 9 | GAME_DIRS = readDirList() 10 | # Storing directories of game stores 11 | 12 | global originPath, uPlayPath, steamPath, standalonePath, egsPath 13 | 14 | def storeDirectory(gameStore, storeDir) -> str: 15 | 16 | if(gameStore == "ORIGIN"): 17 | originPath = storeDir 18 | GAME_DIRS[gameStore] = originPath 19 | return(originPath) 20 | 21 | if(gameStore == "UPLAY"): 22 | uPlayPath = storeDir 23 | GAME_DIRS[gameStore] = uPlayPath 24 | return(uPlayPath) 25 | 26 | if(gameStore == "STANDALONE"): 27 | standalonePath = storeDir 28 | GAME_DIRS[gameStore] = standalonePath 29 | return(standalonePath) 30 | 31 | if(gameStore == "STEAM"): 32 | steamPath = storeDir 33 | GAME_DIRS[gameStore] = steamPath 34 | return(steamPath) 35 | 36 | if(gameStore == "EGS"): 37 | egsPath = storeDir 38 | GAME_DIRS[gameStore] = egsPath 39 | return(egsPath) 40 | 41 | # storeDirectory('STEAM','C:\\Program Files (x86)\\Origin Games') 42 | # print(GAME_DIRS) 43 | 44 | 45 | def selection(): 46 | while True: 47 | print("Select a game store") 48 | sel = int(input("\n 1: STEAM \n 2: EGS \n 3: ORIGIN \n 4: UPLAY \n 5: Standalone \n 6: Done \n\n")) 49 | dirLoc = str(input("Input the directory location")) 50 | 51 | if sel == 1: storeDirectory('STEAM', dirLoc) 52 | if sel == 2: storeDirectory('EGS', dirLoc) 53 | if sel == 3: storeDirectory('ORIGIN', dirLoc) 54 | if sel == 4: storeDirectory('UPLAY', dirLoc) 55 | if sel == 5: storeDirectory('Standalone', dirLoc) 56 | if sel == 6: return 'We are all set!!' 57 | 58 | 59 | # Update the dirList data file 60 | def writeDirList(dirList: dict): 61 | with open('data\\dirList.plei', 'wb') as f: 62 | pickle.dump(dirList, f) 63 | 64 | # print(readDirList()) 65 | # selection() 66 | # writeDirList(GAME_DIRS) 67 | # print(readDirList()) -------------------------------------------------------------------------------- /src/egResponse.json: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "aliases": null, 4 | "api_detail_url": "https://www.giantbomb.com/api/game/3030-72014/", 5 | "date_added": "2019-02-03 18:57:47", 6 | "date_last_updated": "2020-01-12 19:15:11", 7 | "deck": "A free-to-play battle royale spin-off of the Titanfall series, trading the series' trademark mechs for class-based last-squad-standing gameplay.", 8 | "expected_release_day": 4, 9 | "expected_release_month": 2, 10 | "expected_release_quarter": null, 11 | "expected_release_year": 2019, 12 | "guid": "3030-72014", 13 | "id": 72014, 14 | "image": { 15 | "icon_url": "https://www.giantbomb.com/api/image/square_avatar/3079288-box_al.png", 16 | "image_tags": "All Images", 17 | "medium_url": "https://www.giantbomb.com/api/image/scale_medium/3079288-box_al.png", 18 | "original_url": "https://www.giantbomb.com/api/image/original/3079288-box_al.png", 19 | "screen_large_url": "https://www.giantbomb.com/api/image/screen_kubrick/3079288-box_al.png", 20 | "screen_url": "https://www.giantbomb.com/api/image/screen_medium/3079288-box_al.png", 21 | "small_url": "https://www.giantbomb.com/api/image/scale_small/3079288-box_al.png", 22 | "super_url": "https://www.giantbomb.com/api/image/scale_large/3079288-box_al.png", 23 | "thumb_url": "https://www.giantbomb.com/api/image/scale_avatar/3079288-box_al.png", 24 | "tiny_url": "https://www.giantbomb.com/api/image/square_mini/3079288-box_al.png" 25 | }, 26 | "image_tags": [ 27 | { 28 | "api_detail_url": "https://www.giantbomb.com/api/images/3030-72014/?filter=image_tag%3AAll+Images", 29 | "name": "All Images", 30 | "total": 28 31 | }, 32 | { 33 | "api_detail_url": "https://www.giantbomb.com/api/images/3030-72014/?filter=image_tag%3ABox+Art", 34 | "name": "Box Art", 35 | "total": 3 36 | }, 37 | { 38 | "api_detail_url": "https://www.giantbomb.com/api/images/3030-72014/?filter=image_tag%3AScreenshots", 39 | "name": "Screenshots", 40 | "total": 22 41 | } 42 | ], 43 | "name": "Apex Legends", 44 | "number_of_user_reviews": 0, 45 | "original_game_rating": [ 46 | { 47 | "api_detail_url": "https://www.giantbomb.com/api/game_rating/3065-1/", 48 | "id": 1, 49 | "name": "ESRB: T" 50 | } 51 | ], 52 | "original_release_date": null, 53 | "platforms": [ 54 | { 55 | "abbreviation": "PC", 56 | "api_detail_url": "https://www.giantbomb.com/api/platform/3045-94/", 57 | "id": 94, 58 | "name": "PC", 59 | "site_detail_url": "https://www.giantbomb.com/pc/3045-94/" 60 | }, 61 | { 62 | "abbreviation": "XONE", 63 | "api_detail_url": "https://www.giantbomb.com/api/platform/3045-145/", 64 | "id": 145, 65 | "name": "Xbox One", 66 | "site_detail_url": "https://www.giantbomb.com/xbox-one/3045-145/" 67 | }, 68 | { 69 | "abbreviation": "PS4", 70 | "api_detail_url": "https://www.giantbomb.com/api/platform/3045-146/", 71 | "id": 146, 72 | "name": "PlayStation 4", 73 | "site_detail_url": "https://www.giantbomb.com/playstation-4/3045-146/" 74 | } 75 | ], 76 | "site_detail_url": "https://www.giantbomb.com/apex-legends/3030-72014/" 77 | } 78 | ] -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Plei 3 | **A game launcher with no bloat** 4 | 5 | [![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)
6 | [![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html) 7 | 8 | > **Warning**
9 | > **Install might break due to:** https://github.com/leovp/steamfiles/pull/20
10 | 11 | 12 | **This project is ready for the launchers given below!** 13 | 14 | - [x] Steam 15 | - [x] Origin 16 | - [x] Epic Games Launcher 17 | - [x] Uplay 18 | - [ ] Standalone Games (Not gonna do this anytime soon :c) 19 | 20 | --- 21 | 22 | ## Why is this a thing? 23 | 24 | As new game launchers came into being it increasingly got annoying to keep track of all the games over different stores/platform. I wanted to make a unified front where users can access all their games, including the one with no launchers. The goal behind this launcher is to be simple, minimilistic and **bloat-free** 25 | 26 | --- 27 | 28 | ## How to install? (For Devs) 29 | 30 | #### This installation assumed you have python 3.X installed. [Get python here](https://www.python.org/ftp/python/3.8.1/python-3.8.1-amd64.exe) 31 | - Download [Plei](https://github.com/sakshatshinde/Plei/archive/master.zip) and extract it to your desired location 32 | - Run the following command 33 | > pip install -r requirements.txt 34 | - It might error out on "steamfiles" install. To fix this change your pip version to 9.0.X and run the above command again 35 | > python -m pip install pip==9.0.3 36 | - app.pyw will launch Plei 37 | - Rename app.pyw to app.py to see the console message for logging/testing 38 | 39 | --- 40 | 41 | 42 | ## How to use it? 43 | 44 | - When asked, the user must point the appropriate path to your game libraries. As in when asked for Steam point it to your Steam library (steamapps folder) 45 | - If you have all your libraries in their default position no need to set them up again. Eg: `C:\Program Files(x86)\Origin Games\` 46 | - The above mentioned process maybe fully automated in the future 47 | - After the initial setup you will be greeted with the installed games, just click on one to play it. Its that simple! 48 | 49 | --- 50 | 51 | ## Future endeavors 52 | 53 | - Game recommendations based on your current library 54 | - Statistics about your gaming habbits 55 | 56 | --- 57 | 58 | ## Why is this launcher dependent on other launchers? 59 | 60 | Sadly, Some games need the parent launcher to be running in order to launch them. If you try to launch the game from it's binary `exe` it may refuse to launch. To keep things simple, compatible and working as intended, this design decision had to be made. If anyone finds a workaround I'd be happy to implement it, you may contribute to the project directly as well. 61 | 62 | --- 63 | 64 | :triangular_ruler: :pencil2: :straight_ruler: 65 | ## Diagram 66 | 67 | [![](https://mermaid.ink/img/eyJjb2RlIjoiZ3JhcGggTFJcblxuQT5QbGVpXSAtLT4gU3t7U3RlYW19fVxuQSAtLT4gRXt7RUdTfX1cbkEgLS0-IE97e09yaWdpbn19XG5BIC0tPiBVe3t1UGxheX19XG5BIC0tPiBCe3tiYXR0bGVOZXR9fVxuQSAtLT4gUFtPZmZsaW5lIEdhbWVzXVxuUyAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuRSAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuTyAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuVSAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuQiAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuUCAtLT4gYmluKEJpbmFyeSBFWEUpXG5OIC0uLT4gTChbTGF1bmNoIHRoZSBnYW1lXSlcbmJpbiAtLi0-IEwiLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ)](https://mermaid-js.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ3JhcGggTFJcblxuQT5QbGVpXSAtLT4gU3t7U3RlYW19fVxuQSAtLT4gRXt7RUdTfX1cbkEgLS0-IE97e09yaWdpbn19XG5BIC0tPiBVe3t1UGxheX19XG5BIC0tPiBCe3tiYXR0bGVOZXR9fVxuQSAtLT4gUFtPZmZsaW5lIEdhbWVzXVxuUyAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuRSAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuTyAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuVSAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuQiAtLT4gTihTdG9yZSBOZXR3b3JrIFByb3RvY29sKVxuUCAtLT4gYmluKEJpbmFyeSBFWEUpXG5OIC0uLT4gTChbTGF1bmNoIHRoZSBnYW1lXSlcbmJpbiAtLi0-IEwiLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ) 68 | 69 | --- 70 | 71 | -------------------------------------------------------------------------------- /src/gui/gui.py: -------------------------------------------------------------------------------- 1 | def plei(): 2 | import tkinter as tk 3 | from tkinter import ttk 4 | import tkinter.font as fontyPoo # Sorry for the weird name :p 5 | import winsound, pickle 6 | from src.gameOps import readData, sync, launchGame 7 | # import fetchData 8 | 9 | BG_VAL = "#212121" 10 | FG_VAL = "#D2BF55" 11 | 12 | def close(): #Close the window 13 | root.destroy() 14 | 15 | def minWin(): #minimze the window 16 | root.withdraw() 17 | root.overrideredirect(False) 18 | root.iconify() 19 | 20 | def check_map(event): # apply override on deiconify. 21 | if str(event) == "": 22 | root.overrideredirect(True) 23 | else: 24 | pass 25 | 26 | # def rating(): 27 | # ratingList = [] 28 | # allGames = GAMES 29 | # for game in allGames: 30 | # ratingList.append(fetchData.gameRating(game)) 31 | # final = dict(zip(allGames, ratingList)) 32 | # print(final) 33 | 34 | # rating() 35 | 36 | # Hover functions 37 | def onEnterMin(e): 38 | minBtn['background'] = '#424242' 39 | 40 | def onLeaveMin(e): 41 | minBtn['background'] = BG_VAL 42 | 43 | def onEnterClose(e): 44 | closeBtn['background'] = '#424242' 45 | 46 | def onLeaveClose(e): 47 | closeBtn['background'] = BG_VAL 48 | 49 | 50 | 51 | root = tk.Tk() 52 | 53 | # removes title bar 54 | root.overrideredirect(True) 55 | 56 | # Window config 57 | root.configure(background = BG_VAL, height = 800, width = 1600) 58 | root.resizable(tk.FALSE, tk.FALSE) 59 | 60 | # sets the window in center of the screen 61 | try: 62 | root.eval('tk::PlaceWindow %s center' % root.winfo_pathname(root.winfo_id())) 63 | # fix for some devices 64 | except: 65 | root.eval('tk::PlaceWindow %s center' % root.winfo_toplevel()) 66 | 67 | # Title 68 | titleLine = tk.Label( root, 69 | text = 'Plei - A game launcher with no bloat', 70 | fg = '#039be5', 71 | background = BG_VAL, 72 | font=('Helvetica', 11, 'bold'), 73 | relief = tk.FLAT 74 | ) 75 | titleLine.place(x = root.winfo_width()/2, y = 20 , anchor= 'center') 76 | 77 | 78 | # Game list 79 | sync() # Update List STATE 80 | GAMES = readData() # Read from plei data file 81 | customFont = fontyPoo.Font(size = 12) 82 | gameList = tk.Listbox(root, 83 | bg = BG_VAL, 84 | bd = 20, 85 | fg = '#ffab40', 86 | relief = tk.FLAT, 87 | highlightthickness = 5, 88 | selectmode = tk.SINGLE, 89 | height = 35, 90 | highlightcolor = '#f2209e', 91 | selectbackground = BG_VAL, 92 | selectforeground = '#039be5', 93 | width = 0, 94 | activestyle = tk.NONE, 95 | font = customFont 96 | ) 97 | 98 | gameList.yview() #vertical scroll 99 | gameList.insert(0, *GAMES) 100 | gameList.place(x = root.winfo_width()/55, y = 40, anchor = tk.NW ) 101 | 102 | # A class to save object state 103 | class Selection: 104 | currentSelection = '' 105 | 106 | # Selecting the game from the list 107 | def curSelect(evt): 108 | # Save the selection state inside the class variable 109 | Selection.currentSelection = gameList.get(tk.ANCHOR) 110 | gameList.bind('<>',curSelect) 111 | 112 | # Launching the selected game 113 | def launch(): 114 | launchGame(Selection.currentSelection) 115 | 116 | # Launch button label 117 | launchLabel = tk.Label( root, 118 | text = 'Plei ', 119 | fg = '#039be5', 120 | background = BG_VAL, 121 | font = ('Helvetica', 20, 'bold'), 122 | relief = tk.FLAT 123 | ) 124 | launchLabel.place(x = root.winfo_width()/2, y = root.winfo_height()/2.5, anchor= tk.CENTER) 125 | 126 | # Launch Button 127 | launchIcon = tk.PhotoImage(file = 'resources\\tic-tac-toe.png') 128 | launchIcon = launchIcon.subsample(5,5) 129 | launchBtn = tk.Button( 130 | root, 131 | image = launchIcon, 132 | background=BG_VAL, 133 | command = launch, 134 | activebackground = BG_VAL, 135 | borderwidth = 0 136 | ) 137 | launchBtn.place(x = root.winfo_width()/2, y = root.winfo_height()/2, anchor = tk.CENTER) 138 | # x = 1200 139 | 140 | # Header 141 | title = tk.Label( root, 142 | text = 'Games ', 143 | fg = '#039be5', 144 | background = BG_VAL, 145 | font = ('Helvetica', 20, 'bold'), 146 | relief = tk.FLAT 147 | ) 148 | title.place(x = root.winfo_width()/72, y = 60 , anchor= tk.SW) 149 | 150 | # # Image 151 | # img = PhotoImage(file = 'data\\img\\Apex legends.png') # Test image 152 | # label = Label(image = img) 153 | # label.place(x = root.winfo_width()/2, y = root.winfo_height()/2, anchor = CENTER ) 154 | 155 | 156 | # Footer 157 | footer = tk.Label( root, 158 | text = 'Have Fun ', 159 | fg = '#039be5', 160 | background = BG_VAL, 161 | font = ('Helvetica', 14, 'bold'), 162 | relief = tk.FLAT 163 | ) 164 | footer.place(x = root.winfo_width()/65, y = 765 , anchor = tk.SW) 165 | 166 | # Minimize button 167 | minIcon = tk.PhotoImage(file = 'resources\\minus.png') 168 | minIcon = minIcon.subsample(20,20) 169 | minBtn = tk.Button( 170 | root, 171 | image = minIcon, 172 | background=BG_VAL, 173 | command = minWin, 174 | activebackground = BG_VAL, 175 | borderwidth = 0 176 | ) 177 | minBtn.place(relx = 1, x = -38, y = 5, anchor = tk.NE) 178 | 179 | # Close button 180 | closeIcon = tk.PhotoImage(file = 'resources\\close.png') 181 | #Resizing the image for the button to fit 182 | closeIcon = closeIcon.subsample(20,20) 183 | closeBtn = tk.Button( 184 | root, 185 | image = closeIcon , 186 | command=close, 187 | background=BG_VAL, 188 | activebackground = BG_VAL, 189 | borderwidth = 0 190 | ) 191 | closeBtn.place(relx = 1, x =-5, y = 5, anchor = tk.NE) 192 | 193 | # Hover for buttons 194 | minBtn.bind("", onEnterMin) 195 | minBtn.bind("", onLeaveMin) 196 | closeBtn.bind("", onEnterClose) 197 | closeBtn.bind("", onLeaveClose) 198 | 199 | # Added bindings to pass windows status to function : MAXIMIZE AND MINIMIZE 200 | root.bind('', check_map) 201 | root.bind('', check_map) 202 | root.mainloop() 203 | -------------------------------------------------------------------------------- /src/gameOps.py: -------------------------------------------------------------------------------- 1 | from src.gameList import Game, GameStore 2 | from steamfiles import acf 3 | from collections import OrderedDict 4 | from nested_lookup import nested_lookup 5 | import os, fnmatch , pickle, re, json 6 | import winreg #for Uplay 7 | from src.usrOps import readDirList 8 | 9 | # Master game list for all the games regardless of the launcher 10 | GAME_LIST_MASTER = {} 11 | 12 | # Master game Directory list for all launchers 13 | GAME_DIRS = readDirList() # Gets values from data/dirList.plei 14 | GAME_DIR_STEAM = GAME_DIRS['STEAM'] 15 | GAME_DIR_EGS = GAME_DIRS['EGS'] 16 | GAME_DIR_ORIGIN = GAME_DIRS['ORIGIN'] 17 | # print(GAME_DIR_STEAM +'\n'+ GAME_DIR_EGS +'\n'+ GAME_DIR_ORIGIN) 18 | 19 | 20 | ''' 21 | Possible gameStore values = STEAM, UPLAY, STANDALONE, EGS, ORIGIN, GOG 22 | GameStore is an enum and the class has all the specified values : EGS, ORIGIN etc 23 | gameStore: GameStore makes sure that the gameStore is of type GameStore 24 | gameStore.name is the key itself in the GameStore class 25 | >so for example if we do gameAdd('doki doki', 123234, GameStore.EGS) 26 | >we get "EGS" from the GameStore into -> the GAME_LIST_MASTER 27 | ''' 28 | 29 | def gameAdd(gameName, gameId, gameStore: GameStore): 30 | game = Game(gameName, gameId, gameStore.name) 31 | GAME_LIST_MASTER[game.name] = [game.gameId, gameStore.name] 32 | #gameAdd('Apex Legends', 4444, GameStore.ORIGIN) 33 | #print(GAME_LIST_MASTER) 34 | 35 | 36 | ''' 37 | Get the steamapps/ folder path 38 | The steamapps/ folder contains appmanifest_STEAM-ID.acf files 39 | find all files with .acf extension 40 | then open the .acf files, extract the name and the appID from the files 41 | use gameAdd to add the game 42 | ''' 43 | def getSteamIDs(filePath = GAME_DIR_STEAM): #'D:\\SteamLibrary\\steamapps\\' 44 | listOfFiles = os.listdir(filePath) 45 | pattern = "*.acf" 46 | for entry in listOfFiles: 47 | if fnmatch.fnmatch(entry, pattern): 48 | with open(filePath + entry) as acfFile: 49 | STEAM_DATA = acf.load(acfFile, wrapper = OrderedDict) 50 | gameName = nested_lookup('name', STEAM_DATA) 51 | gameAppID = nested_lookup('appid', STEAM_DATA) 52 | gameAdd(gameName[0], gameAppID[0], GameStore.STEAM) #gameName and gameAppID are lists with 1 element only 53 | 54 | # getSteamIDs() 55 | # print(GAME_LIST_MASTER) 56 | 57 | 58 | ''' 59 | Finding binaries for games 60 | Eliminating other types of binaries, eg: uninstall.exe etc 61 | ''' 62 | def getStandalone(filePath = 'D:\\Games\\'): 63 | pattern = "*.exe" 64 | pattern2 = "unin*" 65 | for root, dir, files in os.walk(filePath): 66 | for file in files: 67 | if( 68 | fnmatch.fnmatch(file, pattern) and 69 | fnmatch.fnmatch(file, pattern) != 70 | fnmatch.fnmatch(file, pattern2) 71 | ): 72 | print(file) 73 | 74 | # print(getStandalone()) 75 | 76 | ''' 77 | Origin stores info about the installed games in the C:\ProgamData.... 78 | Inside Each game has its own folder with the same name as of the game 79 | There we have .msft files which we can grab and strip the names and use them as gameIds 80 | we use those gameIds with the cmd -> origin://launchgame/[gameId] to launch games later in launchGame() 81 | ''' 82 | # LINK : https://gaming.stackexchange.com/questions/301777/find-uplay-origin-battle-net-game-id 83 | 84 | def getOriginIDs(filePath = GAME_DIR_ORIGIN): #'C:\\ProgramData\\Origin\\LocalContent\\' 85 | pattern = "*.mfst" 86 | gameName, gameId = [], [] 87 | for root, dirs, files in os.walk(GAME_DIR_ORIGIN): #C:\\ProgramData\\Origin\\LocalContent 88 | for dir in dirs: 89 | gameName.append(dir) 90 | for fileName in files: 91 | if fnmatch.fnmatch(fileName, pattern): 92 | fileName = fileName[:-5] 93 | gameId.append(fileName) 94 | 95 | final = dict(zip(gameName, gameId )) 96 | 97 | for game, gameId in final.items(): 98 | gameAdd(game, gameId, GameStore.ORIGIN) 99 | 100 | # getOriginIDs() 101 | # getSteamIDs() 102 | # print(GAME_LIST_MASTER) 103 | 104 | 105 | ''' 106 | Finding Uplay IDs via registry 107 | ------------------------------ 108 | Uplay afaik doesn't have user accessible data files. So had to go WinRegistry route 109 | Even their game icons have "encrypted" names. 110 | The Uplay IDs have key values stored in them which contain their install directory. 111 | ''' 112 | def getUplayIDs(): 113 | # WOW6432Node -> Represents you are on a 64 bit machines 114 | # If someone can port this to work for 32 bit machines as well Thanks! 115 | baseReg = winreg.ConnectRegistry(None, winreg.HKEY_LOCAL_MACHINE) 116 | subKey = winreg.OpenKey(baseReg, "SOFTWARE\\WOW6432Node\\Ubisoft\\Launcher\\Installs\\") 117 | 118 | for _ in range(50) : 119 | try : 120 | gameId = winreg.EnumKey(subKey, _) 121 | 122 | gameNameKey = winreg.OpenKey(baseReg, "SOFTWARE\\WOW6432Node\\Ubisoft\\Launcher\\Installs\\" + gameId + "\\") 123 | name = winreg.EnumValue(gameNameKey, 1) # Name is a list of keys returned by the func 124 | path = name[1] # The pos 1 contains Game Directory 125 | path = os.path.dirname(path) 126 | gameName = os.path.basename(path) # The path name is actually the ID for the game 127 | 128 | # print('\nThe Game name is: ' + gameName + ' \nThe Game ID is: ' + gameId) 129 | # GAME_LIST_MASTER[gameName] = gameId 130 | gameAdd(gameName, gameId, GameStore.UPLAY) 131 | 132 | except : 133 | pass 134 | 135 | winreg.CloseKey(baseReg) 136 | 137 | 138 | ''' 139 | Finding Epic Games Launcher codenames 140 | ------------------------------------- 141 | Epic Games Launcher uses "special" codenames for each of their games. 142 | I don't know why? Seems extra work 143 | They follow a specific naming theme : All are either flowers / animals 144 | ''' 145 | def getEpicIDs(filePath = GAME_DIR_EGS): #'C:\\ProgramData\\Epic\\UnrealEngineLauncher\\LauncherInstalled.dat' 146 | with open(filePath) as datFile: ##IMP -> GAME_DIR_EGS is actually not a dir but a dat file 147 | 148 | data = json.load(datFile) 149 | codeName = nested_lookup('AppName', data) # returns a list of codeNames 150 | 151 | gameName = [] 152 | dirPath = nested_lookup('InstallLocation', data) # returns a directory path 153 | for name in dirPath: 154 | name = re.search(r"(\\)(\w+)($)", name) # Regex for finding the game's name from the directory path 155 | gameName.append(name.group().strip('\\')) 156 | 157 | final = dict(zip(gameName, codeName)) # combining the game's actual name with the codename 158 | 159 | for game, codeName in final.items(): # Adding game details to the master list 160 | gameAdd(game, codeName, GameStore.EGS) 161 | 162 | 163 | # getEpicIDs() 164 | # print(GAME_LIST_MASTER) 165 | 166 | 167 | ''' 168 | Check if the game exists 169 | Return the gameID and game's store 170 | ''' 171 | def gameSearch(game: str): 172 | gameFound = nested_lookup(game, GAME_LIST_MASTER) 173 | return gameFound 174 | 175 | 176 | ''' 177 | gameInfo initially is a double list. Meaning gameInfo = [[gameId, gameStore]] 178 | [gameInfo] strips down the additional listt = [gameId, gameStore] 179 | gameObj is there to check the Game Store for the game so we can differentiate launch commands 180 | Eg: IF STEAM THEN CMD = "steam://rungameid/" 181 | This CMD is grabbed from the GameStore Enum by .value 182 | ''' 183 | def launchGame(game: str): 184 | try: 185 | [gameInfo] = gameSearch(game) 186 | except: 187 | raise Exception('Check your game Name') 188 | gameId = gameInfo[0] 189 | gameStoreName = gameInfo[1] 190 | 191 | if(gameStoreName == 'STEAM'): 192 | launchStruc = GameStore.STEAM.value 193 | os.startfile(launchStruc + str(gameId)) # Search for an optional -silent flag if possible 194 | 195 | elif(gameStoreName == 'ORIGIN'): 196 | launchStruc = GameStore.ORIGIN.value 197 | os.startfile(launchStruc + str(gameId)) 198 | 199 | elif(gameStoreName == 'EGS'): 200 | launchStruc = GameStore.EGS.value 201 | os.startfile(launchStruc + gameId + '?action=launch&silent=true') 202 | 203 | elif(gameStoreName == 'UPLAY'): 204 | launchStruc = GameStore.UPLAY.value 205 | os.startfile(launchStruc + gameId + '/0') 206 | 207 | else: 208 | print('Something went wrong') 209 | 210 | # launchGame('Apex') 211 | 212 | # Read the gameList data file and dump into a dict 213 | def readData(): 214 | with open('data\\gameList.plei', 'rb') as f: 215 | # print(pickle.load(f)) 216 | return pickle.load(f) #returns dict 217 | 218 | # Update the gameList data file 219 | def writeData(gameList: dict): 220 | with open('data\\gameList.plei', 'wb') as f: 221 | pickle.dump(gameList, f) 222 | 223 | # Syncs the master list to all the installed games 224 | def sync(GAME_LIST_MASTER = GAME_LIST_MASTER): 225 | try: getOriginIDs() 226 | except : pass 227 | try: getSteamIDs() 228 | except : pass 229 | try: getEpicIDs() 230 | except : pass 231 | try: getUplayIDs() 232 | except : pass 233 | 234 | writeData(GAME_LIST_MASTER) 235 | 236 | # sync() 237 | # print(GAME_LIST_MASTER) 238 | 239 | 240 | 241 | 242 | 243 | 244 | 245 | #--------------------------------------------------------------------------------------------- 246 | # Alternative method to get the appIDs for the games 247 | # extract the STEAM_ID from that file name 248 | # The regex re.findall() returns ['STEAM_ID'] so it is a list with just 1 value in it at the 0th position 249 | 250 | 251 | # def getSteamIDs(filePath): 252 | # listOfFiles = os.listdir(filePath) 253 | # pattern = "*.acf" 254 | # for entry in listOfFiles: 255 | # if fnmatch.fnmatch(entry, pattern): 256 | # extractedSteamID = re.findall(r'\d+', str(entry)) # '\d' finds any number (a digit) 257 | # STEAM_ID.append(extractedSteamID[0]) 258 | 259 | 260 | ''' Finding Uplay IDs Old Method -> Depricated ''' 261 | 262 | # def getUplayIDs(filePath = 'C:\\Program Files (x86)\\Ubisoft\\Ubisoft Game Launcher\\data'): 263 | # listOfFiles = os.listdir(filePath) 264 | 265 | # def findIDs(): 266 | # result = re.findall(r'\d+', str(entry)) 267 | # try : return result[0] 268 | # except : pass 269 | 270 | # for entry in listOfFiles: 271 | # uPlayID = findIDs() # '\d' finds any number (a digit) 272 | # if uPlayID != None : print(uPlayID) 273 | # # getUplayIDs() 274 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------