README.md + runsven.sh

README.md

@@ -0,0 +1,43 @@
+# SvenBXT
+
+SvenBXT is a complete remake of [BunnymodXT](https://github.com/YaLTeR/BunnymodXT), designed specifically for Sven Co-op 5.25.
+You can legally use this tool for [Sven Co-op runs](https://www.speedrun.com/sven_coop).
+
+## Installation / Usage
+
+### Windows
+SvenBXT can be installed as a [MetaHook](https://github.com/hzqst/MetaHookSv)/[SvenMod](https://github.com/sw1ft747/svenmod) plugin.
+Also can be injected by any injector (even deprecated one from `rebased` branch).
+
+#### MetaHook
+1. Move `SvenBXT.dll` to `svencoop/metahook/plugins`
+2. Write `SvenBXT.dll` in `svencoop/metahook/configs/plugins.lst`
+
+#### SvenMod
+1. Move `SvenBXT.dll` to `svenmod/plugins`
+2. Open `svenmod/plugins.txt` and write `"SvenBXT"			"1"` inside plugins tab
+
+```
+// SvenMod
+// List of plugins to load
+
+"Plugins"
+{
+	"SvenBXT"			"1"
+	
+	"Settings"
+	{
+		"LoadDelay"				"0.5" // in seconds
+	}
+}
+```
+
+You can find additional info about that [here](https://github.com/sw1ft747/svenmod#adding-plugins).
+
+### Linux
+You can use the `runsven.sh` script. Correct the paths at the top of the script if necessary.
+
+## Credits
+**Thanks to [YaLTeR](https://github.com/YaLTeR) for [BunnymodXT](https://github.com/YaLTeR/BunnymodXT)!**
+
+Thanks to [autisoid](https://github.com/autisoid) for SvenMod/MetaHook emulators.

runsven.sh

@@ -0,0 +1,29 @@
+#!/bin/sh
+SCRIPT_DIR="$(dirname "$(readlink -f "$0")")"
+
+# If your Steam library is somewhere else, correct this path.
+export SVEN_ROOT="."
+
+# SvenBXT path (you can correct this path too)
+export SVENBXT="$SVEN_ROOT/libSvenBXT.so"
+
+# Check that the Sven Co-op folder exists.
+if [ ! -d "$SVEN_ROOT" ]; then
+    echo "Sven Co-op folder does not exist at $SVEN_ROOT"
+    exit 1
+fi
+
+# Check that SvenBXT exists.
+if [ ! -f "$SVENBXT" ]; then
+    echo "SvenBXT does not exist at $SVENBXT"
+    exit 1
+fi
+
+export LD_PRELOAD="$LD_PRELOAD:$SVENBXT"
+
+# Run Sven Co-op.
+export LD_LIBRARY_PATH="$SVEN_ROOT:$LD_LIBRARY_PATH"
+export SteamEnv=1
+
+cd "$SVEN_ROOT" || exit 1
+exec ./svencoop_linux -steam "$@"