README.md
1
2<table>
3<tr>
4 <th>Coverity Scan</th>
5 <th>Build Status</th>
6 <th>Gitter Chat</th>
7</tr>
8<tr>
9 <td><a href="https://scan.coverity.com/projects/mandelbulber-v2">
10 <img alt="Coverity Scan" src="https://scan.coverity.com/projects/4723/badge.svg?flat=1"></a></td>
11 <td>
12 Linux: <a href="https://travis-ci.com/github/buddhi1980/mandelbulber2">
13 <img alt="Build Status Linux" src="https://travis-ci.com/buddhi1980/mandelbulber2.svg?branch=master"></a></br>
14 Windows: <a href="https://ci.appveyor.com/project/buddhi1980/mandelbulber2">
15 <img alt="Build Status Windows" src="https://ci.appveyor.com/api/projects/status/urd2h30tu7reg4mp?svg=true"></a></br>
16 OSX: <a href="https://circleci.com/gh/buddhi1980/mandelbulber2">
17 <img alt="Build Status OSX Circle CI" src="https://circleci.com/gh/buddhi1980/mandelbulber2.svg?style=shield">
18</a></br>
19Azure: <a href="https://dev.azure.com/buddhi19800328/Mandelbulber/_build?definitionId=1"><img alt="Build status Azure" src="https://dev.azure.com/buddhi19800328/Mandelbulber/_apis/build/status/buddhi1980.mandelbulber2?branchName=master"></a>
20
21</td>
22 </td>
23 <td><a href="https://gitter.im/buddhi1980/mandelbulber2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge">
24 <img alt="Join the chat" src="https://badges.gitter.im/Join%20Chat.svg"></a></td>
25</tr>
26</table>
27
28
29
30
31## Universal Idea
32
33Mandelbulber creatively generates three-dimensional fractals.
34
35Explore trigonometric, hyper-complex, Mandelbox, IFS, and many other 3D fractals.
36
37Render with a great palette of customizable materials to create stunning images and videos.
38
39The possibilities are literally **infinite**!
40
41
42
43## Features
44
45- High-Performance computing with multiple graphics accelerator cards (multi-GPU support via OpenCL)
46- Mathematical Models and Monte Carlo Algorithms for photo-realistic scenes
47- [Enlightening Documentation](https://github.com/buddhi1980/mandelbulber_doc/)
48- Renders trigonometric, hyper-complex, Mandelbox, IFS, and many other 3D fractals
49- Complex 3D raymarching: hard shadows, ambient occlusion, depth of field, translucency & refraction, etc.
50- Rich GUI in Qt 5 environment
51- Unlimited image resolution on 64-bit systems
52- Program developed for ARM (experimental), x86 and x64 CPUs (Linux, Windows, macOS)
53- Simple 3D navigator
54- Distributed Network Rendering
55- Key-frame animation for all parameters with different interpolations
56- Material management
57- Texture mapping (color, luminosity, diffusion, normal maps, displacement)
58- Exporting of 3D objects
59- Rendering queue
60- Command line interface for headless systems
61
62
63
64
65
66## Keyboard shortcuts
67
68In render window:
69
70 - <kbd>Shift</kbd>+<kbd>Up</kbd> or <kbd>Q</kbd> / <kbd>Shift</kbd>+<kbd>Down</kbd> or <kbd>Z</kbd>: Move Camera Forward / Backward
71 - <kbd>Shift</kbd>+<kbd>Left</kbd> or <kbd>A</kbd> / <kbd>Shift</kbd>+<kbd>Right</kbd> or <kbd>D</kbd>: Move Camera Left / Right
72 - <kbd>W</kbd> / <kbd>S</kbd>: Move Camera Up / Down
73 - <kbd>Up</kbd> / <kbd>Down</kbd> / <kbd>Left</kbd> / <kbd>Right</kbd>: Rotate Camera
74 - <kbd>Ctrl</kbd>+(<kbd>Left</kbd> / <kbd>Right</kbd>): Roll Camera Left / Right
75
76## Building and Deploying
77
78Download the latest stable version from [Releases](https://github.com/buddhi1980/mandelbulber2/releases) or clone git repository for actual development version.
79
80After downloading, unpack the file and follow our instructions from the [README](https://raw.githubusercontent.com/buddhi1980/mandelbulber2/master/mandelbulber2/deploy/README) file.
81Please see additional information in [mandelbulber2/deploy](mandelbulber2/deploy) folder.
82
83## Easy Preparation for Development
84
85The software is natively developed using Qt Creator for Linux (Debian or Ubuntu).
86
87The file [mandelbulber2/qmake/mandelbulber.pro](https://github.com/buddhi1980/mandelbulber2/blob/master/mandelbulber2/qmake/mandelbulber.pro) specifies the build system configuration for Qt Creator. To be able to compile the program, the host operating system requires preparation:
88
89Use the following scripts to prepare your Linux environment for development.
90These scripts install all dependencies, compile the program, and create symbolic links in /usr/share/mandelbulber to your working directory.
91
92[Prepare Debian for Development](https://github.com/buddhi1980/mandelbulber2/blob/master/mandelbulber2/tools/prepare_for_dev_debian_testing.sh)
93
94[Prepare Ubuntu for Development](https://github.com/buddhi1980/mandelbulber2/blob/master/mandelbulber2/tools/prepare_for_dev_ubuntu.sh)
95
96[Arch Linux AUR Package (Current release)](https://aur.archlinux.org/packages/mandelbulber2/)
97
98[Arch Linux AUR Package (Current git snapshot)](https://aur.archlinux.org/packages/mandelbulber2-git/)
99
100[Arch Linux AUR Package (Current git snapshot with opencl support)](https://aur.archlinux.org/packages/mandelbulber2-opencl-git/)
101
102In addition, there exists an MSVC Solution located in this git package. The solution accommodates all dependencies with NUGET for autonomous compilation of OpenCL accelerated binary.
103
104The system requires the QT5 framework in conjunction with LZO for real-time data compression and GSL for scientific resources.
105
106## Official partners
107
108[I-love-chaos](http://ilc.fractalforums.com)
109
110[](http://ilc.fractalforums.com)
111
112## Resources
113
114[Video tutorials](https://www.youtube.com/playlist?list=PLOwamUnstvZF0Y9sjxvwHNvrHHF1ZzFql)
115
116[Image Gallery](http://krzysztofmarczak.deviantart.com/gallery/)
117
118[Forum](https://fractalforums.org/mandelbulber/14)
119
120[Forum Gallery](http://www.fractalforums.com/index.php?action=gallery;cat=51)
121
122[Compiled Binaries](http://sourceforge.net/projects/mandelbulber/)
123
124[Coverity Scan](http://scan.coverity.com/projects/4723?tab=overview)
125
126
127
128## License
129
130GNU GPL v3
131
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}