Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

CaveWhere

Build Status

CaveWhere Logo

Cave Mapping software

CaveWhere is a cave mapping software with an intuitive design that enables building and visualizing underground cave maps. Using it’s advanced 3D engine, CaveWhere automatically morphs your 2D cave notes in 3D. Loop closures re-morph effected scan scraps automatically so your map is always up-to-date.

Download Binaries

CaveWhere Downloads

Building from Source on Ubuntu 18.04

CaveWhere is built around Qt and QBS.

Get all dependencies

sudo add-apt-repository -y ppa:beineri/opt-qt-5.14.1-bionic
sudo apt-get -y update
sudo apt-get -y install git build-essential qt514-meta-minimal qt514svg qt514quickcontrols qt514quickcontrols2 qt514graphicaleffects qt514script qt514imageformats libgl1-mesa-glx libgl1-mesa-dev

Make sure libGL.so exists.

If you're on a x86_64 linux box. Make sure /usr/lib/x86_64-linux-gnu/libGL.so exists. If doesn't you simply need to create a symbolic link to it.

ls -l /usr/lib/x86_64-linux-gnu/libGL.so
sudo ln -s /usr/lib/x86_64-linux-gnu/libGL.so.1 /usr/lib/x86_64-linux-gnu/libGL.so

Building QBS

Ubuntu 18.04 comes with QBS 1.10. This version doesn't build CaveWhere. CaveWhere is typically built with QBS 1.14 or later. Ubuntu 19.04, does come with QBS 1.13, which will probably work. For Ubuntu 18.04, building it from source is the way to go.

git clone https://github.com/qbs/qbs.git
cd qbs
git checkout v1.15.0
/opt/qt514/bin/qmake -r qbs.pro && make -j `nproc`
sudo make install
cd ..
qbs --version

Building CaveWhere

Once Qt and QBS have been installed, you can build CaveWhere with the following:

qbs setup-toolchains --detect
qbs setup-qt /opt/qt514/bin/qmake qt5
qbs config profiles.qt5.baseProfile x86_64-linux-gnu-gcc-7
qbs config defaultProfile qt5
qbs resolve profile:qt5 config:release
qbs build --products CaveWhere profile:qt5 config:release

Running CaveWhere

qbs run --products CaveWhere profile:qt5 config:release

Running Unit Testcases

qbs run --products cavewhere-test profile:qt5 config:release

Building CaveWhere and running in debug

git clone --branch=master https://github.com/Cavewhere/cavewhere.git cavewhere
cd cavewhere
git submodule update --init --recursive
qbs resolve profile:qt5 config:debug
qbs build --products profile:qt5 config:debug
qbs run --products CaveWhere profile:qt5 config:debug

By default in linux and macos, in debug mode, CaveWhere uses -faddress-santizer for detecting memory bugs and memory leaks. You might get the following message when running CaveWhere in debug:

==48458==ASan runtime does not come first in initial library list; you should either link runtime to your application or manually preload it with LD_PRELOAD.

To resolve this issue on Ubuntu 18.04, run the following:

export LD_PRELOAD=/usr/lib/gcc/x86_64-linux-gnu/7/libasan.so
qbs run --products CaveWhere profile:qt5 config:debug