Skip to content

Commit 88b45c0

Browse files
authored
Update README.md
1 parent d1c8352 commit 88b45c0

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,40 @@
11
# Games Nebula
22

3-
Unofficial (Linux) CLI and GUI(WIP) client for GOG.
3+
Unofficial (Linux) CLI and GUI (WIP) client for GOG.
44

55
## Important Disclaimer
66

77
**The application is only partially functional (more info below), and its development is currently on hold. The original plan was to release it in 2022, but *unforeseen circumstances* delayed progress, and I have had different priorities since then. As of writing this, I've found some time to piece together the already written code and create a somewhat usable application.**
88

9-
**The previous (prototype) version is available [here]() and likely still works.**
9+
**The previous (prototype) version is available [here](https://github.com/yancharkin/games_nebula/tree/prototype) and likely still works.**
10+
11+
## Differences from the prototype version:
12+
13+
- Much better code quality (though still not necessarily perfect)
14+
- Qt instead of GTK
15+
- Both CLI and GUI clients
16+
- Very few dependencies
17+
- Not fully functional yet :)
1018

1119
## What it is and what it is not
1220

13-
It is a simple application for listing, downloading, installing, and playing games from GOG - nothing more. One notable feature is that, with the app, you can make an offline copy of your GOG library without having to install every single game. I'd also like to add most (but not all) features from the [prototype](), so you can check it out to get an idea of what to expect. However, in general, I’d like to keep it even simpler.
21+
It is a simple application for listing, downloading, installing, and playing games from GOG - nothing more. One notable feature is that, with the app, you can make an offline copy of your GOG library without having to install every single game. I'd also like to add most (but not all) features from the [prototype](https://github.com/yancharkin/games_nebula/tree/prototype), so you can check it out to get an idea of what to expect. However, in general, I’d like to keep it even simpler.
1422

1523
It is **not** a full-featured client like GOG Galaxy, both because it’s impossible for someone outside of CD Projekt to create one, and because I don’t want to.
1624

1725
## CLI
18-
Mostly complete. There may still be a few bugs here and there, but it should be usable. It can be used in both interactive (shell-like) mode and non-interactive mode (like a simpler version of [lgogdownloader]()).
26+
Mostly complete. There may still be a few bugs here and there, but it should be usable. It can be used in both interactive (shell-like) mode and non-interactive mode (like a simpler version of [lgogdownloader](https://github.com/Sude-/lgogdownloader)).
1927

2028
<p align="center">
21-
<img src="screenshots/screenshot_cli.webp" width="80%">
29+
<img src="https://github.com/yancharkin/games_nebula/blob/main/screenshots/screenshot_cli.webp" width="80%">
2230
</p>
2331

24-
## GUI
32+
## GUI (WIP)
2533

2634
Almost nothing works yet. It's possible to view and sort your library, and launch games that were installed using the CLI client. Also, the first launch will take some time, as the app needs to download images for all the games in the library, and right now it is implemented in a less-than-ideal way.
2735

2836
<p align="center">
29-
<img src="screenshots/screenshot_gui.webp" width="80%">
37+
<img src="https://github.com/yancharkin/games_nebula/blob/main/screenshots/screenshot_gui.webp" width="80%">
3038
</p>
3139

3240

@@ -46,12 +54,12 @@ Nothing(?) for CLI, PyQt and PyQtWebEngine 5 or 6 for GUI
4654

4755
- Type 'games_nebula' (without any arguments) in the terminal to run the interactive CLI app.
4856
- Type 'games_nebula --help' in the terminal to see which arguments can be used with the non-interactive CLI app.
49-
- Type 'games_nebula --gui' to run the GUI version of the app.
57+
- Type 'games_nebula --gui' in the terminal to run the GUI version of the app.
5058

5159
## More OSes
5260

5361
Originally, I planned to make the app cross-platform, so with a little extra work, it should be possible to run it on most desktop OSes. However, this task is currently a very low priority.
5462

5563
## Future of the project
5664

57-
Actually, I think most of the work is already done, and it shouldn't be too hard to implement the rest. However, I currently lack both the time and motivation to continue. Hopefully, this will change, as I'd prefer not to abandon the project.
65+
Actually, I think most of the work is already done, and it shouldn't be too hard to implement the rest. However, I currently lack both the time and motivation to continue. Hopefully, this will change, as I'd prefer not to abandon the project.

0 commit comments

Comments
 (0)