Skyscraper 项目安装与使用教程
1. 项目目录结构及介绍
Skyscraper 项目的目录结构如下:
skyscraper/
├── cache/
├── docs/
├── import/
├── resources/
├── src/
├── LICENSE
├── OLDERRELEASES.md
├── README.md
├── VERSION
├── aliasMap.csv
├── artwork.xml
├── artwork.xml.example1
├── artwork.xml.example2
├── artwork.xml.example3
├── artwork.xml.example4
├── config.ini.example
├── hints.txt
├── hints.xml
├── mameMap.csv
├── skyscraper.pro
├── tgdb_developers.json
├── tgdb_publishers.json
└── update_skyscraper.sh
目录介绍
- cache/: 缓存目录,用于存储从不同资源抓取的数据。
- docs/: 文档目录,包含项目的详细文档和常见问题解答。
- import/: 导入目录,用于导入自定义数据。
- resources/: 资源目录,包含项目所需的各种资源文件。
- src/: 源代码目录,包含项目的所有源代码文件。
- LICENSE: 项目的许可证文件。
- OLDERRELEASES.md: 旧版本发布说明。
- README.md: 项目的主README文件,包含项目的介绍和基本使用说明。
- VERSION: 项目的版本信息文件。
- aliasMap.csv: 别名映射文件,用于处理游戏名称的别名。
- artwork.xml: 艺术作品配置文件,定义了游戏封面、截图等媒体资源的配置。
- artwork.xml.example1-4: 艺术作品配置文件的示例。
- config.ini.example: 配置文件的示例,包含了项目的各种配置选项。
- hints.txt: 提示文件,包含了一些使用提示和建议。
- hints.xml: XML格式的提示文件。
- mameMap.csv: MAME平台的映射文件。
- skyscraper.pro: Qt项目的配置文件。
- tgdb_developers.json: TheGamesDB开发者信息文件。
- tgdb_publishers.json: TheGamesDB发行商信息文件。
- update_skyscraper.sh: 更新脚本,用于更新Skyscraper项目。
2. 项目启动文件介绍
Skyscraper 项目的启动文件是 skyscraper
,这是一个可执行文件,用于启动Skyscraper工具。启动文件位于项目的根目录下。
启动命令
$ ./skyscraper
启动选项
Skyscraper 提供了丰富的启动选项,可以通过以下命令查看所有可用选项:
$ ./skyscraper --help
3. 项目配置文件介绍
Skyscraper 的配置文件是 config.ini
,该文件位于用户主目录下的 .skyscraper/
目录中。如果该文件不存在,可以使用 config.ini.example
作为模板创建。
配置文件结构
[main]
platform=snes
scraper=screenscraper
userCreds=user:pass
cache=refresh
flags=videos
inputFolder=/home/user/RetroPie/roms/snes
gameListFolder=/home/user/RetroPie/roms/snes
mediaFolder=/home/user/RetroPie/roms/snes/media
配置项介绍
- platform: 指定要抓取的平台,例如
snes
。 - scraper: 指定要使用的抓取模块,例如
screenscraper
。 - userCreds: 指定抓取模块的用户凭证,格式为
user:pass
或key
。 - cache: 指定缓存选项,例如
refresh
表示刷新缓存。 - flags: 指定其他选项,例如
videos
表示抓取视频资源。 - inputFolder: 指定ROM文件的输入目录。
- gameListFolder: 指定游戏列表的输出目录。
- mediaFolder: 指定媒体资源的输出目录。
通过配置文件,用户可以方便地自定义Skyscraper的行为,而无需每次启动时手动输入命令行选项。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考