You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -128,10 +128,10 @@ nix-shell -p \
128
128
qt6.qmake \
129
129
qt6.qtimageformats
130
130
```
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`.
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:
@@ -227,7 +227,7 @@ If you have your roms in a non-default location (default for RetroPie users is `
227
227
*`-g <PATH>`
228
228
*`-o <PATH>`
229
229
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.
231
231
232
232
#### Gathering data for a subset of roms
233
233
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.
Copy file name to clipboardExpand all lines: docs/ARTWORK.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -81,7 +81,7 @@ editor.
81
81
<?xml version="1.0" encoding="UTF-8"?>
82
82
```
83
83
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.
85
85
86
86
#### 'artwork' node [m]
87
87
@@ -91,7 +91,7 @@ This is a special node used to describe the XML language used in the document. D
91
91
</artwork>
92
92
```
93
93
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.
95
95
96
96
#### 'output' node(s) [o]
97
97
@@ -216,7 +216,7 @@ Sets the width and height of the layer. If either is left out it will keep the a
216
216
</figure>
217
217
218
218
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).
220
220
221
221
This attribute can also be applied on 'mask', 'frame' and 'output' nodes.
Copy file name to clipboardExpand all lines: docs/CACHE.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
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.
4
4
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.
6
6
7
7
### Default resource cache folder
8
8
@@ -27,15 +27,15 @@ There is ONE file that you can and should edit inside each of the `/home/<USER>/
27
27
[...]
28
28
```
29
29
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.
31
31
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`.
33
33
34
34
### Update locally cached data
35
35
36
36
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.
37
37
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.
39
39
40
40
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.
41
41
@@ -45,9 +45,9 @@ Preferred way of editing the cache is via the various [`--cache`](CLIHELP.md#-ca
45
45
46
46
!!! warning "Do not edit"
47
47
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.
49
49
50
-
!!! warning "Don't leave custom files in here"
50
+
!!! warning "Do not leave custom files in here"
51
51
52
52
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!
0 commit comments