Skip to content

Commit 9ba3243

Browse files
committed
docs: Update Readme, index to reflect new release changes [ci skip]
1 parent b5e3d65 commit 9ba3243

11 files changed

+147
-88
lines changed

.github/README.md

+63-39
Original file line numberDiff line numberDiff line change
@@ -36,90 +36,114 @@ I created this software to backup [Ghost Mode](https://web.archive.org/web/20190
3636
* Every time you launch it, the program will check the System Registry to see if Ghost Recon Wildlands and Uplay are installed
3737
* When you close it, a file containing the program's settings will be created (or updated if it already exists) inside `%LOCALAPPDATA%\GHOSTbackup`
3838

39-
* Click the first **Browse...** button to select Wildlands save games folder
40-
* Refer to the [PC Gaming Wiki](https://www.pcgamingwiki.com/wiki/Tom_Clancy%27s_Ghost_Recon_Wildlands#Save_game_data_location) if you don't know where they are located
39+
* Click the **Browse...** button under "**Folders** -> **Wildlands save games folder**" to select Wildlands save games folder
40+
* Refer to the [PC Gaming Wiki](https://www.pcgamingwiki.com/wiki/Tom_Clancy%27s_Ghost_Recon_Wildlands#Save_game_data_location) if you don't know where save games are located
4141

42-
* Click the second **Browse...** button to select where Wildlands save games will be backed up to
43-
* Each backup will be stored inside a `yyyyMMdd HHMM` sub-folder
44-
* GHOST Buster will try to detect the latest backup time stamp and display it in the main screen
42+
* Click the **Browse...** button under "**Folders** -> **Backup location**" to select where Wildlands save games will be backed up to
43+
* Each backup will be stored inside a `yyyyMMdd HHmm` sub-folder
4544

4645
* Specify the backup frequency and click the **Start Backup** button. To interrupt the process, click **Stop Backup**
47-
* You can specify a value between 1 and 60
46+
* You can specify a value between 1 and 180
4847

49-
### Dead?
48+
### Restoring a Backup
49+
50+
> ### ⚠️ **WARNING**
51+
>
52+
> Disable cloud synchronization before restoring a backup, otherwise Uplay will redownload the old save games rendering the restore process useless.
53+
>
54+
> Also note that restoring a backup will **OVERWRITE** your old save games and it **CANNOT BE UNDONE**.
55+
56+
#### From Tasks screen
5057

5158
* Close the game
5259
* Choose which backup you want to restore
5360
* _Latest_
54-
* GHOST Buster will restore the latest backup
5561
* _Second-to-last_
56-
* GHOST Buster will restore the second-to-last backup
5762
* If it doesn't exist, you'll be prompted to restore the latest backup instead
58-
* _Let me decide_
59-
* You can choose which backup to restore
6063
* Click the **Restore Backup** button
6164

62-
> ### ⚠️ **WARNING**
63-
>
64-
> Disable cloud synchronization before restoring a backup, otherwise Uplay will redownload the old save games rendering the restore process useless.
65-
>
66-
> Also note that restoring a backup will **OVERWRITE** your old save games and it **CANNOT BE UNDONE**.
65+
#### From Manage Backups screen
66+
67+
* Close the game
68+
* Right click on the backup you want to restore
69+
* Click **Restore**
6770

6871
## Settings
6972

70-
* **Confirm exit (if backup is active)**
73+
* **Interface language**
74+
* *Default: English*
75+
76+
* **Confirm exit when backup is running**
7177
* _Enabled by default_
72-
* The program will warn you before closing it if the backup process is still running
78+
* The program will show a confirmation dialog before quitting if the backup process is running
7379

7480
* **Confirm backup interruption**
7581
* _Disabled by default_
76-
* The program will ask you if you're sure you want to interrupt the running backup process
82+
* The program will show a confirmation dialog before interrupting the backup process
83+
84+
* **Display notifications about backups**
85+
* *Disabled by default*
86+
* The program will display a notification at the edge of the screen every time a backup is performed
87+
* Enable this option only if you play Wildlands in borderless fullscreen or windowed, otherwise the game will lose focus every time the notification is displayed
7788

78-
* **Disable Uplay cloud save sync**
89+
* **Disable Uplay cloud save synchronization on restore**
7990
* _Disabled by default_
80-
* The program will disable Uplay cloud save synchronization prior restoring save games
91+
* The program will disable Uplay cloud save synchronization before restoring a backup
8192
* Keep in mind that the Uplay settings file may change at any time so this setting may not be reliable
8293

83-
* **Check for updates**
94+
* **Enable Uplay cloud save synchronization on exit**
95+
* *Enabled by default*
96+
* *Works only if the previous setting is enabled*
97+
* The program will re-enable Uplay cloud save synchronization before quitting
98+
99+
* **Check for updates on startup**
84100
* _Disabled by default_
85101
* The program will connect to GitHub servers to check if the current version is up to date
86102

87103
* **Remember window position**
88104
* _Disabled by default_
89105
* The program will remember the window position the last time GHOST Buster was used
90106

91-
### Advanced Settings
107+
* **I'm not using the Uplay version of Wildlands**
108+
* _Disabled by default_
109+
* You can specify a different location for the Wildlands executable
92110

93111
* **Write events to a log file**
94112
* _Disabled by default_
95113
* The program will log all events (such as Errors and Warnings) to a file
96-
* The default log file path is `%LOCALAPPDATA%\GHOSTbackup\event.log`
114+
* The default log file location is `%LOCALAPPDATA%\GHOSTbackup\event.log`
97115

98-
* **I'm not using the Uplay version of Wildlands**
99-
* _Disabled by default_
100-
* You can specify a different location for the Wildlands executable
101-
* The program needs to be restarted in order for the change to take effect
102-
103-
All settings are stored inside `%LOCALAPPDATA%\GHOSTbackup`.
116+
All settings are stored inside `%LOCALAPPDATA%\GHOSTbackup\ghostbackup.cfg`.
104117

105118
## Screenshots
106119

107-
### GHOST Buster preview
108-
109120
_Click an image to enlarge it_
110121

111122
<table>
112123
<tr>
113-
<th align="center">Main Screen</th>
114-
<th align="center">Backup Restore</th>
115-
<th align="center">Advanced Settings</th>
116-
<th align="center">Logs</th>
117-
<th align="center">About</th>
124+
<th align="center">Main screen</th>
125+
<th align="center">Backups</th>
126+
<th align="center">Settings</th>
127+
<th align="center">Notification</th>
118128
</tr>
119129
<tr>
120130
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot.png"></td>
121-
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot_restore.png"></td>
131+
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot_manage.png"></td>
122132
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot_settings.png"></td>
133+
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot_notification.png"></td>
134+
</tr>
135+
</table>
136+
137+
<table>
138+
<tr>
139+
<th align="center">Backup restore</th>
140+
<th align="center">Backup deletion</th>
141+
<th align="center">Logs screen</th>
142+
<th align="center">About screen</th>
143+
</tr>
144+
<tr>
145+
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot_restore.png"></td>
146+
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot_delete.png"></td>
123147
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot_logs.png"></td>
124148
<td><img src="https://strappazzon.xyz/GRW-GHOST-Buster/assets/img/screenshot_about.png"></td>
125149
</tr>
@@ -133,9 +157,9 @@ You can [download](https://github.com/Strappazzon/GRW-GHOST-Buster/releases/late
133157

134158
If you are interested in fixing issues and contributing directly to the code base, please see:
135159

136-
* [Building GHOST Buster from its source code](https://github.com/Strappazzon/GRW-GHOST-Buster/blob/master/src/BUILDING.md)
137160
* [Contribution Guidelines](./CONTRIBUTING.md)
138161
* [Code of Conduct](./CODE_OF_CONDUCT.md)
162+
* [Building GHOST Buster from its source code](https://github.com/Strappazzon/GRW-GHOST-Buster/blob/master/src/BUILDING.md)
139163

140164
## License
141165

docs/assets/css/styles.scss

+1
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ code {
152152
}
153153

154154
blockquote {
155+
margin: 0 auto;
155156
color: #cecece;
156157
background-color: rgba(51, 51, 51, 0.7);
157158
}

docs/assets/img/screenshot.png

-23.5 KB
Loading

docs/assets/img/screenshot_about.png

-23.9 KB
Loading

docs/assets/img/screenshot_delete.png

11 KB
Loading

docs/assets/img/screenshot_logs.png

-63.6 KB
Loading

docs/assets/img/screenshot_manage.png

11.5 KB
Loading
164 KB
Loading
-24.8 KB
Loading
-85.2 KB
Loading

docs/index.html

+83-49
Original file line numberDiff line numberDiff line change
@@ -68,73 +68,93 @@ <h2 id="getting-started">Getting Started</h2>
6868
<li>When you close it, a file containing the program's settings will be created (or updated if it already exists) inside <code>%LOCALAPPDATA%\GHOSTbackup</code></li>
6969
</ul>
7070

71-
<li>Click the first <kbd><img src="{{ '/assets/img/icon-37-2.png' | relative_url }}" width="14px" height="13px" alt="" draggable="false">Browse...</kbd> button to select Wildlands save games folder</li>
72-
<ul><li>Refer to the <a href="https://www.pcgamingwiki.com/wiki/Tom_Clancy%27s_Ghost_Recon_Wildlands#Save_game_data_location">PC Gaming Wiki</a> if you don't know where they are located</li></ul>
71+
<li>Click the <kbd><img src="{{ '/assets/img/icon-37-2.png' | relative_url }}" width="14px" height="13px" alt="" draggable="false">Browse...</kbd> button under "<strong>Folders</strong> -> <strong>Wildlands save games folder</strong>" to select Wildlands save games folder</li>
72+
<ul><li>Refer to the <a href="https://www.pcgamingwiki.com/wiki/Tom_Clancy%27s_Ghost_Recon_Wildlands#Save_game_data_location">PC Gaming Wiki</a> if you don't know where save games are located</li></ul>
7373

74-
<li>Click the second <kbd><img src="{{ '/assets/img/icon-37-2.png' | relative_url }}" width="14px" height="13px" alt="" draggable="false">Browse...</kbd> button to select where Wildlands save games will be backed up to</li>
74+
<li>Click the <kbd><img src="{{ '/assets/img/icon-37-2.png' | relative_url }}" width="14px" height="13px" alt="" draggable="false">Browse...</kbd> button under "<strong>Folders</strong> -> <strong>Backup location</strong>" to select where Wildlands save games will be backed up to</li>
7575
<ul>
76-
<li>Each backup will be stored inside a <code>yyyyMMdd HHMM</code> sub-folder</li>
77-
<li>GHOST Buster will try to detect the latest backup time stamp and display it in the main screen</li>
76+
<li>Each backup will be stored inside a <code>yyyyMMdd HHmm</code> sub-folder</li>
7877
</ul>
7978

8079
<li>Specify the backup frequency and click the <kbd><img src="{{ '/assets/img/icon-34-1.png' | relative_url }}" width="16px" height="14px" alt="" draggable="false">Start Backup</kbd> button. To interrupt the process, click <kbd><img src="{{ '/assets/img/icon-38-2.png' | relative_url }}" width="14px" height="15px" alt="" draggable="false">Stop Backup</kbd></li>
81-
<ul><li>You can specify a value between 1 and 60</li></ul>
80+
<ul><li>You can specify a value between 1 and 180</li></ul>
8281
</ul>
8382

84-
<h3 id="dead">Dead?</h3>
83+
<h3 id="restoring-backup">Restoring a backup</h3>
84+
85+
<blockquote>
86+
<p class="quote-title">Warning</p>
87+
<p class="quote-text">
88+
Disable cloud synchronization before restoring a backup, otherwise Uplay will redownload the old save games rendering the restore process useless.
89+
Also note that restoring a backup will <strong>OVERWRITE</strong> your old save games and it <strong>CANNOT BE UNDONE</strong>.
90+
</p>
91+
</blockquote>
92+
93+
<h4>From Tasks screen</h4>
8594

8695
<ul>
8796
<li>Close the game</li>
8897
<li>Choose which backup you want to restore</li>
8998
<ul>
9099
<li><em>Latest</em></li>
91-
<ul><li>GHOST Buster will restore the latest backup</li></ul>
92100
</ul>
93101
<ul>
94102
<li><em>Second-to-last</em></li>
95-
<ul>
96-
<li>GHOST Buster will restore the second-to-last backup</li>
97-
<li>If it doesn't exist, you'll be prompted to restore the latest backup instead</li>
98-
</ul>
99-
</ul>
100-
<ul>
101-
<li><em>Let me decide</em></li>
102-
<ul><li>You can choose which backup to restore</li></ul>
103+
<ul><li>If it doesn't exist, you'll be prompted to restore the latest backup instead</li></ul>
103104
</ul>
104105
<li>Click the <kbd><img src="{{ '/assets/img/icon-39-2.png' | relative_url }}" width="14px" height="16px" alt="" draggable="false">Restore Backup</kbd> button</li>
105106
</ul>
106107

107-
<blockquote>
108-
<p class="quote-title">Warning</p>
109-
<p class="quote-text">
110-
Disable cloud synchronization before restoring a backup, otherwise Uplay will redownload the old save games rendering the restore process useless.
111-
Also note that restoring a backup will <strong>OVERWRITE</strong> your old save games and it <strong>CANNOT BE UNDONE</strong>.
112-
</p>
113-
</blockquote>
108+
<h4>From Manage Backups screen</h4>
109+
110+
<ul>
111+
<li>Close the game</li>
112+
<li>Right click on the backup you want to restore</li>
113+
<li>Click <strong>Restore</strong></li>
114+
</ul>
114115

115116
<h2 id="settings">Settings</h2>
116117

117118
<ul>
118-
<li><strong>Confirm exit (if backup is active)</strong></li>
119+
<li><strong>Interface language</strong></li>
120+
<ul>
121+
<li><em>Default: English</em></li>
122+
</ul>
123+
124+
<li><strong>Confirm exit when backup is running</strong></li>
119125
<ul>
120126
<li><em>Enabled by default</em></li>
121-
<li>The program will warn you before closing it if the backup process is still running</li>
127+
<li>The program will show a confirmation dialog before quitting if the backup process is running</li>
122128
</ul>
123129

124130
<li><strong>Confirm backup interruption</strong></li>
125131
<ul>
126132
<li><em>Disabled by default</em></li>
127-
<li>The program will ask you if you're sure you want to interrupt the running backup process</li>
133+
<li>The program will show a confirmation dialog before interrupting the backup process</li>
128134
</ul>
129135

130-
<li><strong>Disable Uplay cloud save sync</strong></li>
136+
<li><strong>Display notifications about backups</strong></li>
131137
<ul>
132138
<li><em>Disabled by default</em></li>
133-
<li>The program will disable Uplay cloud save synchronization prior restoring save games</li>
139+
<li>The program will display a notification at the edge of the screen every time a backup is performed</li>
140+
<li>Enable this option only if you play Wildlands in borderless fullscreen or windowed, otherwise the game will lose focus every time the notification is displayed</li>
141+
</ul>
142+
143+
<li><strong>Disable Uplay cloud save synchronization on restore</strong></li>
144+
<ul>
145+
<li><em>Disabled by default</em></li>
146+
<li>The program will disable Uplay cloud save synchronization before restoring a backup</li>
134147
<li>Keep in mind that the Uplay settings file may change at any time so this setting may not be reliable</li>
135148
</ul>
136149

137-
<li><strong>Check for updates</strong></li>
150+
<li><strong>Enable Uplay cloud save synchronization on exit</strong></li>
151+
<ul>
152+
<li><em>Enabled by default</em></li>
153+
<li><em>Works only if the previous setting is enabled</em></li>
154+
<li>The program will re-enable Uplay cloud save synchronization before quitting</li>
155+
</ul>
156+
157+
<li><strong>Check for updates on startup</strong></li>
138158
<ul>
139159
<li><em>Disabled by default</em></li>
140160
<li>The program will connect to GitHub servers to check if the current version is up to date</li>
@@ -145,66 +165,80 @@ <h2 id="settings">Settings</h2>
145165
<li><em>Disabled by default</em></li>
146166
<li>The program will remember the window position the last time GHOST Buster was used</li>
147167
</ul>
148-
</ul>
149168

150-
<h3 id="advanced-settings">Advanced Settings</h3>
151-
<ul>
152-
<li><strong>Write events to a log file</strong></li>
169+
<li><strong>I'm not using the Uplay version of Wildlands</strong></li>
153170
<ul>
154171
<li><em>Disabled by default</em></li>
155-
<li>The program will log all events (such as Errors and Warnings) to a file</li>
156-
<li>The default log file path is <code>%LOCALAPPDATA%\GHOSTbackup\event.log</code></li>
172+
<li>You can specify a different location for the Wildlands executable</li>
157173
</ul>
158174

159-
<li><strong>I'm not using the Uplay version of Wildlands</strong></li>
175+
<li><strong>Write events to a log file</strong></li>
160176
<ul>
161177
<li><em>Disabled by default</em></li>
162-
<li>You can specify a different location for the Wildlands executable</li>
163-
<li>The program needs to be restarted in order for the change to take effect</li>
178+
<li>The program will log all events (such as Errors and Warnings) to a file</li>
179+
<li>The default log file location is <code>%LOCALAPPDATA%\GHOSTbackup\event.log</code></li>
164180
</ul>
165181
</ul>
166182

167-
<p>All settings are stored inside <code>%LOCALAPPDATA%\GHOSTbackup</code></p>
183+
<p>All settings are stored inside <code>%LOCALAPPDATA%\GHOSTbackup\ghostbackup.cfg</code></p>
168184

169185
<h2 id="screenshots">Screenshots</h2>
170186

171187
<div class="gallery-title">GHOST Buster Preview</div>
172188

173189
<div class="gallery">
174190
<div class="g-list">
175-
<div class="g-item" onclick="changeScr('screenshot.png', 'Screenshot of the main screen')">
191+
<div class="g-item" onclick="changeScr('screenshot.png', 'Screenshot of Tasks screen')">
176192
<img src="{{ '/assets/img/screenshot_icon.png' | relative_url }}" alt="">
177-
<strong>Main Screen</strong>
193+
<strong>Main screen</strong>
178194
<br>
179195
<span>The main screen of GHOST Buster</span>
180196
</div>
197+
<div class="g-item" onclick="changeScr('screenshot_manage.png', 'Screenshot of Backups screen')">
198+
<img src="{{ '/assets/img/screenshot_icon.png' | relative_url }}" alt="">
199+
<strong>Backups</strong>
200+
<br>
201+
<span>Manage Backups screen</span>
202+
</div>
203+
<div class="g-item" onclick="changeScr('screenshot_settings.png', 'Screenshot of Settings screen')">
204+
<img src="{{ '/assets/img/screenshot_icon.png' | relative_url }}" alt="">
205+
<strong>Settings screen</strong>
206+
<br>
207+
<span>GHOST Buster settings</span>
208+
</div>
209+
<div class="g-item" onclick="changeScr('screenshot_notification.jpg', 'Screenshot of backup notification')">
210+
<img src="{{ '/assets/img/screenshot_icon.png' | relative_url }}" alt="">
211+
<strong>Notification</strong>
212+
<br>
213+
<span>Notification about the current backup</span>
214+
</div>
181215
<div class="g-item" onclick="changeScr('screenshot_restore.png', 'Screenshot of the backup restore process')">
182216
<img src="{{ '/assets/img/screenshot_icon.png' | relative_url }}" alt="">
183-
<strong>Backup Restore</strong>
217+
<strong>Backup restore</strong>
184218
<br>
185219
<span>Restoring a backup</span>
186220
</div>
187-
<div class="g-item" onclick="changeScr('screenshot_settings.png', 'Screenshot of the advanced settings screen')">
221+
<div class="g-item" onclick="changeScr('screenshot_delete.png', 'Screenshot of the backup deletion process')">
188222
<img src="{{ '/assets/img/screenshot_icon.png' | relative_url }}" alt="">
189-
<strong>Advanced Settings Screen</strong>
223+
<strong>Backup deletion</strong>
190224
<br>
191-
<span>GHOST Buster advanced settings</span>
225+
<span>Deleting a backup</span>
192226
</div>
193227
<div class="g-item" onclick="changeScr('screenshot_logs.png', 'Screenshot of the logs screen')">
194228
<img src="{{ '/assets/img/screenshot_icon.png' | relative_url }}" alt="">
195-
<strong>Logs Screen</strong>
229+
<strong>Logs screen</strong>
196230
<br>
197231
<span>All the events are logged here</span>
198232
</div>
199233
<div class="g-item" onclick="changeScr('screenshot_about.png', 'Screenshot of the about screen')">
200234
<img src="{{ '/assets/img/screenshot_icon.png' | relative_url }}" alt="">
201-
<strong>About Screen</strong>
235+
<strong>About screen</strong>
202236
<br>
203-
<span>Information about GHOST Buster</span>
237+
<span>About GHOST Buster</span>
204238
</div>
205239
</div>
206240
<div class="g-scr-cnt">
207-
<a id="scr-a" href="{{ '/assets/img/screenshot.png' | relative_url }}"><img id="scr" class="img-responsive" src="{{ '/assets/img/screenshot.png' | relative_url }}" alt="Screenshot of the main screen"></a>
241+
<a id="scr-a" href="{{ '/assets/img/screenshot.png' | relative_url }}"><img id="scr" class="img-responsive" src="{{ '/assets/img/screenshot.png' | relative_url }}" alt="Screenshot of Tasks screen"></a>
208242
</div>
209243
</div>
210244

0 commit comments

Comments
 (0)