Skip to content

Commit e545e6c

Browse files
committed
Consistent wording (don't -> do not, can't --> cannot, aso.) and
CLI integer range check and warning if out of range
1 parent ce8d7ae commit e545e6c

28 files changed

Lines changed: 147 additions & 122 deletions

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -128,10 +128,10 @@ nix-shell -p \
128128
qt6.qmake \
129129
qt6.qtimageformats
130130
```
131-
You may omit `p7zip` if you don't want to enable the [`unpack`](https://gemba.github.io/skyscraper/CLIHELP/?h=unp#unpack) option of Skyscraper. If you want to use the `update_skyscraper.sh` script also install `python3`. Then proceed with this [section](#updating-skyscraper) for release build or this [section](#download-compile-and-install) for a development build of `main/HEAD`.
131+
You may omit `p7zip` if you do not want to enable the [`unpack`](https://gemba.github.io/skyscraper/CLIHELP/?h=unp#unpack) option of Skyscraper. If you want to use the `update_skyscraper.sh` script also install `python3`. Then proceed with this [section](#updating-skyscraper) for release build or this [section](#download-compile-and-install) for a development build of `main/HEAD`.
132132

133133
#### macOS <img src="docs/resources/os/macOS.svg" width="20px">
134-
Skyscraper works perfectly on macOS as well but is not officially supported as I don't own a Mac. Here are the commands needed to install the Qt6 and other prerequisites. You can skip the Qt5 _un_install if you don't have it installed:
134+
Skyscraper works perfectly on macOS as well but is not officially supported as I do not own a Mac. Here are the commands needed to install the Qt6 and other prerequisites. You can skip the Qt5 _un_install if you do not have it installed:
135135
```
136136
$ /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
137137
$ brew uninstall qt@5
@@ -227,7 +227,7 @@ If you have your roms in a non-default location (default for RetroPie users is `
227227
* `-g <PATH>`
228228
* `-o <PATH>`
229229

230-
For almost any command line option, consider setting them in the `/home/<USER>/.skyscraper/config.ini` file as described in the detailed [config file documentation](https://gemba.github.io/skyscraper/CONFIGINI/). This will make the options permanent so you don't need to type them in all the time.
230+
For almost any command line option, consider setting them in the `/home/<USER>/.skyscraper/config.ini` file as described in the detailed [config file documentation](https://gemba.github.io/skyscraper/CONFIGINI/). This will make the options permanent so you do not need to type them in all the time.
231231

232232
#### Gathering data for a subset of roms
233233
Skyscraper offers several ways of gathering data for a subset of roms. If you just want to scrape the roms that have no data in the cache whatsoever, you can do so with the `--onlymissing` command-line option. You can also check out the `--startat FILENAME` and `--endat FILENAME` options. If you just want to gather data for a couple of roms you can simply add the filename(s) to the end of the command-line (eg. `Skyscraper -p amiga -s openretro "/path/to/rom name 1.lha" "/path/to/rom name 2.lha"`). And probably the most advanced (and quite handy) way to gather data for a subset of roms is to make use of the `--cache report:missing=RESOURCE` option. This can generate a report containing the filenames that are missing a certain resource. You can then feed the report back into Skyscraper with the `--includefrom REPORTFILE` afterwards. Skyscraper will then only scrape the files contained in the report.

docs/ARTWORK.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ editor.
8181
<?xml version="1.0" encoding="UTF-8"?>
8282
```
8383

84-
This is a special node used to describe the XML language used in the document. Don't change it.
84+
This is a special node used to describe the XML language used in the document. Do not change it.
8585

8686
#### 'artwork' node [m]
8787

@@ -91,7 +91,7 @@ This is a special node used to describe the XML language used in the document. D
9191
</artwork>
9292
```
9393

94-
This node is the document base node. It contains all other nodes. Don't change or delete it.
94+
This node is the document base node. It contains all other nodes. Do not change or delete it.
9595

9696
#### 'output' node(s) [o]
9797

@@ -216,7 +216,7 @@ Sets the width and height of the layer. If either is left out it will keep the a
216216
</figure>
217217

218218
When you have set width _and_ height you can control with this attribute how the image is fit into the defined dimensions. Possible values for the attribute are `aspect="ignore"`, `aspect="keep"` or `aspect="keepexpand"` (see figure). If the attribute is absent the default is `"ignore"`.
219-
Setting this a non default value comes in handy if you have for example a more complex artwork definition and you want the available space best used while maintaining the aspect ratio and don't care about possible blank space (e.g., letterboxing, pillarboxing) as you may have put an extra mask layer. For more information see the [Qt documentation on this topic](https://doc.qt.io/qt-6/qt.html#AspectRatioMode-enum).
219+
Setting this a non default value comes in handy if you have for example a more complex artwork definition and you want the available space best used while maintaining the aspect ratio and do not care about possible blank space (e.g., letterboxing, pillarboxing) as you may have put an extra mask layer. For more information see the [Qt documentation on this topic](https://doc.qt.io/qt-6/qt.html#AspectRatioMode-enum).
220220

221221
This attribute can also be applied on 'mask', 'frame' and 'output' nodes.
222222

docs/CACHE.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Whenever you scrape any platform with any scraping module, Skyscraper caches each resource internally. A resource can, for instance, be a game `description` or a game `screenshot`. Each game can have several versions of each resource cached locally. One of each type per scraping module. This comes in handy when generating the game list and artwork compositions.
44

5-
Think of the resource cache as the cache in an internet browser. Most of the data on webpages don't change much. By caching some of the data locally, it can load parts of a webpage from that data instead of loading it from the remote server. This is exactly how the Skyscraper cache works. It helps keep the online servers healthy by not hammering them whenever you need resources you already downloaded once. And it allows you to re-generate the frontend game lists if you add new games or perhaps want to change the style of the exported artwork.
5+
Think of the resource cache as the cache in an internet browser. Most of the data on webpages do not change much. By caching some of the data locally, it can load parts of a webpage from that data instead of loading it from the remote server. This is exactly how the Skyscraper cache works. It helps keep the online servers healthy by not hammering them whenever you need resources you already downloaded once. And it allows you to re-generate the frontend game lists if you add new games or perhaps want to change the style of the exported artwork.
66

77
### Default resource cache folder
88

@@ -27,15 +27,15 @@ There is ONE file that you can and should edit inside each of the `/home/<USER>/
2727
[...]
2828
```
2929

30-
For instance, if you know that `thegamesdb` always provides the best `descriptions` for games, you'd add an `<order type="description">` node with a `<source>thegamesdb</source>` subnode. You can have multiple `<source>` nodes, Skyscraper will then prefer the topmost source when generating a game list. If the topmost isn't found it'll prioritize the next one and so forth. Any source that isn't listed with an `<order>` node will be prioritized using timestamps (newest wins) for when each resource was added to the cache. So you don't _have_ to add all of them.
30+
For instance, if you know that `thegamesdb` always provides the best `descriptions` for games, you'd add an `<order type="description">` node with a `<source>thegamesdb</source>` subnode. You can have multiple `<source>` nodes, Skyscraper will then prefer the topmost source when generating a game list. If the topmost isn't found it'll prioritize the next one and so forth. Any source that isn't listed with an `<order>` node will be prioritized using timestamps (newest wins) for when each resource was added to the cache. So you do not _have_ to add all of them.
3131

32-
Skyscraper provides the example file `/home/<USER>/.skyscraper/cache/priorities.xml.example`. Please don't edit this file manually, as it will be overwritten when you update Skyscraper. When a platform is scraped for the first time, it will automatically copy the example file to `/home/<USER>/.skyscraper/cache/<PLATFORM>/priorities.xml` unless it already exists. You can of course also copy the file yourself before scraping a platform. If you do so, be sure to remove the `.example` part of the filename so it's just called `priorities.xml`.
32+
Skyscraper provides the example file `/home/<USER>/.skyscraper/cache/priorities.xml.example`. Please do not edit this file manually, as it will be overwritten when you update Skyscraper. When a platform is scraped for the first time, it will automatically copy the example file to `/home/<USER>/.skyscraper/cache/<PLATFORM>/priorities.xml` unless it already exists. You can of course also copy the file yourself before scraping a platform. If you do so, be sure to remove the `.example` part of the filename so it's just called `priorities.xml`.
3333

3434
### Update locally cached data
3535

3636
If you wish to update / refresh the locally cached resources for a particular platform and scraping module, Skyscraper provides the `--refresh` option. If this flag is set on the command line, any data in the resource cache will be updated with the new incoming data.
3737

38-
If you wish to just refresh the data for a single rom simply scrape it with `-p <PLATFORM> -s <SCRAPING MODULE> <RELATIVE OR FULL ROM PATH AND FILENAME>` and the locally cached data for that particular rom will be updated / refreshed. You can add more filenames one after the other if you like. If any filename or paths has spaces in it, remember to double-quote it like so `"relative path/to rom/rom filename.sfc"`. You don't need the `--refresh` option when updating single files - it is implicit.
38+
If you wish to just refresh the data for a single rom simply scrape it with `-p <PLATFORM> -s <SCRAPING MODULE> <RELATIVE OR FULL ROM PATH AND FILENAME>` and the locally cached data for that particular rom will be updated / refreshed. You can add more filenames one after the other if you like. If any filename or paths has spaces in it, remember to double-quote it like so `"relative path/to rom/rom filename.sfc"`. You do not need the `--refresh` option when updating single files - it is implicit.
3939

4040
When you've updated information in the resource cache, always remember to re-generate the game list by simply running `Skyscraper -p <PLATFORM>` when you're done. The updated resources won't be visible in your frontend until you do.
4141

@@ -45,9 +45,9 @@ Preferred way of editing the cache is via the various [`--cache`](CLIHELP.md#-ca
4545

4646
!!! warning "Do not edit"
4747

48-
MOST FILES AND FOLDERS INSIDE THE `/home/<USER>/.skyscraper/cache` FOLDER ARE NOT MEANT TO BE MANIPULATED BY HAND! It can be done, but don't complain to me about the format of the database. It is NOT meant to be understood by humans. It is meant to be efficient for reading and parsing by Skyscraper itself. Same goes for the media files that reside in the subfolders.
48+
MOST FILES AND FOLDERS INSIDE THE `/home/<USER>/.skyscraper/cache` FOLDER ARE NOT MEANT TO BE MANIPULATED BY HAND! It can be done, but do not complain to me about the format of the database. It is NOT meant to be understood by humans. It is meant to be efficient for reading and parsing by Skyscraper itself. Same goes for the media files that reside in the subfolders.
4949

50-
!!! warning "Don't leave custom files in here"
50+
!!! warning "Do not leave custom files in here"
5151

5252
If you decide to add your own files to the subfolders, you risk them being deleted by Skyscraper later on if it is run with one of the cache cleanup command line options. You've been warned!
5353

0 commit comments

Comments
 (0)