ImgScroll/README.md

90 lines
4.1 KiB
Markdown
Raw Normal View History

2017-12-01 22:23:07 +01:00
# RipMe [![Licensed under the MIT License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/RipMeApp/ripme/blob/master/LICENSE.txt) [![Join the chat at https://gitter.im/RipMeApp/Lobby](https://badges.gitter.im/RipMeApp/Lobby.svg)](https://gitter.im/RipMeApp/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Subreddit](https://img.shields.io/badge/discuss-on%20reddit-blue.svg)](https://www.reddit.com/r/ripme/)
[![Build Status](https://travis-ci.org/RipMeApp/ripme.svg?branch=master)](https://travis-ci.org/RipMeApp/ripme)
2017-11-19 05:31:50 +01:00
[![Coverage Status](https://coveralls.io/repos/github/RipMeApp/ripme/badge.svg?branch=master)](https://coveralls.io/github/RipMeApp/ripme?branch=master)
2014-03-02 10:30:10 +01:00
# Contribute
RipMe is maintained with ♥️ and in our limited free time by **[@MetaPrime](https://github.com/metaprime)** and **[@cyian-1756](https://github.com/cyian-1756)**. If you'd like to contribute but aren't good with code, help keep us happy with a small contribution!
2017-11-19 21:54:35 +01:00
[![Tip with PayPal](https://img.shields.io/badge/PayPal-Buy_us...-lightgrey.svg)](https://www.paypal.me/ripmeapp)
[![Tip with PayPal](https://img.shields.io/badge/coffee-%245-green.svg)](https://www.paypal.com/paypalme/ripmeapp/send?amount=5.00&currencyCode=USD&locale.x=en_US&country.x=US)
[![Tip with PayPal](https://img.shields.io/badge/beer-%2410-yellow.svg)](https://www.paypal.com/paypalme/ripmeapp/send?amount=10.00&currencyCode=USD&locale.x=en_US&country.x=US)
[![Tip with PayPal](https://img.shields.io/badge/lunch-%2420-orange.svg)](https://www.paypal.com/paypalme/ripmeapp/send?amount=20.00&currencyCode=USD&locale.x=en_US&country.x=US)
2017-11-19 21:55:35 +01:00
[![Tip with PayPal](https://img.shields.io/badge/dinner-%2450-red.svg)](https://www.paypal.com/paypalme/ripmeapp/send?amount=50.00&currencyCode=USD&locale.x=en_US&country.x=US)
2017-11-19 21:54:35 +01:00
[![Tip with PayPal](https://img.shields.io/badge/custom_amount-...-lightgrey.svg)](https://www.paypal.me/ripmeapp)
# About
RipMe is an album ripper for various websites. Runs on your computer. Requires Java 8.
2014-03-02 10:30:10 +01:00
2014-06-25 10:39:47 +02:00
![Screenshot](http://i.imgur.com/kWzhsIu.png)
## [Downloads](https://github.com/ripmeapp/ripme/releases)
Download `ripme.jar` from the [latest release](https://github.com/ripmeapp/ripme/releases).
**Note: If you're currently using version 1.2.x or 1.3.x, you will not automatically get updates to the newest versions. We recommend downloading the latest version from the link above.**
For information about running the `.jar` file, see [the How To Run wiki](https://github.com/ripmeapp/ripme/wiki/How-To-Run-RipMe).
## [Changelog](https://github.com/ripmeapp/ripme/blob/master/ripme.json) (ripme.json)
2014-04-07 08:08:55 +02:00
# Features
2014-03-02 10:30:10 +01:00
2014-04-05 18:01:45 +02:00
* Quickly downloads all images in an online album (see supported sites below)
* Easily re-rip albums to fetch new content
2018-03-08 12:15:27 +01:00
* Built in updater
* Can rip images from tumblr in the size they were uploaded in [See here for how to enable](https://github.com/RipMeApp/ripme/wiki/Config-options#tumblrget_raw_image)
* Skips already downloaded images by default
2014-03-02 10:30:10 +01:00
## [List of Supported Sites](https://github.com/ripmeapp/ripme/wiki/Supported-Sites)
2014-03-13 03:43:19 +01:00
* imgur
* twitter
* tumblr
* instagram
2014-04-27 13:54:04 +02:00
* flickr
* photobucket
* reddit
* gonewild
2014-03-13 03:43:19 +01:00
* motherless
* imagefap
* imagearn
* seenive
* vinebox
* 8muses
2014-04-05 18:01:45 +02:00
* deviantart
* xhamster
2014-04-27 13:54:04 +02:00
* (more)
2014-03-14 16:18:21 +01:00
## Not Supported?
2014-06-27 09:19:03 +02:00
Request support for more sites by adding a comment to [this Github issue](https://github.com/RipMeApp/ripme/issues/38).
2014-04-05 18:01:45 +02:00
If you're a developer, you can add your own Ripper by following the wiki guide
[How To Create A Ripper for HTML Websites](https://github.com/ripmeapp/ripme/wiki/How-To-Create-A-Ripper-for-HTML-websites).
2014-04-05 18:01:45 +02:00
# Compiling & Building
The project uses [Maven](http://maven.apache.org/).
To build the .jar file using Maven, navigate to the root project directory and run:
2014-03-14 16:18:21 +01:00
```bash
mvn clean compile assembly:single
```
2014-04-05 18:01:45 +02:00
This will include all dependencies in the JAR.
2014-05-26 08:48:13 +02:00
# Running Tests
2016-12-20 10:26:05 +01:00
After building you can run tests by running the following:
```bash
mvn test
```
Please note that some tests may fail as sites change and our rippers become out of date.
Start by building and testing a released version of RipMe
and then ensure that any changes you make do not cause more tests to break.