diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 51 |
1 files changed, 41 insertions, 10 deletions
@@ -53,6 +53,17 @@ This is the bare minimum information you need to meaningfully track a video game in your collection. With it, you can begin to ask and answer questions you may have about your collection. +Other fields sometimes get added to the database format as new features are +added to VGStash: + +* Notes +* Purchase Date +* Beaten Date +* Completion Date + +These values are completely optional in your collection, but can make VGStash +more useful. + # Python Usage Importing the `vgstash` module is enough to get started! @@ -132,7 +143,7 @@ arguments in brackets are optional ### add ``` -add TITLE SYSTEM [OWNERSHIP] [PROGRESS] [NOTES] +add TITLE SYSTEM [OWNERSHIP] [PROGRESS] [NOTES] [P_DATE] [B_DATE] [C_DATE] ``` Adds a game to the database. @@ -143,6 +154,15 @@ Adds a game to the database. `NOTES` should be a fully-quoted string, with newlines escaped +`P_DATE` is a string representing the date you purchased a game. * + +`B_DATE` is a string representing the date you beat a game. (i.e. saw the +credits or defeated the primary antagonist) * + +`C_DATE` is a string representing the date you completed (100%d) a game. * + +<sup>* An ISO 8601 Date string, i.e. `2025-07-27`.</sup> + --- Adding a game is trickier than it seems; the OWNERSHIP and PROGRESS fields are @@ -209,7 +229,7 @@ exist in the database. If PATH is omitted, it will read from standard input ### list ``` -list [FILTER] [-w WIDTH] [-r] +list [FILTER] [-r] ``` List games in the database, optionally using a FILTER or restricting the output @@ -223,7 +243,7 @@ filters that allow you to reason about your game collection. For example, this command will show you every game marked "playing" that you also own in some way: ```bash -$ vgstash list -w 40 playlog +$ vgstash list playlog Title | System | Own | Progress ---------------------------------------- Crashmo | 3DS | D | P @@ -292,6 +312,13 @@ VGStash has filters for this, too: * **`incomplete`** tracks games whose progress is beaten, but *not* completed * **`complete`** tracks games whose progress is marked completed +#### How long has that game been sitting in my backlog? + +VGStash 0.3 supports date fields for purchasing, beating, and completing a game. + +* **`backlog_age`** shows you how long each game has been in the backlog, assuming + it has a purchase date. + Check `vgstash list --help` for more. ### notes @@ -394,26 +421,30 @@ processing its arguments, so please don't report any bugs dealing with quoting. # Roadmap -These are planned for the full 0.3 release: +Goals planned for the full 0.3 release: -* command line interface finished -* Match feature-set with `master` +With version `0.3b8`, I am feeling more confident in VGStash's capabilities. An +RC is planned with support for generating your vgstash-web page. Goals planned for the 0.4 release: -* import and export with JSON * Iron out any initial bugs on Windows and Mac (testers welcome!) Goals planned for the 0.5 release: -* some sort of GUI (Tk and Qt are current candidates) +* some sort of GUI (Tk, curses, and Qt are current candidates) Goals planned for the 1.0 release: -* Kivy-based interface (to release on Android via F-Droid) +* A richer GUI, built in LOVE2D, SDL, or maybe Web tech. # Contributing -If this interests you, please [e-mail me](mailto:zlg+vgstash@zlg.space). +I'm best reachable [via e-mail](mailto:zlg+vgstash@zlg.space), but I can also be +found on [Twitch](https://twitch.tv/zlg_creates), +[Ko-Fi](https://ko-fi.com/zlg_creates), and [my own website](https://zlg.space). + +Actual contributions should be e-mailed in a git-friendly patch format, so I can +use `git am` to easily merge it. Thank you for your consideration. [spdx-agpl3]: https://spdx.org/licenses/AGPL-3.0-only.html |