-
-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Release 1.10.1
- Loading branch information
Showing
10 changed files
with
136 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,115 +1,42 @@ | ||
# gamevault-app | ||
![logo](https://gamevau.lt/img/logo-text-and-image-sbs.png) | ||
[You can find the official Website/Documentation here](https://gamevau.lt) | ||
[![logo](https://gamevau.lt/img/logo-text-and-image-sbs.png)](https://gamevau.lt) | ||
|
||
## Library Technical Decision Matrix | ||
# GameVault Application | ||
|
||
> This is probably irrelevant to you if you are not a developer. | ||
> GameVault internally needs to behave different in each of the following scenarios. | ||
## Introduction | ||
|
||
<details> | ||
<summary>Scenario 1: No paths exist</summary> | ||
|
||
| Path | State | | ||
| :------------- |:-------------:| | ||
| ``D:/GameVault/Downloads/(74) Assassin's Creed Unity/`` | ``empty or non-existent`` | | ||
| ``D:/GameVault/Installations/(74) Assassin's Creed Unity/`` | ``empty or non-existent`` | | ||
|
||
**When does this happen** | ||
|
||
- The Game was not even downloaded yet. | ||
- The Game was deleted. | ||
|
||
**What needs to be done** | ||
|
||
- Don't show the game in download or library tab (obviously). | ||
|
||
--- | ||
|
||
</details> | ||
|
||
<details> | ||
<summary>Scenario 2: Download Path exists</summary> | ||
**What is GameVault?** | ||
GameVault is an innovative gaming platform providing a self-hosted, source-available alternative to popular gaming platforms. It lets you and your friends enjoy DRM-free games stored on your file server in an organized way. Think of it as a self-hosted Steam. The project you are looking at right now is the client application. | ||
|
||
| Path | State | | ||
| :------------- |:-------------:| | ||
| ``D:/GameVault/Downloads/(74) Assassin's Creed Unity/`` | ``contains the (partial) game.zip`` | | ||
| ``D:/GameVault/Installations/(74) Assassin's Creed Unity/`` | ``empty or non-existent`` | | ||
|
||
**When does this happen** | ||
|
||
- The Game is still downloading. | ||
- The Game was freshly downloaded but not installed. | ||
- The Game was installed sometime ago but then deleted but the download was never cleared (unlikely) | ||
|
||
**What needs to be done** | ||
|
||
- Identify the game using the id | ||
- Show the Game as "Downloaded" in the Downloaded Tab | ||
- Show the Game in the library but grey out the play button, inform the user that they **need to install** the game into the folder `D:/GameVault/Installations/(74) Assassin's Creed Unity/` to play and track it using gamevault. | ||
- Change Download button to play button in Library View -> Game Details, link it to the Installations -> Game entry with greyed out play button. | ||
|
||
--- | ||
|
||
</details> | ||
|
||
<details> | ||
<summary>Scenario 3: Both paths exist</summary> | ||
**Learn More & Get Started** | ||
[You can learn more about the project and find useful guides and information on the official Website.](https://gamevau.lt) | ||
|
||
| Path | State | | ||
| :------------- |:-------------:| | ||
| ``D:/GameVault/Downloads/(74) Assassin's Creed Unity/`` | ``contains the game.zip`` | | ||
| ``D:/GameVault/Installations/(74) Assassin's Creed Unity/`` | ``contains game files (.exe)`` | | ||
|
||
**When does this happen** | ||
## Support 🤝 | ||
|
||
- The Game has been freshly installed and User has not deleted the download yet | ||
- User forgot to delete download files or wants to keep it for offline/archival purposes. | ||
We're working hard in our free time to provide you, your friends, and families with the best self-hosted gaming experience. | ||
It would mean a lot to us if you could support us developers by [getting GameVault+](https://gamevau.lt/gamevault-plus). | ||
|
||
**What needs to be done** | ||
|
||
- Identify the game using the id | ||
- Make the game playable in Installations tab | ||
- Offer User to clear the download folder using "Clear All" button, now that the game is installed to save some space. | ||
- Change Download button to play button in Library View -> Game Details, link it to the Installations -> Game entry. | ||
- Cracktime Daemon monitors Game Folder for running exes | ||
|
||
--- | ||
|
||
</details> | ||
|
||
<details> | ||
<summary>Scenario 4: Installations Path exists</summary> | ||
|
||
| Path | State | | ||
| :------------- |:-------------:| | ||
| ``D:/GameVault/Downloads/(74) Assassin's Creed Unity/`` | ``empty or non-existent`` | | ||
| ``D:/GameVault/Installations/(74) Assassin's Creed Unity/`` | ``contains game files (.exe)`` | | ||
Alternatively, you can support us by donating us some spare dollars on any of these platforms: | ||
|
||
**When does this happen** | ||
- [Ko-Fi](https://ko-fi.com/phalcode) | ||
- [Liberapay](https://liberapay.com/Phalcode) | ||
- [GitHub Sponsors](https://github.com/sponsors/Phalcode) | ||
- [PayPal](https://paypal.me/phalcode) | ||
|
||
- The Game has been installed and the Download deleted. | ||
**TIP FOR DONATORS:** | ||
If you connect your Discord account to Ko-Fi, you'll automatically receive the "@Supporters" role and permanently stand out in our Discord members list. If you donate through a different platform and want to obtain the role, simply send us a message with your receipt as proof that you're truly a Supporter. 🌟 | ||
|
||
**What needs to be done** | ||
## License 📜 | ||
|
||
- Identify the game using the id | ||
- Make the game playable in Installations tab | ||
- Offer User to clear the download folder using "Clear All" button, now that the game is installed to save some space. | ||
- Change Download button to play button in Library View -> Game Details, link it to the Installations -> Game entry. | ||
- Cracktime Daemon monitors Game Folder for running exes | ||
**[CC BY-NC-SA 4.0](http://creativecommons.org/licenses/by-nc-sa/4.0/)** | ||
|
||
--- | ||
This work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-nc-sa/4.0/). | ||
|
||
</details> | ||
This project is not and never was open-source. [Click here to learn why.](https://gamevau.lt/blog/2023/07/13/) | ||
|
||
### License | ||
[![CC BY-NC-SA 4.0][cc-by-nc-sa-shield]][cc-by-nc-sa] | ||
## Legal Disclaimer ⚖️ | ||
|
||
This work is licensed under a | ||
[Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa]. | ||
GameVault manages DRM-free games and is solely a tool to address this need. We are not responsible for the content or files users store or share. | ||
|
||
[![CC BY-NC-SA 4.0][cc-by-nc-sa-image]][cc-by-nc-sa] | ||
When we say DRM-free games, we only mean games obtained legally. While GameVault can theoretically be used with illegally obtained games, we do not endorse or support piracy. | ||
|
||
[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/ | ||
[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png | ||
[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg | ||
Users must be aware of and comply with copyright laws in their respective jurisdictions. We encourage responsible and legal use of GameVault. Unlawful use is strictly improper and unauthorized. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.