
MANDELBULBER 2.07-1
-----------------

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

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

LICENCE: GNU GPL v3.0

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

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

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

packages needed to run: libqt5gui5, libpng12-0, libgsl2, libgomp1
packages needed to compile: build-essential, qt5-default, libpng12-dev, qttools5-dev, qttools5-dev-tools, libgsl-dev, libgomp1


On Ubuntu, Debian or Mint: 
apt-get install build-essential libqt5gui5 qt5-default libpng12-0 libpng12-dev qttools5-dev qttools5-dev-tools libgsl2 libgsl-dev libgomp1

Then:

cd makefiles
qmake mandelbulber.pro
make all
cd ..

for gamepad support (which is optional and actually works only under Linux) there are needed additional packages:
qt5base-private-dev, libsdl2-dev

additionally you need to compile qtgamepad module (needed at least Qt5 5)
git clone https://github.com/qtproject/qtgamepad
cd qtgamepad
qmake
make
make docs
sudo make install

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

please type:
./install

(installation script will do compilation also)

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

- Debian Stretch x64
- Ubuntu 14.10
- Linux Mint 17.2
- Chakra 2016.02 "Ian"

- gcc 5.3.1
- clang 3.7.0
- Qt 5.5.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.

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

Usage: ./mandelbulber2 [options] settings_file  

Options:                                                                                                                                                                                                     
  -h, --help                  Displays this help.                                                                                                                                                            
  -v, --version               Displays version information.                                                                                                                                                  
  -n, --nogui                 Start program without GUI.                                                                                                                                                     
  -o, --output <N>            Save rendered image(s) to this file / folder.                                                                                                                                  
  -K, --keyframe              Render keyframe animation                                                                                                                                                             
  -F, --flight                Render flight animation                                                                                                                                                               
  -s, --start <N>             Start rendering from frame number <N>.                                                                                                                                                
  -e, --end <N>               Stop rendering on frame number <N>.                                                                                                                                                   
  -O, --override <KEY=VALUE>  Override 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> as index of                                                                                                                                              
                              fractal                                                                                                                                                                                  
  -L, --list                  List all possible parameters '<KEY>' with                                                                                                                                                
                              corresponding default value '<VALUE>'.                                                                                                                                                   
  -f, --format <FORMAT>       Image output format:                                                                                                                                                                     
                              jpg - JPEG format                                                                                                                                                                        
                              png - PNG format                                                                                                                                                                         
                              png16 - 16-bit PNG format                                                                                                                                                                
                              png16alpha - 16-bit PNG with alpha channel format                                                                                                                                        
                              exr - EXR format                                                                                                                                                                         
  -r, --res <WIDTHxHEIGHT>    Override image resolution.                                                                                                                                                                
  --fpk <N>                   Override frames per key parameter.                                                                                                                                                        
  -S, --server                Set application as a server listening for                                                                                                                                                 
                              clients.                                                                                                                                                                                  
  -H, --host <N.N.N.N>        Set 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>              Set network port number for Netrender (default
                              5555).
  -C, --no-cli-color          Start program without ANSI colors, when execution
                              on CLI.
  -q, --queue                 Render all images from common queue.
  --stats                     Show statistics while renderering in CLI mode.
  --help-input                Show help about input.

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

