Auto-installer for RocketModFix. Downloads and installs the latest version from GitHub, or installs from local builds for development.
Just drop the module in your Modules folder and start your server. It will automatically download and install the latest RocketModFix.
Important: Before using the auto-installer, remove any manually installed Rocket.Unturned from your Modules directory to avoid conflicts.
Edit config.json to customize installation behavior:
{
"EnableCustomInstall": false,
"CustomInstallPath": "",
"BlockIfRocketInstalled": true,
"AutoInstallRocketFromExtras": false,
"EnableRetry": true,
"EnableCaching": true
}For regular users:
BlockIfRocketInstalled- Prevent installation if Rocket is already installedEnableRetry- Enable retry mechanism for failed downloads (5 attempts, 5s delay)EnableCaching- Enable file caching for faster startup and offline support
For developers:
EnableCustomInstall- Enable local installation instead of GitHubCustomInstallPath- Path to your local build (see examples below)AutoInstallRocketFromExtras- Auto-install from Extras folder
For developers who want to test their own builds without manually copying files every time. The CustomInstallPath can point to:
-
A zip file - Direct path to Rocket.Unturned.Module.zip
"CustomInstallPath": "C:\\Builds\\Rocket.Unturned.Module.zip" -
An unzipped folder - Directory containing the module files
"CustomInstallPath": "C:\\Builds\\RocketModFix\\Rocket.Unturned"The folder should contain either:
- Rocket.Unturned.dll directly, or
- Rocket.Unturned.Module.zip file, or
- Rocket.Unturned.dll in any subdirectory
-
Direct URI - Any HTTP/HTTPS URL pointing to a zip file
"CustomInstallPath": "https://example.com/downloads/Rocket.Unturned.Module.zip"Note: GitHub Actions artifacts are currently not supported cause require authentication and aren't suitable for public downloads. See GitHub issue #51 for details.
If you want to implement one of the plans or have better ideas, feel free to let us know!
- Auto-Install from GitHub Releases
- Auto-Install Local Build (no need to manually install RocketModFix every time you test/update it, 1 click to build, restart server, and you're testing!)
- Json config with options:
-
EnableCustomInstall: false/true (default is false) -
CustomInstallPath: path to a build of RocketModFix
-
-
AutoInstallRocketFromExtras: false/true (default is false) - Auto-install Rocket (LDM) from Extras - Fixed self-directory exclusion in Module code to prevent blocking the load process (see
BlockIfRocketInstalled)!
- Json config with options:
- Caching
- Check if GitHub release is newer than current cached version and ONLY then install new version, also use Retry (5 seconds, 5 attempts or so) in case of GitHub's down or problems with internet
- For safe usage without Internet Connection
- (Details) Block installation if Rocket already installed (
BlockIfRocketInstalledin config)