From c6fea5ecb56609dff5e59bccf58d54f86786f5a0 Mon Sep 17 00:00:00 2001 From: Gemba Date: Fri, 15 Sep 2023 18:49:20 +0200 Subject: [PATCH] removed absolute urls in markdown --- README.md | 6 +++--- docs/ARTWORK.md | 2 +- docs/FAQ.md | 12 ++++++------ docs/SCRAPINGMODULES.md | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9d67ddc9..361ea34d 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Below is the original and slightly adapted README. If you are interested about t A powerful and versatile yet easy to use game scraper written in C++ for use with multiple frontends running on a Linux system (macOS and Windows too, but not officially supported). It scrapes and caches various game resources from various scraping sources, including media such as screenshot, cover and video. It then gives you the option to generate a game list and artwork for the chosen frontend by combining all of the cached resources. -All Skyscraper features are [well-documented](https://github.com/Gemba/skyscraper/tree/master/docs) and there's also a [F.A.Q](https://github.com/Gemba/skyscraper/blob/master/docs/FAQ.md). +All Skyscraper features are [well-documented](docs) and there's also a [F.A.Q](docs/FAQ.md) with answers. ## 🎮Platforms Supported (set with '-p'): Check the full list of platforms [here](docs/PLATFORMS.md). @@ -58,7 +58,7 @@ If that went well, proceed to the default installation instructions below. It sh NOTE 1! User 'davidmgrantham' reports that the `--with-default-names` above might be deprecated for some macOS installations. If you remove it, you also need to download the `update_skyscraper.sh` and edit the `tar` commands to be `gtar` before running it. -NOTE 2! User 'trvrplk' reports numerous issues on MacOS 11.2+. Check [here](https://github.com/Gemba/skyscraper/issues/301) for potential fixes. +NOTE 2! User 'trvrplk' reports numerous issues on MacOS 11.2+. Check [here](https://github.com/muldjord/skyscraper/issues/301) for potential fixes. ### Download, compile and install When you've installed the prerequisites as described above, you can install Skyscraper by typing in the following commands: @@ -141,7 +141,7 @@ One of Skyscraper's most powerful features is the resource cache. It's important ### Custom data I addition to allowing scraping from locally cached resources, Skyscraper also allows you to import your own data into the resource cache with the `-s import` scraping module. You can also edit existing resources in the cache or add individual `user` resources with the `--cache edit` command. Lastly, you also have the option of importing existing EmulationStation game list data into the Skyscraper resource cache if you need it. You can do this with the `-s esgamelist` scraping module. -To read more about any of the features described above, please check out all of the documentation [here](https://github.com/Gemba/skyscraper/tree/master/docs). +To read more about any of the features described above, please check out all of the documentation [here](docs/). ### Artwork look and effects Check the full artwork documentation [here](docs/ARTWORK.md) diff --git a/docs/ARTWORK.md b/docs/ARTWORK.md index 0ed614ee..7001fb25 100644 --- a/docs/ARTWORK.md +++ b/docs/ARTWORK.md @@ -9,7 +9,7 @@ Read on for an example `artwork.xml` and a more thorough description of the ` #### Q: Skyscraper keeps quitting on me with errors about request limits or similar. What's going on?
Expand answer... -**A:** Almost all of the scraping modules, such as ScreenScraper and TheGamesDb, have restrictions applied to avoid users overloading their servers. These restrictions are set by them, not Skyscraper. Some modules even require you to log in to use them. Read more about the restrictions and how to deal with them [here](https://github.com/Gemba/skyscraper/blob/master/docs/SCRAPINGMODULES.md). If you've created a user at ScreenScraper and want to use your credentials with Skyscraper, just add the following section to `/home/USER/.skyscraper/config.ini`. Type it *exactly* like this, but with your own user and pass. +**A:** Almost all of the scraping modules, such as ScreenScraper and TheGamesDb, have restrictions applied to avoid users overloading their servers. These restrictions are set by them, not Skyscraper. Some modules even require you to log in to use them. Read more about the restrictions and how to deal with them [here](SCRAPINGMODULES.md). If you've created a user at ScreenScraper and want to use your credentials with Skyscraper, just add the following section to `/home/USER/.skyscraper/config.ini`. Type it *exactly* like this, but with your own user and pass. ``` [screenscraper] @@ -31,7 +31,7 @@ userCreds="USER:PASS"
Expand answer... -**A:** Skyscraper includes a powerful artwork compositor you can set up any way you like. Read more about the possibilities [here](https://github.com/Gemba/skyscraper/blob/master/docs/ARTWORK.md). If you just want it to export the raw unmodified screenshot and other pieces of artwork, you can use the `/home/USER/.skyscraper/artwork.xml.example2` and copy it to `/home/USER/.skyscraper/artwork.xml`. Remember to regenerate the gamelists after you've done this to make use of the new artwork configuration. This can be done simply by running Skyscraper with `Skyscraper -p PLATFORM`. This will regenerate the gamelist for that platform using this new artwork configuration. +**A:** Skyscraper includes a powerful artwork compositor you can set up any way you like. Read more about the possibilities [here](ARTWORK.md). If you just want it to export the raw unmodified screenshot and other pieces of artwork, you can use the `/home/USER/.skyscraper/artwork.xml.example2` and copy it to `/home/USER/.skyscraper/artwork.xml`. Remember to regenerate the gamelists after you've done this to make use of the new artwork configuration. This can be done simply by running Skyscraper with `Skyscraper -p PLATFORM`. This will regenerate the gamelist for that platform using this new artwork configuration.
#### Q: I've edited the artwork.xml or some other part of Skyscraper's gamelist specific configurations, but the games still show up the same inside my frontend. Why is that? @@ -63,7 +63,7 @@ WARNING!!! Some people tend to run Skyscraper with `sudo Skyscraper ...`. Do *no
Expand answer... -**A:** YES! Absolutely. In addition to taking options from the command-line, Skyscraper also reads the `/home/USER/.skyscraper/config.ini` file, which is where you should set everything up. This file allows you to configure things both globally, per-platform, per-frontend and per-scraping module. Read more about the available options and option priorities [here](https://github.com/Gemba/skyscraper/blob/master/docs/CONFIGINI.md) +**A:** YES! Absolutely. In addition to taking options from the command-line, Skyscraper also reads the `/home/USER/.skyscraper/config.ini` file, which is where you should set everything up. This file allows you to configure things both globally, per-platform, per-frontend and per-scraping module. Read more about the available options and option priorities [here](CONFIGINI.md)
#### Q: When I try to scrape data or generate gamelists I get all sorts of write permission errors and missing configurations. What's going on? diff --git a/docs/SCRAPINGMODULES.md b/docs/SCRAPINGMODULES.md index 5903f016..c55d10d0 100644 --- a/docs/SCRAPINGMODULES.md +++ b/docs/SCRAPINGMODULES.md @@ -3,7 +3,7 @@ Skyscraper supports several online and local sources when scraping data for your Choosing a scraping module is as simply as setting the `-s ` option when running Skyscraper on the command line. It also requires a platform to be set with `-p `. If you leave out the `-s` option Skyscraper goes into *game list generation* mode and combines your cached data into a game list for the chosen platform and frontend. Read more about the resource cache [here](CACHE.md). -For scraping modules that support or require user credentials you have the option of either setting it on commandline with `-u ` or `-u ` or better yet, by adding it permanently to the Skyscraper configuration at `/home/USER/.skyscraper/config.ini` as described [here](https://github.com/Gemba/skyscraper/blob/master/docs/CONFIGINI.md#usercredscredentials-or-key) +For scraping modules that support or require user credentials you have the option of either setting it on commandline with `-u ` or `-u ` or better yet, by adding it permanently to the Skyscraper configuration at `/home/USER/.skyscraper/config.ini` as described [here](CONFIGINI.md#usercredscredentials-or-key) Below follows a description of all scraping modules.