From 0c08e56eb9da507e8d27994505048482f5080268 Mon Sep 17 00:00:00 2001 From: Marc Date: Mon, 26 Sep 2022 09:05:11 +0200 Subject: [PATCH] updated readme with recent changes --- README.md | 20 +++++++++++++++----- note for future developments.txt | 7 ------- 2 files changed, 15 insertions(+), 12 deletions(-) delete mode 100644 note for future developments.txt diff --git a/README.md b/README.md index 2016279..68bfc29 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ Use --install or -i to add a mod to a game Use --remove or -r to remove a mod from a game Use --deploy or -d to deploy the mods for the game Use --unbind or -u to rollback a deployment +Use --fomod to create a new mod using the result from the FOMod ``` ## Requirements: @@ -28,18 +29,27 @@ Use --unbind or -u to rollback a deployment * 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. +Casefold is and options in some linux filesystem 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. currently i haven't tested without casefold and mods might break because of that. ## 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 +2. allow to change mod priority. +3. add more game to the code, currently i only have Skyrim se. +4. replace the copy of the games files by hard links if available. +5. try alternatives to overlayfs (searching for casefold support) +6. adding a hook for %command% in steam + +## How to contribute: +if you have creation engine based games not listed in src/steam.h +please open an issue with the EXACT name of the game folder in steamapps/common/ + +otherwise if you know how to code in c don't be scared to create mr or suggest changes. + +don't try to make me change the licence i chose GPL-2 on purpose and i won't use GPL-3. ## Compilation and install instructions: download a version from the releases(please avoir a simple clone of the git). diff --git a/note for future developments.txt b/note for future developments.txt deleted file mode 100644 index c1daa29..0000000 --- a/note for future developments.txt +++ /dev/null @@ -1,7 +0,0 @@ -1. -only support betheshda game for now, i spent enough time codding this. -2. -try alternatives to overlayfs (searching for casefold support) -3. -adding a hook for %command% in steam ? -should be easy to find the appid id this way and deploy.