more jDoc
[fanfix.git] / README.md
CommitLineData
10ccd649 1English [Français](README-fr.md)
eab9e01c 2
08fe2e33 3# Fanfix
36142555 4Fanfix is a small Java program that can download stories from some supported websites and render them offline.
08fe2e33 5
2953f988
NR
6## Synopsis
7
8- ```fanfix``` --import [*URL*]
9- ```fanfix``` --export [*id*] [*output_type*] [*target*]
10- ```fanfix``` --convert [*URL*] [*output_type*] [*target*] (+info)
11- ```fanfix``` --read [*id*] ([*chapter number*])
12- ```fanfix``` --read-url [*URL*] ([*chapter number*])
8b153400
NR
13- ```fanfix``` --search
14- ```fanfix``` --search [*where*] [*keywords*] (page [*page*]) (item [*item*])
8141d7ac
NR
15- ```fanfix``` --search-tag
16- ```fanfix``` --search-tag [*index 1*]... (page [*page*]) (item [*item*])
2953f988 17- ```fanfix``` --list
63b9c207 18- ```fanfix``` --set-reader [*GUI* | *TUI* | *CLI*]
2953f988
NR
19- ```fanfix``` --server [*key*] [*port*]
20- ```fanfix``` --stop-server [*key*] [*port*]
21- ```fanfix``` --remote [*key*] [*host*] [*port*]
22- ```fanfix``` --help
23
42375f55
NR
24## Description
25
eab9e01c
NR
26(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.)
27
28(A [TODO list](TODO.md) is also available to know what is expected to come in the future.)
d649ced9 29
4a758059 30![Main GUI](screenshots/fanfix-1.3.2.png?raw=true "Main GUI")
b4dc6ab5 31
63b9c207
NR
32A screenshots cgallery an be found [here](screenshots/README.md).
33
373da363 34It 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 35
6ee59de8 36To help organize your stories, it can also work as a local library so you can:
42375f55 37
373da363
NR
38- Import a story from its URL (or just from a file)
39- Export a story to a file (in any of the supported output types)
333f0e7b 40- Display a story from the local library in text format in the console
3d709626 41- Display a story from the local library graphically **natively** or **by calling a native program to handle it** (potentially converted into HTML before hand, so any browser can open it)
88c61aca 42
2953f988 43### Supported websites
88c61aca
NR
44
45Currently, the following websites are supported:
42375f55 46
88c61aca
NR
47- http://FimFiction.net/: fan fictions devoted to the My Little Pony show
48- http://Fanfiction.net/: fan fictions of many, many different universes, from TV shows to novels to games
49- 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
50- https://e621.net/: a Furry website supporting comics, including MLP
3968a05a 51- https://sofurry.com/: same thing, but story-oriented
6ee59de8 52- https://e-hentai.org/: done upon request (so, feel free to ask for more websites!)
dad7b76c 53- http://mangas-lecture-en-ligne.fr/: a website offering a lot of mangas (in French)
88c61aca 54
2953f988 55### Support file types
88c61aca
NR
56
57We support a few file types for local story conversion (both as input and as output):
42375f55 58
88c61aca
NR
59- epub: .epub files created by this program (we do not support "all" .epub files, at least for now)
60- text: local stories encoded in plain text format, with a few specific rules:
42375f55
NR
61 - the title must be on the first line
62 - 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)```)
63 - chapters must be declared with ```Chapter x``` or ```Chapter x: NAME OF THE CHAPTER```, where ```x``` is the chapter number
64 - a description of the story must be given as chapter number 0
65 - a cover image may be present with the same filename as the story, but a .png, .jpeg or .jpg extension
88c61aca
NR
66- 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)
67- cbz: .cbz (collection of images) files, preferably created with Fanfix (but any .cbz file is supported, though without most of Fanfix metadata, obviously)
eab9e01c 68- html: HTML files that you can open with any browser; note that it will create a directory structure with ```index.html``` as the main file -- we only support importing HTML files created by Fanfix
08fe2e33 69
2953f988 70### Supported platforms
08fe2e33 71
301791d3 72Any platform with at lest Java 1.6 on it should be ok.
08fe2e33 73
eab9e01c 74It has been tested on Linux (Debian, Slackware, Ubuntu), MacOS X and Windows for now, but feel free to inform us if you try it on another system.
b4dc6ab5 75
eab9e01c 76If you have any problems to compile it with a supported Java version (1.6+), please contact us.
08fe2e33 77
2953f988 78## Options
08fe2e33 79
b4dc6ab5 80You can start the program in GUI mode (as in the screenshot on top):
42375f55 81
88c61aca 82- ```java -jar fanfix.jar```
2953f988 83- ```fanfix``` (if you used *make install*)
88c61aca 84
b4dc6ab5 85The following arguments are also allowed:
42375f55 86
88c61aca
NR
87- ```--import [URL]```: import the story at URL into the local library
88- ```--export [id] [output_type] [target]```: export the story denoted by ID to the target file
89- ```--convert [URL] [output_type] [target] (+info)```: convert the story at URL into target, and force-add the .info and cover if +info is passed
90- ```--read [id] ([chapter number])```: read the given story denoted by ID from the library
eab9e01c 91- ```--read-url [URL] ([chapter number])```: convert on the fly and read the story at URL, without saving it
8b153400
NR
92- ```--search```: list the supported websites (```where```)
93- ```--search [where] [keywords] (page [page]) (item [item])```: search on the supported website and display the given results page of stories it found, or the story details if asked
94- ```--tag [where]```: list all the tags supported by this website
95- ```--tag [index 1]... (page [page]) (item [item])```: search for the given stories or subtags, tag by tag, and display information about a specific page of results or about a specific item if requested
88c61aca 96- ```--list```: list the stories present in the library and their associated IDs
b0e88ebd 97- ```--set-reader [reader type]```: set the reader type to CLI, TUI or GUI for this command
eab9e01c 98- ```--server [key] [port]```: start a story server on this port
42375f55 99- ```--stop-server [key] [port]```: stop the remote server running on this port (key must be set to the same value)
eab9e01c 100- ```--remote [key] [host] [port]```: contact this server instead of the usual library (key must be set to the same value)
88c61aca 101- ```--help```: display the available options
eab9e01c 102- ```--version```: return the version of the program
08fe2e33 103
2953f988 104### Environment
08fe2e33 105
88c61aca 106Some environment variables are recognized by the program:
42375f55 107
eab9e01c 108- ```LANG=en```: force the language to English
88c61aca
NR
109- ```CONFIG_DIR=$HOME/.fanfix```: use the given directory as a config directory (and copy the default configuration if needed)
110- ```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 111- ```DEBUG=1```: force the ```DEBUG=true``` option of the configuration file (to show more information on errors)
08fe2e33
NR
112
113## Compilation
114
88c61aca 115```./configure.sh && make```
08fe2e33 116
36142555 117You can also import the java sources into, say, [Eclipse](https://eclipse.org/), and create a runnable JAR file from there.
08fe2e33 118
9f8f013a
NR
119There are some unit tests you can run, too:
120
121```./configure.sh && make build test run-test```
122
08fe2e33
NR
123### Dependant libraries (included)
124
2953f988
NR
125Required:
126
127- ```libs/nikiroo-utils-sources.jar```: some shared utility functions
128- [```libs/unbescape-sources.jar```](https://github.com/unbescape/unbescape): a nice library to escape/unescape a lot of text formats; used here for HTML
129- [```libs/jsoup-sources.jar```](https://jsoup.org/): a library to parse HTML
130
131Optional:
132
133- [```libs/jexer-sources.jar```](https://github.com/klamonte/jexer): a small library that offers TUI widgets
134- [```pandoc```](http://pandoc.org/): to generate the man pages from the README files
08fe2e33 135
301791d3 136Nothing else but Java 1.6+.
08fe2e33 137
88c61aca 138Note that calling ```make libs``` will export the libraries into the src/ directory.
08fe2e33 139
42375f55
NR
140## Author
141
142Fanfix was written by Niki Roo <niki@nikiroo.be>
143