Warning, /maui/vvave/README.md is written in an unsupported language. File is not indexed.

0001 # vvave
0002 
0003 <a href='https://flathub.org/apps/details/org.kde.vvave'><img width='190px' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
0004 
0005 ## Building
0006 
0007 ### Build for Android
0008 Use `qmake`:
0009 
0010 ```bash
0011 # Clone the code
0012 git clone https://invent.kde.org/kde/vvave.git
0013 cd vvave
0014 # Create build dir
0015 mkdir build && cd build
0016 # Build
0017 qmake -o Makefile ../vvave.pro
0018 make
0019 ```
0020 
0021 ### Build for Desktop
0022 Use `cmake`:
0023 ```bash
0024 # Clone the code
0025 git clone https://invent.kde.org/kde/vvave.git
0026 cd vvave
0027 # Create build dir
0028 mkdir build && cd build
0029 # Build
0030 cmake ..
0031 make
0032 sudo make install
0033 ```
0034 
0035 ### Dependencies
0036 
0037 If you've built vvave on some distro, please contribute here!
0038 
0039 #### Ubuntu
0040 
0041 ```
0042 sudo apt install kirigami2-dev libkf5syntaxhighlighting-dev extra-cmake-modules libtag1-dev libkf5notifications-dev libqt5websockets5-dev libqt5webview5-dev qtdeclarative5-dev qtmultimedia5-dev qtwebengine5-dev qtbase5-dev
0043 ```
0044 
0045 For other distros, the `buildInputs` part of the next section is a good clue for what
0046 you need.
0047 
0048 ### Using a nix shell
0049 
0050 If you use `nix` you don't have to get your environment dirty, here are all the
0051 dependencies and environment variables you need to load:
0052 
0053 ```nix
0054 with import <nixpkgs> {};
0055 
0056 let qtx = qt5; in
0057 stdenv.mkDerivation {
0058   name = "vvave";
0059 
0060   buildInputs = [
0061     appstream
0062     taglib
0063     gettext
0064   ] ++ (with libsForQt5; [
0065     ki18n
0066     kconfig
0067     knotifications
0068     kservice
0069     kio
0070     kirigami2
0071   ]) ++ (with qtx; [
0072     qtbase
0073     qtwebsockets
0074     qtquickcontrols
0075     qtquickcontrols2
0076     qtmultimedia
0077     qtwebengine
0078     qtgraphicaleffects
0079     qtdeclarative
0080   ]) ++ (with gst_all_1; [
0081     gst-plugins-base
0082     gst-plugins-good
0083     gst-plugins-bad
0084     gst-plugins-ugly
0085     gst-libav
0086   ]);
0087 
0088   shellHook = with qtx; ''
0089     export QT_QPA_PLATFORM_PLUGIN_PATH="${qtbase}/${qtbase.qtPluginPrefix}/platforms"
0090     export QT_PLUGIN_PATH="$QT_PLUGIN_PATH:${qtbase.bin}/${qtbase.qtPluginPrefix}"
0091     export QML2_IMPORT_PATH="$QML2_IMPORT_PATH:${qtquickcontrols2.bin}/${qtbase.qtQmlPrefix}"
0092     export QML2_IMPORT_PATH="$QML2_IMPORT_PATH:${qtquickcontrols}/${qtbase.qtQmlPrefix}"
0093     export QML2_IMPORT_PATH="$QML2_IMPORT_PATH:${qtgraphicaleffects}/${qtbase.qtQmlPrefix}"
0094     export QML2_IMPORT_PATH="$QML2_IMPORT_PATH:${qtdeclarative.bin}/${qtbase.qtQmlPrefix}"
0095     export QML2_IMPORT_PATH="$QML2_IMPORT_PATH:${libsForQt5.kirigami2}/${qtbase.qtQmlPrefix}"
0096   '';
0097 }
0098 ```
0099 
0100 ## Troubleshooting
0101 
0102 ### QML complains module X is not installed
0103 
0104 Check that all of the following Qt Components are installed:
0105 
0106 ```
0107 qtbase qtquickcontrols2 qtquickcontrols qtgraphicaleffects qtdeclarative kirigami2
0108 ```
0109 
0110 Next check that module `X` can be found in `$QML2_IMPORT_PATH`.
0111 
0112 ### VVAVE is built and running but no sound comes out!
0113 
0114 Check that you have all the correct gstreamer plugins installed:
0115 
0116 ```
0117 gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav
0118 ```