From 472926272576f2e3750461918f9c6be91c6b168e Mon Sep 17 00:00:00 2001
From: galister <22305755+galister@users.noreply.github.com>
Date: Fri, 1 Mar 2024 21:31:03 +0000
Subject: [PATCH] Created Building from Source (markdown)

---
 Building-from-Source.md | 50 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)
 create mode 100644 Building-from-Source.md

diff --git a/Building-from-Source.md b/Building-from-Source.md
new file mode 100644
index 0000000..61abd24
--- /dev/null
+++ b/Building-from-Source.md
@@ -0,0 +1,50 @@
+WlxOverlay-S can be built thicker or thinner, depending on your needs. The use of Rust features allows you to tailor the build to your system. By default, everything is included.
+
+Help extend this wiki by providing packages for additional distros!
+
+## Base dependencies
+These are required in all cases:
+- Arch: `base-devel cmake libxkbcommon fontconfig dbus alsa-lib`
+- Ubuntu: `build-essential pkg-config cmake libxkbcommon-dev fontconfig libfontconfig-dev libdbus-1-dev libasound2-dev`
+
+## Available features
+### Feature `openvr`
+Enable this if you plan on using SteamVR
+
+Dependencies:
+- Arch: `openvr`
+- Ubuntu: `libopenvr-dev libopenvr-api1`
+
+### Feature `openxr`
+Enable this if you plan on using Monado
+
+Dependencies:
+- Arch: `openxr`
+- Ubuntu: `libopenxr-dev`
+
+### Feature `wayland`
+Enable this if you're on a Wayland desktop
+
+Dependencies:
+- Arch: `libpipewire clang`
+- Ubuntu: `libpipewire-0.3-0 libpipewire-0.3-dev libspa-0.2-dev clang`
+
+### Feature `x11`
+Enable this if you're on X11
+
+Dependencies:
+- Arch: `libx11 libxext libxrandr`
+- Ubuntu: `libx11-6 libxext6 libxrandr2 libx11-dev libxext-dev libxrandr-dev`
+
+### Feature `osc`
+Enable this if you want XSO-compatible OSC parameters in VRChat
+
+The following parameters will be sent:
+```
+isOverlayOpen (bool)
+isKeyboardOpen (bool)
+isWristVisible (bool)
+openOverlayCount (int)
+```
+
+Dependencies: None
\ No newline at end of file