Update Readme
This commit is contained in:
parent
b842c735a3
commit
9edaf030dd
19
README.md
19
README.md
|
@ -3,13 +3,24 @@
|
||||||
|
|
||||||
Rare is currently considered beta software and in no way feature-complete. You **will** run into issues, so make backups first!
|
Rare is currently considered beta software and in no way feature-complete. You **will** run into issues, so make backups first!
|
||||||
|
|
||||||
### Disclaimer
|
|
||||||
I'm in no way experienced in Python or PyQt5 (this project originally was a "Let's learn Python", then became a "Let's learn Qt"), so the code will be messy. If you have suggestions to improve it, please issue a pull request or message me on Discord (CommandMC#7964).
|
|
||||||
|
|
||||||
### Requirements
|
### Requirements
|
||||||
- requests, pillow and pyqt5 installed via PyPI
|
- requests, pillow and pyqt5 installed via PyPI
|
||||||
- Legendary installed somewhere in your $PATH
|
- Legendary installed via PyPI
|
||||||
|
|
||||||
### Usage
|
### Usage
|
||||||
When you run Rare, it'll check if you're currently logged in and walk you through logging in if you aren't.
|
When you run Rare, it'll check if you're currently logged in and walk you through logging in if you aren't.
|
||||||
Once you're logged in, it will pull game covers from the "metadata" folder in Legedary's config folder, join logo and background together and then display a list of games you have in your account. Installed games will appear in full color while not installed ones will appear in black and white.
|
Once you're logged in, it will pull game covers from the "metadata" folder in Legedary's config folder, join logo and background together and then display a list of games you have in your account. Installed games will appear in full color while not installed ones will appear in black and white.
|
||||||
|
|
||||||
|
### Implemented
|
||||||
|
- Launch, install and uninstall games
|
||||||
|
- Authentication(Import from existing installation and via Browser)**(Please test it!)**
|
||||||
|
|
||||||
|
### Todos
|
||||||
|
- Sync saves
|
||||||
|
- Settings
|
||||||
|
- Search Games
|
||||||
|
- In-app Browser to buy games
|
||||||
|
- ...
|
||||||
|
|
||||||
|
If you have features you want to have in this app, create an issue on github or build it yourself. Please report bugs(Especially Windows)
|
||||||
|
|
||||||
|
|
|
@ -148,6 +148,5 @@ class UninstalledGameWidget(QWidget):
|
||||||
data = dia.get_data()
|
data = dia.get_data()
|
||||||
if data != 0:
|
if data != 0:
|
||||||
path = data.get("install_path")
|
path = data.get("install_path")
|
||||||
# TODO
|
|
||||||
logger.info(f"install {self.app_name} in path {path}")
|
logger.info(f"install {self.app_name} in path {path}")
|
||||||
legendaryUtils.install(self.app_name)
|
legendaryUtils.install(self.app_name, path=path)
|
||||||
|
|
Loading…
Reference in a new issue