Skip to content

Commit

Permalink
removed absolute urls in markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
Gemba committed Sep 15, 2023
1 parent eb5113e commit c6fea5e
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/ARTWORK.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Read on for an example `artwork.xml` and a more thorough description of the `<ou

NOTE 1!!! Some users seem to have a habbit of editing the `/home/USER/skysource/artwork.xml` file. THIS IS NOT THE CORRECT FILE! Please read the first paragraph. :)

NOTE 2! Every time you change the artwork configuration, remember to regenerate the game list. Your changes won't take effect until you do so. Read more about this [here](https://github.com/Gemba/skyscraper/blob/master/docs/USECASE.md#the-game-list-generation-phase).
NOTE 2! Every time you change the artwork configuration, remember to regenerate the game list. Your changes won't take effect until you do so. Read more about this [here](USECASE.md#the-game-list-generation-phase).

Watch a video demonstrating the artwork compositing features [here](https://youtu.be/TIDD8EFSz50). Note that the video is quite old and only demonstrates a fraction of the possibilities you have with the Skyscraper compositor. It's all thoroughly documented below.

Expand Down
12 changes: 6 additions & 6 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
### The official Skyscraper F.A.Q (frequently asked questions)
A quick note before I let you loose on the questions:
* You can get a list of all available command-line options by running `Skyscraper --help`
* For a more thorough description of the command-line options go [here](https://github.com/Gemba/skyscraper/blob/master/docs/CLIHELP.md)
* You can read all about the available `config.ini` options [here](https://github.com/Gemba/skyscraper/blob/master/docs/CONFIGINI.md)
* For a more thorough description of the command-line options go [here](CLIHELP.md)
* You can read all about the available `config.ini` options [here](CONFIGINI.md)

And now for the questions (and answers)...

Expand All @@ -12,14 +12,14 @@ And now for the questions (and answers)...

**A:** You probably forgot to generate the gamelist. Skyscraper has two modes; resource gathering mode and gamelist generation mode. First you gather data into Skyscraper's resource cache by scraping the platform with any of the supported scraping modules (eg. `Skyscraper -p snes -s thegamesdb`). When you feel like you have gathered all the resources that you need, you then generate the gamelist by simply leaving out the `-s MODULE` option (eg. `Skyscraper -p snes`).

Read more about the resource cache [here](https://github.com/Gemba/skyscraper/blob/master/docs/CACHE.md).
Read more about the resource cache [here](CACHE.md).
</details>

#### Q: Skyscraper keeps quitting on me with errors about request limits or similar. What's going on?
<details>
<summary>Expand answer...</summary>

**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]
Expand All @@ -31,7 +31,7 @@ userCreds="USER:PASS"
<details>
<summary>Expand answer...</summary>

**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.
</details>

#### 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?
Expand Down Expand Up @@ -63,7 +63,7 @@ WARNING!!! Some people tend to run Skyscraper with `sudo Skyscraper ...`. Do *no
<details>
<summary>Expand answer...</summary>

**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)
</details>

#### 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?
Expand Down
2 changes: 1 addition & 1 deletion docs/SCRAPINGMODULES.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <MODULE>` option when running Skyscraper on the command line. It also requires a platform to be set with `-p <PLATFORM>`. 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 <USER:PASSWD>` or `-u <KEY>` 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 <USER:PASSWD>` or `-u <KEY>` 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.

Expand Down

0 comments on commit c6fea5e

Please sign in to comment.