(changelog update)
[fanfix.git] / README.md
CommitLineData
08fe2e33
NR
1# Fanfix
2
36142555 3Fanfix is a small Java program that can download stories from some supported websites and render them offline.
08fe2e33 4
9f8f013a 5(If you are interested in the recent changes, please check the [Changelog](changelog.md) -- note that starting from version 1.4.0, the changelog is checked at startup (unless the option is disabled))
d649ced9 6
71d72f34 7![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
b4dc6ab5 8
373da363 9It 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
11To help organize your stories, it can also work as a local library.
12
13In 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
21Currently, 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
3968a05a 26- https://sofurry.com/: same thing, but story-oriented
88c61aca
NR
27
28## A note about file support
29
30We support a few file types for local story conversion (both as input and as output):
31- epub: .epub files created by this program (we do not support "all" .epub files, at least for now)
32- text: local stories encoded in plain text format, with a few specific rules:
33 - the title must be on the first line
adc71d36
NR
34 - 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)```)
35 - chapters must be declared with ```Chapter x``` or ```Chapter x: NAME OF THE CHAPTER```, where ```x``` is the chapter number
88c61aca
NR
36 - a description of the story must be given as chapter number 0
37 - a cover image may be present with the same filename as the story, but a .png, .jpeg or .jpg extension
38- 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)
39- cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously)
373da363 40- 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
41
42## Supported platforms
43
301791d3 44Any platform with at lest Java 1.6 on it should be ok.
08fe2e33 45
d98a2900 46It 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
47
48If 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
49
50## Usage
51
b4dc6ab5 52You can start the program in GUI mode (as in the screenshot on top):
88c61aca
NR
53- ```java -jar fanfix.jar```
54
88c61aca 55
b4dc6ab5 56The following arguments are also allowed:
88c61aca
NR
57- ```--import [URL]```: import the story at URL into the local library
58- ```--export [id] [output_type] [target]```: export the story denoted by ID to the target file
59- ```--convert [URL] [output_type] [target] (+info)```: convert the story at URL into target, and force-add the .info and cover if +info is passed
60- ```--read [id] ([chapter number])```: read the given story denoted by ID from the library
61- ```--read-url [URL] ([chapter number])```: convert on the fly and read the story denoted by ID, without saving it
62- ```--list```: list the stories present in the library and their associated IDs
373da363 63- ```--set-reader [reader type]```: set the reader type to CLI or LOCAL for this command (must be the first option)
88c61aca 64- ```--help```: display the available options
08fe2e33
NR
65
66### Environment variables
67
88c61aca
NR
68Some environment variables are recognized by the program:
69- ```LANG=en```: force the language to English (the only one for now...)
70- ```CONFIG_DIR=$HOME/.fanfix```: use the given directory as a config directory (and copy the default configuration if needed)
71- ```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 72- ```DEBUG=1```: force the ```DEBUG=true``` option of the configuration file (to show more information on errors)
08fe2e33
NR
73
74## Compilation
75
88c61aca 76```./configure.sh && make```
08fe2e33 77
36142555 78You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there.
08fe2e33 79
9f8f013a
NR
80There are some unit tests you can run, too:
81
82```./configure.sh && make build test run-test```
83
08fe2e33
NR
84### Dependant libraries (included)
85
301791d3
NR
86- libs/nikiroo-utils-sources.jar: some shared utility functions I also use elsewhere
87- [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 88
301791d3 89Nothing else but Java 1.6+.
08fe2e33 90
88c61aca 91Note that calling ```make libs``` will export the libraries into the src/ directory.
08fe2e33
NR
92
93## TODO
94
88c61aca 95Currently missing, but either in progress or planned:
b2612f9d
NR
96- [ ] Support new websites
97 - [x] YiffStar
98 - [ ] [Two Kinds](http://twokinds.keenspot.com/)
99 - [ ] [Slightly damned](http://www.sdamned.com/)
333f0e7b
NR
100- [ ] A GUI (work in progress)
101 - [x] Make one
102 - [x] Make it run when no args passed
b4dc6ab5 103 - [x] Fix the UI, it is ugly
10d558d2 104 - [x] Work on the UI thread is BAD
edd46289 105 - [x] Allow export
10d558d2 106 - [x] Allow delete/refresh
b2612f9d 107 - [x] Show a list of types
333f0e7b 108 - [x] ..in the menu
b2612f9d 109 - [x] ..as a screen view
adc71d36 110 - [ ] options screen
333f0e7b
NR
111- [ ] A TUI reader
112- [ ] Check if it can work on Android
b2612f9d
NR
113 - [x] First checks: it should work, but with changes
114 - [ ] Adapt work on images :(
115 - [ ] Partial/Conditional compilation
116 - [ ] APK export
333f0e7b
NR
117- [ ] Translations
118 - [x] i18n system in place
119 - [x] Make use of it
10d558d2 120 - [ ] Use it for all user output
333f0e7b 121 - [ ] French translation
b2612f9d 122- [x] Allow lauching a custom application instead of Desktop.start
10d558d2 123- [x] Install a mechanism to handle stories import/export progress update
d0b78732 124 - [x] Progress system
fbba6078 125 - [x] in support classes (import)
10d558d2 126 - [x] in output classes (export)
fbba6078 127 - [x] CLI usage of such
10d558d2 128 - [x] GUI usage of such
b2612f9d
NR
129- [ ] Version
130 - [x] Use a version number
131 - [x] Show it in UI
132 - [ ] A check-update feature
333f0e7b 133