Skip to content

Commit

Permalink
updating repo links
Browse files Browse the repository at this point in the history
  • Loading branch information
detain committed Jul 30, 2022
1 parent 2d7f857 commit f0eccf9
Show file tree
Hide file tree
Showing 19 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ about: Create a bug report to help improve Skyscraper
**READ BEFORE YOU POST**
This is for BUG / ERROR reports only! Are you sure what you are experiencing is a BUG? Have you asked the community about it first? If not, then please consider doing so, either at the RetroPie forums (https://retropie.org.uk/forum) or the RetroPie subreddit (https://www.reddit.com/r/RetroPie) where other users might be able to help you out.

Also, please read the documentation (https://github.com/muldjord/skyscraper/tree/master/docs) thoroughtly. Every feature and option is documented down to the last detail.
Also, please read the documentation (https://github.com/detain/skyscraper/tree/master/docs) thoroughtly. Every feature and option is documented down to the last detail.

If you've encountered a bug, please TAKE YOUR TIME to describe it well using the following template. Lackluster reports will be deleted without response. I would expect it to be several lines of text long with a well-described example and proper documentation on how to re-produce the problem. Thanks! :)

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ about: Suggest an idea for future versions of Skyscraper
**READ BEFORE YOU POST**
This is for FEATURE REQUESTS only. If you have questions about the general use of Skyscraper, please ask them at the RetroPie forums (https://retropie.org.uk/forum) or the RetroPie subreddit (https://www.reddit.com/r/RetroPie) where other users might be able to help you out.

Also, please read the documentation (https://github.com/muldjord/skyscraper/tree/master/docs) thoroughtly. Every feature and option is documented down to the last detail.
Also, please read the documentation (https://github.com/detain/skyscraper/tree/master/docs) thoroughtly. Every feature and option is documented down to the last detail.

NOTE! I am not currently actively implementing new features into Skyscraper due to wanting to pursue other projects. Feel free to submit your feature request, but know that I won't be looking into it anytime soon.

Expand Down
2 changes: 1 addition & 1 deletion OLDERRELEASES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

#### Version 3.5.9 (24th October 2020)
* Implemented the new IGDB v4 authentication method. IGDB will now work again, and requires free credentials. Read more about that [here](https://github.com/muldjord/skyscraper/blob/master/docs/SCRAPINGMODULES.md#igdb)
* Implemented the new IGDB v4 authentication method. IGDB will now work again, and requires free credentials. Read more about that [here](https://github.com/detain/skyscraper/blob/master/docs/SCRAPINGMODULES.md#igdb)
* Improved memory consumption when handing entries back to main thread
* Added '.au3' file extension to id script exception list (Thank you to 'o0alucard0o' for reporting this)

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Skyscraper Enhanced by torresflo

This is a fork of the famous project [Skyscraper by Lars Muldjord](https://github.com/muldjord/skyscraper) (see the readme of the original project below).
This is a fork of the famous project [Skyscraper by Lars Muldjord](https://github.com/detain/skyscraper) (see the readme of the original project below).

## What's new?

Expand Down Expand Up @@ -31,7 +31,7 @@ Below is the original README.md. Everything is still usefull excepting the part
# Skyscraper by Lars Muldjord
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/muldjord/skyscraper/tree/master/docs) and there's also a [F.A.Q](https://github.com/muldjord/skyscraper/blob/master/docs/FAQ.md). If you still have questions after reading the documentation, please consider asking them on the [RetroPie subreddit](https://www.reddit.com/r/RetroPie/) or in the official [RetroPie forums](https://retropie.org.uk/forum). The `Issues` page here on Github is for bug reports and feature requests only. Thanks!
All Skyscraper features are [well-documented](https://github.com/detain/skyscraper/tree/master/docs) and there's also a [F.A.Q](https://github.com/detain/skyscraper/blob/master/docs/FAQ.md). If you still have questions after reading the documentation, please consider asking them on the [RetroPie subreddit](https://www.reddit.com/r/RetroPie/) or in the official [RetroPie forums](https://retropie.org.uk/forum). The `Issues` page here on Github is for bug reports and feature requests only. Thanks!

##### Code contributions
Pull Requests are not currently accepted. Due to wanting to pursue other projects after having worked on Skyscraper for 3 years, I am currently only fixing scraper-breaking bugs in Skyscraper. For any functionality beyond what is already in place, feel free to fork Skyscraper and fit it to your needs. I am no longer actively considering or commenting user feature requests or pull requests. When / if this changes, this text will be updated.
Expand Down Expand Up @@ -76,7 +76,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/muldjord/skyscraper/issues/301) for potential fixes.
NOTE 2! User 'trvrplk' reports numerous issues on MacOS 11.2+. Check [here](https://github.com/detain/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 @@ -159,7 +159,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/muldjord/skyscraper/tree/master/docs).
To read more about any of the features described above, please check out all of the documentation [here](https://github.com/detain/skyscraper/tree/master/docs).

### Artwork look and effects
Check the full artwork documentation [here](docs/ARTWORK.md)
Expand All @@ -171,7 +171,7 @@ Check the full artwork documentation [here](docs/ARTWORK.md)
* Consider making aliasMap the global baseName instead of just the search term base name. This will fix missing brackets in alias names being ignored later on
* Make all artwork types custom meaning that their type can be whatever the user wants. The sources will create ones with known types such as 'screenshot' and 'cover', but the user can import other types they define themselves, such as 'cabinet' or whatever else. Internally artwork is then handled by a list of artwork instead of 4 hardcoded types in GameEntry
* Introduce the ability to use <BASENAME> in the 'file="somefolder/<BASENAME>.png"' in artwork.xml which would then look for a file in 'resources' with the game basename.png allowing users to use their own custom artwork data as a workaround to adding new types to import (Thank you to 'jueank' for suggesting this)
* Add the option of scraping custom platforms by configuring them in the config with an alias to an already existing platform. Example: scrape 'pcenginecd' could be scraped as 'pcengine' in case you have those files in a 'roms/pcenginecd' folder instead of the pcengine folder. Check here: https://github.com/muldjord/skyscraper/issues/136
* Add the option of scraping custom platforms by configuring them in the config with an alias to an already existing platform. Example: scrape 'pcenginecd' could be scraped as 'pcengine' in case you have those files in a 'roms/pcenginecd' folder instead of the pcengine folder. Check here: https://github.com/detain/skyscraper/issues/136
* Create a testmode for the artwork compositor that let's you quickly render an example to see if you got everything set up right in the artwork xml
* Allow 'region' to be a list similar to 'regionPrios'. When using 'region' it should simply keep the default priority list and add those from 'region' to the top. 'regionPrios' should still overwrite it entirely. Naming change probably a good idea, for instance rename 'region' to 'regionsPrefer' or something. 'regionPrios' should probably also be changed to 'regionsOverride'. (Thank you to 'corezon' for suggesting this).
* Implement a less rigid filename match for the 'import' module to allow for close match filenames
Expand Down
2 changes: 1 addition & 1 deletion artwork.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This is the default artwork.xml provided by Skyscraper. More examples can be found in '~/.skyscraper'. Be sure to check the full artwork documentation here: https://github.com/muldjord/skyscraper/blob/master/docs/ARTWORK.md -->
<!-- This is the default artwork.xml provided by Skyscraper. More examples can be found in '~/.skyscraper'. Be sure to check the full artwork documentation here: https://github.com/detain/skyscraper/blob/master/docs/ARTWORK.md -->
<artwork>
<output type="screenshot" width="640" height="480">
<layer resource="screenshot" x="20" width="520" height="390" align="center" valign="middle">
Expand Down
2 changes: 1 addition & 1 deletion artwork.xml.example1
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This is the default artwork.xml provided by Skyscraper. More examples can be found in '~/.skyscraper'. Be sure to check the full artwork documentation here: https://github.com/muldjord/skyscraper/blob/master/docs/ARTWORK.md -->
<!-- This is the default artwork.xml provided by Skyscraper. More examples can be found in '~/.skyscraper'. Be sure to check the full artwork documentation here: https://github.com/detain/skyscraper/blob/master/docs/ARTWORK.md -->
<artwork>
<!-- Create a screenshot output for the frontend and set its width and height. If no layers are nested inside the output node, it will export the screenshot raw and just resize it according to width and height. If layers are nested inside, it will create an empty canvas of the defined size and composite the layers on top of it. -->
<output type="screenshot" width="640" height="480">
Expand Down
2 changes: 1 addition & 1 deletion config.ini.example
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
; --------------------------------------------------------------------
; Skyscraper by Lars Muldjord (https://github.com/muldjord/skyscraper)
; Skyscraper by Lars Muldjord (https://github.com/detain/skyscraper)
; --------------------------------------------------------------------

; This is an example config file for use with Skyscraper. Use it as a template for creating
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/muldjord/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](https://github.com/detain/skyscraper/blob/master/docs/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/muldjord/skyscraper/blob/master/docs/CLIHELP.md)
* You can read all about the available `config.ini` options [here](https://github.com/muldjord/skyscraper/blob/master/docs/CONFIGINI.md)
* For a more thorough description of the command-line options go [here](https://github.com/detain/skyscraper/blob/master/docs/CLIHELP.md)
* You can read all about the available `config.ini` options [here](https://github.com/detain/skyscraper/blob/master/docs/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/muldjord/skyscraper/blob/master/docs/CACHE.md).
Read more about the resource cache [here](https://github.com/detain/skyscraper/blob/master/docs/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/muldjord/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](https://github.com/detain/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.

```
[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/muldjord/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](https://github.com/detain/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.
</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/muldjord/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](https://github.com/detain/skyscraper/blob/master/docs/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/muldjord/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](https://github.com/detain/skyscraper/blob/master/docs/CONFIGINI.md#usercredscredentials-or-key)

Below follows a description of all scraping modules.

Expand Down
Loading

0 comments on commit f0eccf9

Please sign in to comment.