DV Annotate

From ΔV: Wiki
Revision as of 18:54, 25 November 2024 by NimrodX (talk | contribs) (initial version of page for this utility script)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

dV-Annotate: Windows utility for tracking events and creating a zip for bug reports

This is a human-readable script for Windows Powershell 5.1 (the powershell.exe that ships with Windows 10).

It is a GUI utility to help people using Windows archive game logs, saved games, screenshots, and also timestamps of events for bug reports. I wrote it in powershell but no knowledge of powershell or command lines is needed to run it.

The reason for a script like this is that it can be rather difficult to keep track of when different things happen during gameplay that might be relevant for debugging, and the more timestamps and descriptive info the developer can get, the less time they have to spend looking for stuff. So this can save a lot of developer time and also make it more possible to discover more issues, etc.

Installation/Setup

This is just a plain text .ps1 (powershell) script, but it creates a GUI so you don't need to run it from the command line. Just download the .ps1 file and save it wherever it's convenient.

If you double click on the script it won't execute, but instead should get opened in a text editor. (I encourage everyone to review it because it's a good idea to look for anything suspicious in scripts before running them.)

To actually run it just right-click on dv-annotate.ps1 in Windows Explorer and select "Run with PowerShell"```.

The first time it is run it will create a settings file in %AppData%\dV-annotate. It will then offer to move itself to that directory and create a shortcut that will allow it to be run without opening a terminal window. This shortcut can be moved anywhere you want.