diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 26 insertions, 7 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 an ISO8601 date string, i.e. "2025-07-27", representing the day you +purchased a game. + +`P_DATE` is an ISO8601 date string, i.e. "2025-07-27", representing the day you +beat a game. (i.e. saw the credits or defeated the primary antagonist) + +`C_DATE` is an ISO8601 date string, i.e. "2025-07-27", representing the day you +completed (100%d) a game. + --- Adding a game is trickier than it seems; the OWNERSHIP and PROGRESS fields are @@ -394,23 +414,22 @@ 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 |