KiriLaunch

Table of Contents

• Licensing
• Notice
• Compiling
  • Dependencies
  • Instructions
• Running
  • Linux
  • MacOS
  • Windows

Licensing

Licenses for each module this repository provides can be found in the licenses subdirectory. The licenses are as follows:

• libkirilaunch - GNU Lesser General Public License version 3

• KiriLaunch Qt - GNU General Public License version 3

Notice

The launcher does not currently give a proper way to see the progress of terminal commands (i.e git pull, git clone, make). It is recommended to use this with a terminal window shown. You can join our community discord server here along with our community revolt.chat server here.

Compiling

Dependencies

Arch Linux

You need the following dependencies for the library:

• libgit2

• fmt

You need the following dependencies for the Qt6 frontend:

• kcoreaddons

• ki18n

• kirigami2

• kconfig

Note	kconfig may be removed (in favour of a mINI (header-only, doesn’t require a specific toolkit))

Other Linux

Note	This section has been removed as it is out of date (and also cannot be updated for Ubuntu and Fedora until February 2024 ((release of KDE Plasma 6) or when someone makes a non-qt6 frontend (GTK, CLI, etc)), please wait until your distro ships these!

MacOS

Warning

What the hell do I put here? Does KF6 even support mac?

Windows

Note	THIS WILL CHANGE IN 0.4.0

Warning

You’re on your own, buddy.

Instructions

Run the following in your terminal emulator of choice (Recommended: zsh, bash, nushell):

git clone https://codeberg.org/tulpenkiste/KiriLaunch.git

meson setup build

meson compile -C build

If you want to configure the build, you can run meson configure build in the terminal to change the compilation options.

Nushell helper script

Note	The helper.nu script is not intended to be source’d. It is intended to be used like an executable (either via `./helper.nu or nu helper.nu).

Nushell users can optionally use the helper.nu script present in the project root directory which contains the following functions:

• main comptest (compiles and executes kirilaunchqt, useful for testing)

• main compile (compiles libkirilaunch and kirilaunchqt, runs main setup if build dir doesn’t exist)

• main setup (prepares the build directory for use)

Running

Linux

Mark the kirilaunch file as executable then run the file in the terminal (./kirilaunch) or through a desktop file. Ensure you have the necessary dependencies for compiling and running your desired SM64 repository before using this.

MacOS

Note	Figure out if this is possible. It should be possible but Apple OSes are a bit quirky.

Windows

Note	THIS WILL CHANGE IN 0.4.0

Using this software is not recommended or supported on Windows. Check out the SM64 PC Info website for a launcher more suited towards your operating system. If you do not care about the above notice in the slightest, you can figure it out yourself, I am not helping.