
MANDELBULBER 2.10
-----------------

project leader: Krzysztof Marczak
project members: Sebastian Jennen, Graeme McLaren, Bernardo Martelli, Robert Pancoast
                 knighty, makemeunsee, Marius Schilder, Ryan Hitchman, Jeff Epler, Martin Reinecke, Quazgaa

contact: buddhi1980@gmail.com
www: http://www.mandelbulber.com
download site: http://sourceforge.net/projects/mandelbulber/
GIT: https://github.com/buddhi1980/mandelbulber2
Community: http://www.fractalforums.com/mandelbulber

LICENCE: GNU GPL v3.0

1. REQUIREMENTS
---------------

- Linux OS with installed Qt 5 libraries (version >5.3) and libjpeg
- very fast CPU (recommended 3GHz, 4 cores)
- 2GB RAM

2. COMPILING
------------

packages needed to run: libqt5gui5, libpng16-16, libgsl2, libgomp1 libqt5multimedia5 libqt5multimedia5-plugins
packages needed to compile: build-essential, qt5-default, libpng-dev, qttools5-dev, qttools5-dev-tools, libgsl-dev, libgomp1 qtmultimedia5-dev libqt5multimedia5-plugins libsndfile1-dev


On Ubuntu, Debian stable (jessie) or Mint: 
sudo apt-get install build-essential libqt5gui5 qt5-default libpng12-0 libpng-dev qttools5-dev qttools5-dev-tools libgomp1 libgsl-dev libsndfile1-dev libqt5multimedia5-plugins

On Debian testing (stretch)
sudo apt-get install build-essential libqt5gui5 qt5-default libpng16-16 libpng-dev qttools5-dev qttools5-dev-tools libgomp1 libgsl-dev qtmultimedia5-dev libsndfile1-dev libqt5multimedia5-plugins


Then:

cd makefiles
qmake mandelbulber.pro
make all
cd ..

for gamepad support qt is required in version 5.7 and above

2.1. Alternative compilation with cmake

note: compilation with cmake is only beta and not feature complete

in order to compile OpenEXR with cmake the ECM should be present
to install on debian/ubuntu:
sudo apt-get install extra-cmake-modules

3. INSTALLATION
---------------

please type:
./install

(installation script will do compilation also)

4. TESTED ON:
------------

- Debian Stretch x64
- Ubuntu 16.10
- Chakra 2016.02 "Ian"
- Raspbian
- Centos 7 Intel MIC K1OM Development (more info: https://github.com/buddhi1980/mandelbulber2/issues/106)

- gcc 6.2.1
- clang 3.8.1
- msvc14

- Qt 5.7.1

5. USAGE
--------

Please visit: http://wiki.mandelbulber.com/index.php?title=Main_Page

Actually there is only available documentation for old Mandelbulber (v1)

A lot of useful information you can find in tooltips. Just hover mouse pointer over the edit fields.

6. COMMAND LINE INTERFACE
-------------------------

Usage: ./mandelbulber2 [options] settings_file

Options:
  -h, --help             Displays this help.
  -v, --version          Displays version information.
  -n, --nogui            Starts the program without a GUI.
  -o, --output <N>       Saves rendered image(s) to this file / folder.
  -K, --keyframe         Renders keyframe animation.
  -F, --flight           Renders flight animation.
  -X, --never-delete     Never delete data, instead Exit CLI application.
  -s, --start <N>        Starts rendering from frame number <N>.
  -e, --end <N>          Stops rendering on frame number <N>.
  -L, --list             Lists all possible parameters '<KEY>' with
                         corresponding default value '<VALUE>'.
  -f, --format <FORMAT>  Image output format:
                          jpg - JPEG format (default)
                          png - PNG format
                          png16 - 16-bit PNG format
                          png16alpha - 16-bit PNG with alpha channel format
                          exr - EXR format
                          tiff - TIFF format
  -r, --res <WxH>        Overrides image resolution. Specify as width and
                         height separated by 'x'
  --fpk <N>              Overrides frames per key parameter.
  -S, --server           Sets application as a server listening for clients.
  -H, --host <N.N.N.N>   Sets application as a client connected to server of
                         given host address (Host can be of type IPv4, IPv6 and
                         Domain name address).
  -p, --port <N>         Sets network port number for netrender (default 5555).
  -C, --no-cli-color     Starts program without ANSI colors, when execution on
                         CLI.
  -q, --queue            Renders all images from common queue.
  -t, --test             Runs testcases on the mandelbulber instance
  -b, --benchmark        Runs benchmarks on the mandelbulber instance
  -T, --touch            Resaves a settings file (can be used to update a
                         settings file)
  -V, --voxel            Renders the voxel volume in a stack of images.
  -O, --override <...>   <KEY=VALUE> overrides item '<KEY>' from settings file
                         with new value '<VALUE>'.
                         Specify multiple KEY=VALUE pairs by separating with a
                         '#': <KEY1=VALUE1#KEY2=VALUE2>. Quote whole expression
                         to avoid whitespace parsing issues
                         Override fractal parameter in the form
                         'fractal<N>_KEY=VALUE' with <N> being index of fractal
  --stats                Shows statistics while rendering in CLI mode.
  --help-input           Shows help about input.
  --help-examples        Shows example commands.

Arguments:
  settings_file          file with fractal settings (program also tries
                         to find file in ./mandelbulber/settings directory)
                         When settings_file is put as a command line argument
                         then program will start in noGUI mode<settings_file>
                         can also be specified as a list, see all options with
                         --help-input
