Skip to content

Instalation

Mulex-fk server works under Linux and Windows. The backend API also works both under Windows and Linux. Pre-compiled releases are available under the releases tab of the github repository. However, if you wish to have more control/compile for a different ABI/platform there are also steps to build from source.

Install using KPM

As of November 2025, mulex-fk supports instalation via the kpm package manager.

To install via KPM simply: 

# Windows and Linux
kpm install lPrimemaster/mulex-fk

Install binaries manually

Simply download the latest release for your operating system and extract wherever you want. This is portable and works directly after extraction.

Install from source

Requirements

To install mulex-fk from source you will need:

  • cmake (>= 3.21)
  • gcc/g++/msvc
  • python3 (>= 3.10)
  • node.js (tested under v20.12.2)
  • yarn (any node package manager will do with a bit of changing on the CMakeLists.txt)
  • zlib
  • libuv
  • libusb (optional - if you wish builtin USB support on the backends)

Additional libraries are installed under the cmake configuration step and an internet connection is required for the first configuration.

Building

Under the repository main directory (you can look under the main CMakeLists.txt file for additional configure time options): 

mkdir build && cmake -DCMAKE_BUILD_TYPE=Release ..

⚠ If the configuration step fails at the yarn build go to frontend/ and run yarn without arguments to download dependencies.

After this just call your prefered build tool and install (e.g. using make): 

# Linux
make -j8 && make install

# Windows
cmake --build . --config Release --target install --parallel

⚠ Installing might require sudo/administrative rights

If everything was configured properly you should now be able to type: 

mxmain --help
This completes the installation of mulex-fk on the system.