proof of concept

README.md

@@ -0,0 +1,55 @@
+
+# A Bethesda game mod manager for Linux
+
+This mod manager is made a protect the game files & mods files at all costs.
+if an operation or a mod tries to modify the files they will be stocked in and overlay folder (~/.local/share/modmanager/UPPER_DIRS/appid)
+
+this mod manager will try to enable casefold inside the mods folder as a way of ensuring that there will not be two file with the same name.
+
+mods conflicts are solved by priority, currently we still have to implements
+a way to change the priority.
+
+
+```
+Use --list-games or -l to list compatible games
+Use --add or -a <APPID> <FILENAME> to add a mod to a game
+Use --list-mods or -m <APPID> to list all mods for a game
+Use --install or -i <APPID> <MODID> to add a mod to a game
+Use --remove or -r <APPID> <MODID> to remove a mod from a game
+Use --deploy or -d <APPID> to deploy the mods for the game
+Use --unbind or -u <APPID> to rollback a deployment
+```
+
+## Requirements:
+* glib2
+
+### Optional requirements:
+* Fuse (2 or 3)
+* Fuse-overlayfs
+
+## instructions and warnings about casefold:
+Casefold is and options in some linux filesystems that will make a folder (not the whole filesystem) case insensitive, this is really good for proton since it gives a small lookup performance boost and allow us to install mods without fearing having two file with the same name.
+
+sadly i don't think overlayfs support it, but it might still be worth a try
+
+
+
+## TODO:
+
+1. we need a name for this.
+2. add more game to the code, currently i only have Skyrim se.
+3. replace the copy of the games files by hard links if available.
+4. fomod support
+
+## Compilation and install instructions:
+download a version from the releases(please avoir a simple clone of the git).
+
+then run this inside the folder:
+```bash
+mkdir build
+cd build
+cmake ..
+make
+```
+
+then copy the "ModManager" file to wherever you want. (i recommend ~/.local/bin/)