alex/mangle
1
Fork 0
Code Releases 1 Activity

Updating README

Browse Source
This commit is contained in:
Alex Yatskov 2015-05-23 12:39:57 +09:00
parent dcfd86fdb8
commit 46f07c6f16
2 changed files with 33 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,8 +1,8 @@
# Mangle # Mangle #
A couple of years ago I received an [Amazon Kindle](http://en.wikipedia.org/wiki/Kindle) gift. I immediately began Many years ago I received an [Amazon Kindle](http://en.wikipedia.org/wiki/Kindle) gift. I immediately began playing
playing around with it and reading about certain undocumented features that the Kindle has to offer. After a couple of around with it and reading about certain undocumented features that the Kindle has to offer. After a couple of hours I
hours I discovered it to be the perfect device for reading [Manga](http://en.wikipedia.org/wiki/Manga) is almost always discovered it to be the perfect device for reading [Manga](http://en.wikipedia.org/wiki/Manga) is almost always
grayscale, and the aspect ratio fits the Kindle's 600x800 pixel screen almost perfectly. Better yet, the Kindle's grayscale, and the aspect ratio fits the Kindle's 600x800 pixel screen almost perfectly. Better yet, the Kindle's
undocumented image viewer actually keeps track of the last image you viewed and thus you are always able to return to undocumented image viewer actually keeps track of the last image you viewed and thus you are always able to return to
the page you left off on when you power on your Kindle. The device supports several popular image formats (jpeg, png, the page you left off on when you power on your Kindle. The device supports several popular image formats (jpeg, png,
@ -13,10 +13,10 @@ However... The Kindle's image viewer does have certain shortcomings:
* The Kindle is very picky about file format; any additional embedded data (thumbnails, comments, possibly even exif * The Kindle is very picky about file format; any additional embedded data (thumbnails, comments, possibly even exif
data) can confuse it. As a result, images may not display properly or even not at all (which actually prevents you data) can confuse it. As a result, images may not display properly or even not at all (which actually prevents you
from reading the given book, as one bad panel will prevent you from viewing subsequent images). from reading the given book, as one bad panel will prevent you from viewing subsequent images).
* The first image that you view in a manga (until the Kindle first writes the "bookmark" file) seems to be arbitrary * The first image that you view in a Manga (until the Kindle first writes the "bookmark" file) seems to be arbitrary
even when files are named sequentially. About half the time it will correctly pick the first file in the batch, at even when files are named sequentially. About half the time it will correctly pick the first file in the batch, at
other times it will pick out some other image seemingly at random. other times it will pick out some other image seemingly at random.
* Normally for Kindle to find your manga scans you have to press Alt+Z on the home screen. I haven't always had luck * Normally for Kindle to find your Manga scans you have to press Alt+Z on the home screen. I haven't always had luck
with it correctly identifying image directories. At other times, after finding an image directory the Kindle will with it correctly identifying image directories. At other times, after finding an image directory the Kindle will
appear to hang while trying to access it (forcing you to return to the home screen). appear to hang while trying to access it (forcing you to return to the home screen).
* The Kindle image viewer has no functionality to rotate images. So if there is a horizontally large image (such as * The Kindle image viewer has no functionality to rotate images. So if there is a horizontally large image (such as
@ -28,7 +28,7 @@ However... The Kindle's image viewer does have certain shortcomings:
a grayscale equivalent (which is would be fine for the Kindle's limited display). a grayscale equivalent (which is would be fine for the Kindle's limited display).
* Kindle's image viewer provides no way to sort images (to determine in which order they are shown). This can be very * Kindle's image viewer provides no way to sort images (to determine in which order they are shown). This can be very
problematic especially considering that scanlation groups have differing naming conventions, and as a result files problematic especially considering that scanlation groups have differing naming conventions, and as a result files
from later chapters may appear before earlier ones when you are reading your manga (spoilers ftl). from later chapters may appear before earlier ones when you are reading your Manga (spoilers ftl).
I was annoyed with these issues and thus Mangle was born (the program name is a mix of "Manga" and "Kindle" in case you I was annoyed with these issues and thus Mangle was born (the program name is a mix of "Manga" and "Kindle" in case you
haven't figured it out yet; I thought it was pretty clever at the time). Fortunately you can get all the benefits of my haven't figured it out yet; I thought it was pretty clever at the time). Fortunately you can get all the benefits of my
@ -38,40 +38,40 @@ work without really doing anything (and it won't even cost you anything since Ma
* Sort and organize images from different directories; bulk rename feature for output to the Kindle. * Sort and organize images from different directories; bulk rename feature for output to the Kindle.
* Optionally re-save images in a format Kindle will be sure to understand with no visible quality loss. * Optionally re-save images in a format Kindle will be sure to understand with no visible quality loss.
* Downsample and rotate images for optimal viewing on Kindle, convert to grayscale to save space and improve contrast. * Downsample and rotate images for optimal viewing on Kindle, convert to grayscale to save space and improve contrast.
* Automatically generate book meta-data so that your manga is always properly detected and viewable in-order. * Automatically generate book meta-data so that your Manga is always properly detected and viewable in-order.
Here is a recent screenshot showing off some of the export options that you can configure on a per-book basis in Mangle: Here is a recent screenshot showing off some of the export options that you can configure on a per-book basis in Mangle:
![Mangle options dialog](index/options.png) ![Mangle options dialog](img/options.png)
You can also check out what Mangle output looks like on the Kindle on the [action You can also check out what Mangle output looks like on the Kindle on the [action
shots](http://foosoft.net/projects/mangle/action.html) page. shots](http://foosoft.net/projects/mangle/action/) page.
Mangle is cross platform, and doesn't require an install (it's a standalone executable that you can run from anywhere). Mangle is cross platform, and doesn't require an install (it's a standalone executable that you can run from anywhere).
It is also "environmentally friendly" by not messing with your registry or modifying your system in any way. If you It is also "environmentally friendly" by not messing with your registry or modifying your system in any way. If you
ever want to uninstall it, just delete the executable and you're done. ever want to uninstall it, just delete the executable and you're done.
## Usage Instructions ## Usage Instructions ##
Mangle is pretty easy to use, so this won't be really in-depth. If you have any questions drop me a line though. Mangle is pretty easy to use, so this won't be really in-depth. If you have any questions drop me a line though.
1. Add images to the current book by selecting the "Book | Add | Files" or "Book | Add | Directory" menu items. 1. Add images to the current book by selecting the `Book | Add | Files` or `Book | Add | Directory` menu items.
2. If certain images are not in the order you want, select them in the window, and select the "Book | Shift | Up" or 2. If certain images are not in the order you want, select them in the window, and select the `Book | Shift | Up` or
"Book | Shift | Down" menu items. `Book | Shift | Down` menu items.
3. Configure the book title and image processing options by selecting "Book | Options"; this will be the title you see 3. Configure the book title and image processing options by selecting `Book | Options`; this will be the title you see
in the Kindle home menu. in the Kindle home menu.
4. Create a root-level directory on your SD memory card/Kindle called "pictures" (case might matter). 4. Create a root-level directory on your SD memory card/Kindle called `pictures` (case might matter).
5. Once you are satisfied with the your images and options select "Book | Export" and select the "pictures" directory 5. Once you are satisfied with the your images and options select `Book | Export` and select the `pictures` directory
you just created. you just created.
6. After the export is complete your new manga books will show up along with all your other books (if they don't for 6. After the export is complete your new Manga books will show up along with all your other books (if they don't for
some reason, press Alt+Z while on the home menu). some reason, press `Alt+Z` while on the home menu).
## The Usual Disclaimer ## The Usual Disclaimer ##
You probably know how this goes by now... Mess around with your Kindle at your own risk. Honestly, nothing bad is going You probably know how this goes by now... Mess around with your Kindle at your own risk. Honestly, nothing bad is going
to happen; however if something *does* then it's your problem. to happen; however if something *does* then it's your problem.
## Running From Source ## Running From Source ##
Because Mangle is written in Python, a scripting language, it's trivial to get it up and running on the operating system Because Mangle is written in Python, a scripting language, it's trivial to get it up and running on the operating system
of your choice. First you should make sure that you have the required dependencies installed: of your choice. First you should make sure that you have the required dependencies installed:
@ -86,11 +86,11 @@ of your choice. First you should make sure that you have the required dependenci
Now you can fetch the [latest version of the code](https://github.com/FooSoft/mangle/) and run the `mangle.pyw` script Now you can fetch the [latest version of the code](https://github.com/FooSoft/mangle/) and run the `mangle.pyw` script
to execute Mangle. to execute Mangle.
## Downloads ## Downloads ##
The Windows binary for the latest version of Mangle can be [downloaded If you don't want to run Mangle from source, you can use the following pre-built binaries. As I don't have the means to
here](http://foosoft.net/projects/mangle/index/mangle_win.zip). Although I don't have the means to make MacOS X releases make MacOS X releases myself, I am providing the slightly out of date (and unsupported) package built by Rob White in
myself, I do have the slightly older [MacOS X Package](http://foosoft.net/projects/mangle/index/mangle_osx.zip) built by its place. Linux users should execute the Python scripts with the interpreter and libraries installed on their system.
Rob White. *Note that I have never used MacOS X and I have no idea what it takes to get Mangle up and running on it so I
cannot answer any questions about that platform*.
* [Windows](http://foosoft.net/projects/mangle/dl/mangle-win.zip)
* [MacOS X](http://foosoft.net/projects/mangle/dl/mangle-osx.zip)

0
index/options.png → img/options.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 20 KiB