DV Annotate - Revision history

NimrodX: /* Bug Reporting */ fix markup (i keep using Markdown by accident)

2024-12-05T03:39:08Z

Bug Reporting: fix markup (i keep using Markdown by accident)

← Older revision		Revision as of 03:39, 5 December 2024
Line 86:		Line 86:
	=Bug Reporting=		=Bug Reporting=

	For information on troubleshooting and bug reporting info, see the bottom section of the [[Troubleshooting]] page.		For information on troubleshooting and bug reporting info, see the '''bottom section''' of the [[Troubleshooting]] page.

NimrodX: add link to Troubleshooting page

2024-12-05T03:37:03Z

add link to Troubleshooting page

← Older revision		Revision as of 03:37, 5 December 2024
Line 83:		Line 83:

	For questions or other discussion, see the [https://discord.gg/dv Delta V Discord] <code>#workshop</code> channel thread.		For questions or other discussion, see the [https://discord.gg/dv Delta V Discord] <code>#workshop</code> channel thread.

			=Bug Reporting=

			For information on troubleshooting and bug reporting info, see the bottom section of the [[Troubleshooting]] page.

NimrodX: fix up the article and correct errors and such

2024-12-04T22:56:55Z

fix up the article and correct errors and such

← Older revision		Revision as of 22:56, 4 December 2024
Line 3:		Line 3:
	=dV-Annotate Windows Utility=		=dV-Annotate Windows Utility=

	This is a human-readable script for Windows PowerShell 5.1 (the powershell.exe that ships with Windows 10 and later).		This is a human-readable script for Windows PowerShell 5.1 (the powershell.exe that ships with Windows 10 and later). You can [https://github.com/NimrodXMods/dv-annotate/tree/main/windows/build download it from the GitHub repo here.]

	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.		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.
	[[File:Dv-annotate-screenshot1.png\|alt=Screenshot of dv-annotate's Annotate tab\|frame\|Annotate Tab]]		[[File:Dv-annotate-screenshot1.png\|alt=Screenshot of dv-annotate's Annotate tab\|frame\|Annotate Tab]]
	[[File:Dv-annotate-screenshot2.png\|alt=Screenshot of dv-annotate's Review tab\|frame\|Review Tab]]		[[File:Dv-annotate-screenshot2.png\|alt=Screenshot of dv-annotate's Review tab\|frame\|Review Tab]]
	[[File:Dv-annotate-screenshot3.png\|alt=Screenshot of dv-annotate's Archive tab\|frame\|Archive ~~Tabn~~]]		[[File:Dv-annotate-screenshot3.png\|alt=Screenshot of dv-annotate's Archive tab\|frame\|Archive Tab]]

	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.		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.
Line 20:		Line 20:
	'''To actually run it, just right-click on dv-annotate.ps1 in Windows Explorer and select "Run with PowerShell".'''		'''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~~ <code>%AppData%\dV-annotate\</code>~~. It will then offer to move itself to that directory~~ and create a shortcut in its current location that will allow it to be run in a normal manner without opening a terminal window. This shortcut can be moved anywhere you want and it will still work.		The first time it is run it will do a "lightweight install" which means it will offer to move itself to <code>%AppData%\dV-annotate\</code> and create a shortcut in its current location that will allow it to be run in a normal manner without opening a terminal window. This shortcut can be moved anywhere you want and it will still work.

			After running for the first time it will create a settings file in <code>%AppData%\dV-annotate\</code>.

			It can be completely removed by just deleting <code>%AppData%\dV-annotate\</code> and the shortcut.

	==Configuration==		==Configuration==

	If you need to change any paths or settings, see the '''Archive''' tab.		If you need to change any paths or settings, see the '''Archive''' tab. Settings are stored in: <code>%AppData%\dV-annotate\prefs.json</code>

			I tried to do as much autoconfiguration as possible with reasonable defaults.

	~~And if~~ you want to modify the script yourself, all the important functions are at the top of the file ~~will~~ all the ugly tool-generated GUI stuff ~~being~~ toward the bottom. It's just a normal plain text file PowerShell script, so it can be read and edited with any text editor.		If you want to modify the script yourself, all the important functions are at the top of the file and all the ugly tool-generated GUI stuff is toward the bottom. It's just a normal plain text file PowerShell script, so it can be read and edited with any text editor.

	==Usage==		==Usage==

	The easiest way to use this is to run ~~it and minimize~~ it before launching the game. During the game, just bring the window to the front by using <code>Alt+Tab</code>, type in a comment, hit Enter, then <code>Alt+Tab</code> again to make it go away and go back to playing. ~~Having~~ the ~~"Auto-~~pause in background~~" option enabled~~ in ~~dV's~~ settings ~~will be useful~~.		The easiest way to use this is to run it before launching the game. (There's a "Launch dV" button in the Archive tab to make this easier.)

			During the game, just bring the window to the front by using <code>Alt+Tab</code>, type in a comment, hit Enter, then <code>Alt+Tab</code> again to make it go away and go back to playing. By default, the game will automatically pause when it gets sent to the background (unless you changed this in settings).

	As long as you have the Annotate tab selected, the input focus will switch to the textbox and so you can just <code>Alt+Tab</code>, Type a comment, hit enter, and <code>Alt+Tab</code> again to go back to playing.		As long as you have the Annotate tab selected, the input focus will switch to the textbox, the timestamp will be updated to "now", and so you can just <code>Alt+Tab</code>, Type a comment, hit enter, and <code>Alt+Tab</code> again to go back to playing. So switch, type, switch, and the game should pause while typing.

	===Including Screenshots (optional)===		===Including Screenshots (optional)===

	If using Steam then you can use <code>F12</code> to take screenshots of anything interesting. (This requires having the Steam Overlay enabled.) The script by default try to find the Steam screenshots folder for Delta V, and will include screenshots that were taken since the annotation log was reset. Therefore you don't need to delete screenshots to keep them out of the archive.		If using Steam then you can use <code>F12</code> to take screenshots of anything interesting. (This requires having the Steam Overlay enabled for the game.)

			The script by default will try to find the Steam screenshots folder for Delta V, and will include screenshots that were taken since the annotation log was reset. Therefore you don't need to delete older screenshots to keep them out of the archive.

	You can also set your own screenshots folder ~~man usally~~. This folder will ~~also~~ get used to include any jpg or png files newer than the last annotation log reset.		You can also set your own screenshots folder manually. This folder will get used to include any jpg or png files newer than the last annotation log reset. Since it can't tell if a image is a screenshot of the game, it's a good idea to use a folder that only contains screenshots of dV. Any screenshot utility can be used or you can just manually place screenshot images in the directory you set.

	===When to Archive===		===When to Archive===

	The recommended time to create the .zip archive is '''after returning to Enceladus''' (which saves the game) but '''before exiting the game'''. This helps to ensure that the Godot engine log doesn't get blown away and that anything interesting is saved in the game save.		The recommended time to create the .zip archive is '''after returning to Enceladus''' (which saves the game) but '''before exiting the game'''. This helps to ensure that the Godot engine log doesn't get blown away and that anything interesting that happened is saved in the game save data. Creating the archive at other times isn't terrible but isn't as useful as doing so at this time.

	The script '''can archive the game directory while the game is running''' without any problems.		The script '''can archive the game directory while the game is running''' without any problems, so quitting the game is not required.

	==Windows Download==		==Windows Download==

	Download the script from GitHub here: [https://github.com/NimrodXMods/dv-annotate/tree/main/windows dv-annotate.ps1]		Download the script from GitHub here: [https://github.com/NimrodXMods/dv-annotate/tree/main/windows/build dv-annotate.ps1]

	=dv-annotate bash Scripts (Linux/SteamOS/OSX)=		=dv-annotate bash Scripts (Linux/SteamOS/OSX)=

	The ~~gist linked to below contains~~ bash ~~scripts I hacked together help with bug reports~~. I threw these together quickly just for myself, so they’re pretty minimal. But I fixed them up some in case anyone else wants to use them. They're roughly the equivalent of the windows utility above.		The scripts can be downloaded from GitHub here: [https://github.com/NimrodXMods/dv-annotate/tree/main/bash-steamos-linux-osx dv-annotate.sh]

			I threw these scripts together quickly just for myself, so they’re pretty minimal. But I fixed them up some in case anyone else wants to use them. They're roughly the equivalent of the windows utility above, but require familiarity with bash command line usage.

	I use these on SteamOS but they should work on any Linux and probably OSX if the pathnames are set properly.		I use these on SteamOS but they should work on any Linux and probably OSX if the pathnames are set properly.
Line 68:		Line 80:
	Run this to review current annotations or the ones in the most recent archive.		Run this to review current annotations or the ones in the most recent archive.

	=~~=Unix Download=~~=		=Questions?=

	~~The scripts can be downloaded from GitHub here:~~ [https://~~github~~.~~com/NimrodXMods~~/dv~~-annotate~~/~~tree/main/bash-steamos-linux-osx dv-annotate~~.~~sh]~~		For questions or other discussion, see the [https://discord.gg/dv Delta V Discord] <code>#workshop</code> channel thread.

NimrodX: add screenshots and improve formatting of them

2024-12-04T22:25:18Z

add screenshots and improve formatting of them

← Older revision		Revision as of 22:25, 4 December 2024
Line 3:		Line 3:
	=dV-Annotate Windows Utility=		=dV-Annotate Windows Utility=

	~~[[Image:DV_Annotate-image.png\|300px\|thumb\|right]]~~This is a human-readable script for Windows PowerShell 5.1 (the powershell.exe that ships with Windows 10 and later).		This is a human-readable script for Windows PowerShell 5.1 (the powershell.exe that ships with Windows 10 and later).

	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.		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.
			[[File:Dv-annotate-screenshot1.png\|alt=Screenshot of dv-annotate's Annotate tab\|frame\|Annotate Tab]]
			[[File:Dv-annotate-screenshot2.png\|alt=Screenshot of dv-annotate's Review tab\|frame\|Review Tab]]
			[[File:Dv-annotate-screenshot3.png\|alt=Screenshot of dv-annotate's Archive tab\|frame\|Archive Tabn]]

	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.		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.

NimrodX: change links to point to new github repo

2024-12-03T11:31:32Z

change links to point to new github repo

← Older revision		Revision as of 11:31, 3 December 2024
Line 3:		Line 3:
	=dV-Annotate Windows Utility=		=dV-Annotate Windows Utility=

	[[Image:DV_Annotate-image.png\|300px\|thumb\|right]]This is a human-readable script for Windows ~~Powershell~~ 5.1 (the powershell.exe that ships with Windows 10).		[[Image:DV_Annotate-image.png\|300px\|thumb\|right]]This is a human-readable script for Windows PowerShell 5.1 (the powershell.exe that ships with Windows 10 and later).

	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.		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.		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.
Line 11:		Line 11:
	==Installation/Setup==		==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.		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 ~~[https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633~~ review it] because it's a good idea to look for anything suspicious in scripts before running them.)		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".		'''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 <code>%AppData%\dV-annotate\</code>. It will then offer to move itself to that directory and create a shortcut in its current location that will allow it to be run in a normal manner without opening a terminal window. This shortcut can be moved anywhere you want and it will still work.		The first time it is run it will create a settings file in <code>%AppData%\dV-annotate\</code>. It will then offer to move itself to that directory and create a shortcut in its current location that will allow it to be run in a normal manner without opening a terminal window. This shortcut can be moved anywhere you want and it will still work.
Line 35:		Line 35:
	If using Steam then you can use <code>F12</code> to take screenshots of anything interesting. (This requires having the Steam Overlay enabled.) The script by default try to find the Steam screenshots folder for Delta V, and will include screenshots that were taken since the annotation log was reset. Therefore you don't need to delete screenshots to keep them out of the archive.		If using Steam then you can use <code>F12</code> to take screenshots of anything interesting. (This requires having the Steam Overlay enabled.) The script by default try to find the Steam screenshots folder for Delta V, and will include screenshots that were taken since the annotation log was reset. Therefore you don't need to delete screenshots to keep them out of the archive.

	You can also set your own screenshots folder man ~~ually~~. This folder will also get used to include any jpg or png files newer than the last annotation log reset.		You can also set your own screenshots folder man usally. This folder will also get used to include any jpg or png files newer than the last annotation log reset.

	===When to Archive===		===When to Archive===
Line 45:		Line 45:
	==Windows Download==		==Windows Download==

	Download the script from GitHub ~~Gist~~ here: [https://~~gist.~~github.com/NimrodXMods/~~e642e10d50953ef7f8abce7e308c0633~~ dv-annotate.ps1]~~<br />~~		Download the script from GitHub here: [https://github.com/NimrodXMods/dv-annotate/tree/main/windows dv-annotate.ps1]
	~~Use the "Raw" or "Download Zip" buttons in the upper right to download.~~

	=dv-annotate bash Scripts (Linux/SteamOS/OSX)=		=dv-annotate bash Scripts (Linux/SteamOS/OSX)=
Line 68:		Line 67:
	==Unix Download==		==Unix Download==

	The scripts can be downloaded from ~~this~~ GitHub ~~Gist~~: [https://~~gist.~~github.com/NimrodXMods/~~1c0cbd519cc357d4e23d8611be41bc5f~~ dv-annotate.sh]~~<br />~~		The scripts can be downloaded from GitHub here: [https://github.com/NimrodXMods/dv-annotate/tree/main/bash-steamos-linux-osx dv-annotate.sh]
	~~(Use the "Download ZIP" button in the upper right).~~

NimrodX: br tags

2024-11-25T21:48:12Z

br tags

← Older revision		Revision as of 21:48, 25 November 2024
Line 43:		Line 43:
	The script '''can archive the game directory while the game is running''' without any problems.		The script '''can archive the game directory while the game is running''' without any problems.

	==Download==		==Windows Download==

	Download the script from GitHub Gist here: [https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633 dv-annotate.ps1]		Download the script from GitHub Gist here: [https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633 dv-annotate.ps1]<br />
	Use the "Raw" or "Download Zip" buttons in the upper right to download~~.<br />.~~		Use the "Raw" or "Download Zip" buttons in the upper right to download.
	~~These assume that you know what you're doing with 'bash' and how to run these kinds of shell scripts~~.

	=dv-annotate bash Scripts (Linux/SteamOS/OSX)=		=dv-annotate bash Scripts (Linux/SteamOS/OSX)=
Line 67:		Line 66:
	Run this to review current annotations or the ones in the most recent archive.		Run this to review current annotations or the ones in the most recent archive.

	==Download==		==Unix Download==

	The scripts can be downloaded from this GitHub Gist: [https://gist.github.com/NimrodXMods/1c0cbd519cc357d4e23d8611be41bc5f dv-annotate.sh] (~~use~~ the "Download ZIP" button).		The scripts can be downloaded from this GitHub Gist: [https://gist.github.com/NimrodXMods/1c0cbd519cc357d4e23d8611be41bc5f dv-annotate.sh]<br />
			(Use the "Download ZIP" button in the upper right).

NimrodX: /* Download */ br

2024-11-25T21:46:06Z

Download: br

← Older revision		Revision as of 21:46, 25 November 2024
Line 46:		Line 46:

	Download the script from GitHub Gist here: [https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633 dv-annotate.ps1]		Download the script from GitHub Gist here: [https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633 dv-annotate.ps1]
	Use the "Raw" or "Download Zip" buttons in the upper right to download. These assume that you know what you're doing with 'bash' and how to run these kinds of shell scripts.		Use the "Raw" or "Download Zip" buttons in the upper right to download.<br />.
			These assume that you know what you're doing with 'bash' and how to run these kinds of shell scripts.

	=dv-annotate bash Scripts (Linux/SteamOS/OSX)=		=dv-annotate bash Scripts (Linux/SteamOS/OSX)=

NimrodX: /* dv-annotate bash Scripts (Linux/SteamOS/OSX) */ Add gist link.

2024-11-25T21:43:51Z

dv-annotate bash Scripts (Linux/SteamOS/OSX): Add gist link.

← Older revision		Revision as of 21:43, 25 November 2024
Line 65:		Line 65:
	===dv-show-annotations===		===dv-show-annotations===
	Run this to review current annotations or the ones in the most recent archive.		Run this to review current annotations or the ones in the most recent archive.

			==Download==

			The scripts can be downloaded from this GitHub Gist: [https://gist.github.com/NimrodXMods/1c0cbd519cc357d4e23d8611be41bc5f dv-annotate.sh] (use the "Download ZIP" button).

NimrodX: add unix dv-annotate scripts

2024-11-25T21:41:25Z

add unix dv-annotate scripts

@@ Line 1: / Line 1: @@
-=dV-Annotate: Windows utility for tracking events and creating a zip for bug reports=
+This page describes two different "dv-annotate" tools: one GUI-based utility for Windows, and one package of simple bash scripts for Linux/SteamOS/OSX. These are for keeping notes on when problems happen (annotations) and creating a zip or tgz archive of the game data directory to aid in debugging.
 [[Image:DV_Annotate-image.png|300px|thumb|right]]This is a human-readable script for Windows Powershell 5.1 (the powershell.exe that ships with Windows 10).
@@ Line 44: / Line 46: @@
 Download the script from GitHub Gist here: [https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633 dv-annotate.ps1]
-Use the "Raw" or "Download Zip" buttons in the upper right to download.
+Use the "Raw" or "Download Zip" buttons in the upper right to download. These assume that you know what you're doing with 'bash' and how to run these kinds of shell scripts.

NimrodX: Add liink to gist containing the script and add more instructions.

2024-11-25T21:08:54Z

Add liink to gist containing the script and add more instructions.

← Older revision		Revision as of 21:08, 25 November 2024
Line 1:		Line 1:
	=dV-Annotate: Windows utility for tracking events and creating a zip for bug reports=		=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).		[[Image:DV_Annotate-image.png\|300px\|thumb\|right]]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.		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.
Line 11:		Line 11:
	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.		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.)		If you double click on the script it won't execute, but instead should get opened in a text editor. (I encourage everyone to [https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633 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".		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 <code>%AppData%\dV-annotate\</code>. It will then offer to move itself to that directory and create a shortcut in its current location that will allow it to be run in a normal manner without opening a terminal window. This shortcut can be moved anywhere you want.		The first time it is run it will create a settings file in <code>%AppData%\dV-annotate\</code>. It will then offer to move itself to that directory and create a shortcut in its current location that will allow it to be run in a normal manner without opening a terminal window. This shortcut can be moved anywhere you want and it will still work.

	==Configuration==		==Configuration==
Line 21:		Line 21:
	If you need to change any paths or settings, see the '''Archive''' tab.		If you need to change any paths or settings, see the '''Archive''' tab.

	And if you want to modify the script yourself, all the important functions are at the top of the file will all the ugly tool-generated GUI stuff being toward the bottom. It's just a normal plain text PowerShell script, so it can be read and edited with any text editor.		And if you want to modify the script yourself, all the important functions are at the top of the file will all the ugly tool-generated GUI stuff being toward the bottom. It's just a normal plain text file PowerShell script, so it can be read and edited with any text editor.

	==Usage==		==Usage==

	The easiest way to use this is to run it and minimize it before launching the game. During the game, just bring the window to the front by using <code>Alt+Tab</code>, type in a comment, then <code>Alt+Tab</code> again to make it go away and go back to playing. Having the "Auto-pause in background" option enabled in dV's settings will be useful.		The easiest way to use this is to run it and minimize it before launching the game. During the game, just bring the window to the front by using <code>Alt+Tab</code>, type in a comment, hit Enter, then <code>Alt+Tab</code> again to make it go away and go back to playing. Having the "Auto-pause in background" option enabled in dV's settings will be useful.

	As long as you have the Annotate tab selected, the input focus will switch to the textbox and so you can just <code>Alt+Tab</code>, Type a comment, hit enter, and <code>Alt+Tab</code> again to go back to playing.		As long as you have the Annotate tab selected, the input focus will switch to the textbox and so you can just <code>Alt+Tab</code>, Type a comment, hit enter, and <code>Alt+Tab</code> again to go back to playing.

	If using Steam then you can use <code>F12</code> to take screenshots of anything interesting. (This requires having the Steam Overlay enabled.) The script by default will ~~look for~~ screenshots to ~~include in~~ the archive ~~that are~~ newer than ~~when~~ the annotation ~~(comment)~~ log ~~was created~~.		===Including Screenshots (optional)===

			If using Steam then you can use <code>F12</code> to take screenshots of anything interesting. (This requires having the Steam Overlay enabled.) The script by default try to find the Steam screenshots folder for Delta V, and will include screenshots that were taken since the annotation log was reset. Therefore you don't need to delete screenshots to keep them out of the archive.

			You can also set your own screenshots folder man ually. This folder will also get used to include any jpg or png files newer than the last annotation log reset.

			===When to Archive===

	The recommended time to create the .zip archive is '''after returning to Enceladus''' (which saves the game) but '''before exiting the game'''. This helps to ensure that the Godot engine log doesn't get blown away and that anything interesting is saved in the game save.		The recommended time to create the .zip archive is '''after returning to Enceladus''' (which saves the game) but '''before exiting the game'''. This helps to ensure that the Godot engine log doesn't get blown away and that anything interesting is saved in the game save.
Line 38:		Line 44:

	Download the script from GitHub Gist here: [https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633 dv-annotate.ps1]		Download the script from GitHub Gist here: [https://gist.github.com/NimrodXMods/e642e10d50953ef7f8abce7e308c0633 dv-annotate.ps1]
			Use the "Raw" or "Download Zip" buttons in the upper right to download.