Commit | Line | Data |
---|---|---|
08fe2e33 NR |
1 | # Fanfix |
2 | ||
36142555 | 3 | Fanfix is a small Java program that can download stories from some supported websites and render them offline. |
08fe2e33 | 4 | |
d649ced9 NR |
5 | (If you are interested in the recent changes, please check the [Changelog](changelog.md).) |
6 | ||
b4dc6ab5 NR |
7 | ![Main GUI](screenshots/fanfix.png?raw=true "Main GUI") |
8 | ||
373da363 | 9 | 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, LaTeX, HTML...). |
88c61aca NR |
10 | |
11 | To help organize your stories, it can also work as a local library. | |
12 | ||
13 | In this mode, you can: | |
373da363 NR |
14 | - Import a story from its URL (or just from a file) |
15 | - Export a story to a file (in any of the supported output types) | |
333f0e7b NR |
16 | - Display a story from the local library in text format in the console |
17 | - Display a story from the local library graphically **by calling a native program to handle it** (though Fanfix can automatically process it into HTML so any browser can open it) | |
88c61aca NR |
18 | |
19 | ## Supported websites | |
20 | ||
21 | Currently, the following websites are supported: | |
22 | - http://FimFiction.net/: fan fictions devoted to the My Little Pony show | |
23 | - http://Fanfiction.net/: fan fictions of many, many different universes, from TV shows to novels to games | |
24 | - 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 | |
25 | - https://e621.net/: a Furry website supporting comics, including MLP | |
26 | ||
27 | ## A note about file support | |
28 | ||
29 | We support a few file types for local story conversion (both as input and as output): | |
30 | - epub: .epub files created by this program (we do not support "all" .epub files, at least for now) | |
31 | - text: local stories encoded in plain text format, with a few specific rules: | |
32 | - the title must be on the first line | |
adc71d36 NR |
33 | - 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)```) |
34 | - chapters must be declared with ```Chapter x``` or ```Chapter x: NAME OF THE CHAPTER```, where ```x``` is the chapter number | |
88c61aca NR |
35 | - a description of the story must be given as chapter number 0 |
36 | - a cover image may be present with the same filename as the story, but a .png, .jpeg or .jpg extension | |
37 | - 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) | |
38 | - cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously) | |
373da363 | 39 | - html: HTML files that you can open with any browser; note that it will create a directory structure with ```index.html``` being the file you need to open (or select if you want to convert it into something else) -- we only support importing HTML files created by Fanfix or compatible |
08fe2e33 NR |
40 | |
41 | ## Supported platforms | |
42 | ||
301791d3 | 43 | Any platform with at lest Java 1.6 on it should be ok. |
08fe2e33 | 44 | |
d98a2900 | 45 | It has been tested on Linux, MacOS X and Windows for now, but feel free to inform me if you try it on another system. |
b4dc6ab5 NR |
46 | |
47 | If you have any problems to compile it with a supported Java version (1.5 won't work, but you may try to cross-compile; 1.6 and 1.8 have been tested and work), please contact me. | |
08fe2e33 NR |
48 | |
49 | ## Usage | |
50 | ||
b4dc6ab5 | 51 | You can start the program in GUI mode (as in the screenshot on top): |
88c61aca NR |
52 | - ```java -jar fanfix.jar``` |
53 | ||
88c61aca | 54 | |
b4dc6ab5 | 55 | The following arguments are also allowed: |
88c61aca NR |
56 | - ```--import [URL]```: import the story at URL into the local library |
57 | - ```--export [id] [output_type] [target]```: export the story denoted by ID to the target file | |
58 | - ```--convert [URL] [output_type] [target] (+info)```: convert the story at URL into target, and force-add the .info and cover if +info is passed | |
59 | - ```--read [id] ([chapter number])```: read the given story denoted by ID from the library | |
60 | - ```--read-url [URL] ([chapter number])```: convert on the fly and read the story denoted by ID, without saving it | |
61 | - ```--list```: list the stories present in the library and their associated IDs | |
373da363 | 62 | - ```--set-reader [reader type]```: set the reader type to CLI or LOCAL for this command (must be the first option) |
88c61aca | 63 | - ```--help```: display the available options |
08fe2e33 NR |
64 | |
65 | ### Environment variables | |
66 | ||
88c61aca NR |
67 | Some environment variables are recognized by the program: |
68 | - ```LANG=en```: force the language to English (the only one for now...) | |
69 | - ```CONFIG_DIR=$HOME/.fanfix```: use the given directory as a config directory (and copy the default configuration if needed) | |
70 | - ```NOUTF=1```: try to fallback to non-unicode values when possible (can have an impact on the resulting files, not only on user messages) | |
adc71d36 | 71 | - ```DEBUG=1```: force the ```DEBUG=true``` option of the configuration file (to show more information on errors) |
08fe2e33 NR |
72 | |
73 | ## Compilation | |
74 | ||
88c61aca | 75 | ```./configure.sh && make``` |
08fe2e33 | 76 | |
36142555 | 77 | You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there. |
08fe2e33 NR |
78 | |
79 | ### Dependant libraries (included) | |
80 | ||
301791d3 NR |
81 | - libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere |
82 | - [libs/unbescape-sources.jar](https://github.com/unbescape/unbescape): a nice library to escape/unescape a lot of text formats; I only use it for HTML | |
08fe2e33 | 83 | |
301791d3 | 84 | Nothing else but Java 1.6+. |
08fe2e33 | 85 | |
88c61aca | 86 | Note that calling ```make libs``` will export the libraries into the src/ directory. |
08fe2e33 NR |
87 | |
88 | ## TODO | |
89 | ||
88c61aca | 90 | Currently missing, but either in progress or planned: |
333f0e7b NR |
91 | - [ ] A GUI (work in progress) |
92 | - [x] Make one | |
93 | - [x] Make it run when no args passed | |
b4dc6ab5 | 94 | - [x] Fix the UI, it is ugly |
10d558d2 | 95 | - [x] Work on the UI thread is BAD |
edd46289 | 96 | - [x] Allow export |
10d558d2 | 97 | - [x] Allow delete/refresh |
333f0e7b NR |
98 | - [ ] Show a list of types |
99 | - [x] ..in the menu | |
100 | - [ ] ..as a screen view | |
adc71d36 | 101 | - [ ] options screen |
333f0e7b NR |
102 | - [ ] A TUI reader |
103 | - [ ] Check if it can work on Android | |
104 | - [ ] Translations | |
105 | - [x] i18n system in place | |
106 | - [x] Make use of it | |
10d558d2 NR |
107 | - [x] Use it for most user ouput |
108 | - [ ] Use it for all user output | |
333f0e7b | 109 | - [ ] French translation |
edd46289 | 110 | - [x] Allow lauching a custom application instead of Desktop.start ? |
333f0e7b | 111 | - [ ] Make a wrapper for firefox to create a new, empty profile ? |
10d558d2 | 112 | - [x] Install a mechanism to handle stories import/export progress update |
d0b78732 | 113 | - [x] Progress system |
fbba6078 | 114 | - [x] in support classes (import) |
10d558d2 | 115 | - [x] in output classes (export) |
fbba6078 | 116 | - [x] CLI usage of such |
10d558d2 | 117 | - [x] GUI usage of such |
333f0e7b | 118 |