Spriters Resource Downloader

A downloader for the website Spriters Resource
Report a bug or request a feature

Table of Contents

• Introduction
• Getting Started
  • Prerequisites and dependencies
  • Installation
• Usage
  • Command line options
• Contributing
• License

Introduction

This repository contains a command line application to simply download all sprites and spritesheets of a given game from the website Spriters Resource (https://www.spriters-resource.com).

Getting Started

For users, you can just download the latest release of the application and jump here.

Next information is mainly dedicated to developers who wants to run the application in a more pythonish way.

Prerequisites and dependencies

This repository is tested on Python 3.7+.

You should install Spriters Resource Downloader in a virtual environment. If you're unfamiliar with Python virtual environments, check out the user guide. First, create a virtual environment with the version of Python you're going to use and activate it.

You can install directly all required packages by using the file requirements.txt and doing:

pip install -r requirements.txt

Installation

Follow the instructions above then clone the repo (git clone https:://github.com/torresflo/Spriters-Resource-Downloader.git).
You can now launch the app by running spriters-resource-downloader.py.

Usage

Just launch the application with:

For users:

spriters-resource-downloader.exe [-h] [-v] url

For developers:

python spriters-resource-downloader.py [-h] [-v] url

Command line options

Here are the possible arguments:

positional arguments:
  url            URL to a game on the website spriters-resource.com

optional arguments:
  -h, --help     show this help message and exit
  -v, --verbose  use it to print progress during download

It is recommended to activate the verbose mode (optional, not activated by default) to keep track of the progress.

Example

The next command line will download all the sprites referenced on this page and put them in the folder downloaded/game_boy_gbc/pokemongoldsilver/ while printing progress during download:

For users:

spriters-resource-downloader.exe -v https://www.spriters-resource.com/game_boy_gbc/pokemongoldsilver/

For developers:

python spriters-resource-downloader.py -v https://www.spriters-resource.com/game_boy_gbc/pokemongoldsilver/

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature)
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.