aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fd849fa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# Fluorine Manager
+
+Fluorine Manager an attempt at porting MO2 to linux with FUSE as the VFS system.
+
+## Current Status
+
+- Core app builds and runs on Linux.
+- NaK integration is wired for game/proton detection and dependency handling.
+- Linux-native game plugins (`libgame_*.so`) are supported.
+- Portable instances are supported via local `ModOrganizer.ini` detection.
+
+## FUSE Permissions
+
+- Users only need to change `/etc/fuse.conf` when MO2 mounts with `allow_other` (or `allow_root`).
+- If `allow_other` is used, uncomment `user_allow_other` in `/etc/fuse.conf` once (system-wide).
+
+## Example
+
+`#user_allow_other` to `user_allow_other` if its missing please add it.
+
+## Installing and Running
+Download the latest flatpak from the [releases](https://github.com/SulfurNitride/Fluorine-Manager/releases) and after you download it.
+
+You are able to install it with this command: `flatpak install --user fluorine-manager.flatpak`
+
+You can then get started with: `flatpak run com.fluorine.manager` or you should be able to find it in your apps drawer.
+
+More information can be found in the [FAQ](https://github.com/SulfurNitride/Fluorine-Manager/blob/main/docs/FAQ.md).
+
+## Build
+
+```bash
+cmake -B build
+cmake --build build -j"$(nproc)"
+```
+
+## Known Limitations
+
+- Some third-party MO2 plugins are Windows-only and will fail on Linux (for example DLL/ctypes `windll` assumptions).
+- Themes are currently not working as intended.
+
+## Project Layout
+
+```text
+libs/ MO2 sub-libraries
+src/ Main organizer source
+docs/ Notes and tracking
+```