| 1 | # Fanfix |
| 2 | |
| 3 | Fanfix is a small Java program able to download stories from some supported websites and render them offline. |
| 4 | |
| 5 | It will convert from a (supported) URL to an .epub file for stories or a .cbz file for comics (a few other output types are also available, like Plain Text or LaTeX). |
| 6 | |
| 7 | To help organize your stories, it can also work as a local library. |
| 8 | |
| 9 | In this mode, you can: |
| 10 | - Import a story from its URL (or even another file) |
| 11 | - Export a story to a file (.epub or .cbz) |
| 12 | - Display a story from the local library |
| 13 | |
| 14 | ## Supported websites |
| 15 | |
| 16 | Currently, the following websites are supported: |
| 17 | - http://FimFiction.net/: fan fictions devoted to the My Little Pony show |
| 18 | - http://Fanfiction.net/: fan fictions of many, many different universes, from TV shows to novels to games |
| 19 | - http://mangafox.me/: a well filled repository of mangas, or, as their website states: most popular manga scanlations read online for free at mangafox, as well as a close-knit community to chat and make friends |
| 20 | - https://e621.net/: a Furry website supporting comics, including MLP |
| 21 | |
| 22 | ## A note about file support |
| 23 | |
| 24 | We support a few file types for local story conversion (both as input and as output): |
| 25 | - epub: .epub files created by this program (we do not support "all" .epub files, at least for now) |
| 26 | - text: local stories encoded in plain text format, with a few specific rules: |
| 27 | - the title must be on the first line |
| 28 | - the author (preceded by nothing, "by " or "©") must be on the second line, possibly with the publication date in parenthesis (i.e., "By Unknown (3rd October 1998)") |
| 29 | - chapters must be declared with "Chapter x" or "Chapter x: NAME OF THE CHAPTER", where "x" is the chapter number |
| 30 | - a description of the story must be given as chapter number 0 |
| 31 | - a cover image may be present with the same filename as the story, but a .png, .jpeg or .jpg extension |
| 32 | - info_text: contains the same information as the text format, but with a companion .info file to store some metadata (the .info file is supposed to be created by Fanfix or compatible with it) |
| 33 | - cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously) |
| 34 | |
| 35 | ## Supported platforms |
| 36 | |
| 37 | Any platform with at lest Java 1.5 on it should be ok. |
| 38 | |
| 39 | If you have any problems to compile it with a supported Java version (1.4 won't work, but you may try to cross-compile; 1.8 had been tested and works), please contact me. |
| 40 | |
| 41 | ## Usage |
| 42 | |
| 43 | You can start the program in CLI mode: |
| 44 | - ```java -jar fanfix.jar``` |
| 45 | |
| 46 | __TODO__: offer a GUI mode (work in progress) |
| 47 | |
| 48 | The following arguments are allowed: |
| 49 | - ```--import [URL]```: import the story at URL into the local library |
| 50 | - ```--export [id] [output_type] [target]```: export the story denoted by ID to the target file |
| 51 | - ```--convert [URL] [output_type] [target] (+info)```: convert the story at URL into target, and force-add the .info and cover if +info is passed |
| 52 | - ```--read [id] ([chapter number])```: read the given story denoted by ID from the library |
| 53 | - ```--read-url [URL] ([chapter number])```: convert on the fly and read the story denoted by ID, without saving it |
| 54 | - ```--list```: list the stories present in the library and their associated IDs |
| 55 | - ```--set-reader [reader type]```: set the reader type to CLI or LOCAL for this command |
| 56 | - ```--help```: display the available options |
| 57 | |
| 58 | ### Environment variables |
| 59 | |
| 60 | Some environment variables are recognized by the program: |
| 61 | - ```LANG=en```: force the language to English (the only one for now...) |
| 62 | - ```CONFIG_DIR=$HOME/.fanfix```: use the given directory as a config directory (and copy the default configuration if needed) |
| 63 | - ```NOUTF=1```: try to fallback to non-unicode values when possible (can have an impact on the resulting files, not only on user messages) |
| 64 | - ```DEBUG=1```: force the DEBUG=true option of the configuration file (to show more information on errors) |
| 65 | |
| 66 | ## Compilation |
| 67 | |
| 68 | ```./configure.sh && make``` |
| 69 | |
| 70 | You can also import the java sources into, say, [https://eclipse.org/](Eclipse), and create a runnable JAR file from there. |
| 71 | |
| 72 | ### Dependant libraries (included) |
| 73 | |
| 74 | - libs/nikiroo-utils-sources-0.9.2.jar: some shared utility functions I also use elsewhere |
| 75 | - [https://github.com/unbescape/unbescape](libs/unbescape-1.1.4-sources.jar): a nice library to escape/unescape a lot of text formats; I only use it for HTML |
| 76 | |
| 77 | Nothing else but Java 1.5+. |
| 78 | |
| 79 | Note that calling ```make libs``` will export the libraries into the src/ directory. |
| 80 | |
| 81 | ## TODO |
| 82 | |
| 83 | Currently missing, but either in progress or planned: |
| 84 | - A GUI (work in progress) |
| 85 | - A binary JAR release (and thus, version 1) |
| 86 | - Some readers other than CLI (TUI, GUI) |
| 87 | - Check if it can work on Android |
| 88 | - French translation |