/RocketModFix

Fork of RocketMod for Unturned maintained by the plugin devs.

Primary LanguageC#MIT LicenseMIT

RocketModFix

RocketModFix

The RocketModFix is a fork of RocketMod for Unturned maintained by the Unturned plugin devs, this fork don't have plans for any major changes to the RocketMod, only fixes and new features that doesn't break any backward compatibility with API.

Compatibility

You can still use old RocketMod plugins without any changes/recompilation/updates, however if you want to use new features and bug fixes we recommend to install updated Module and new Rocket. API/Core/Unturned Redistributables (libraries).

Our plan and what we're done

  • Create Discord Server Community.
  • UnityEngine NuGet Package redist.
  • Unturned NuGet Package redist.
  • Update MSBuild to the Microsoft.NET.Sdk, because current MSBuild in RocketMod is outdated and its hard to support and understand what's going on inside.
  • RocketMod NuGet Package containing all required libraries for RockeMod API usage.
  • CI/CD and nightly builds with RocketMod .dlls.
  • Automatic Release on Tag creation (with RocketMod Module).
  • Rocket.Unturned.Module Artifacts on PR.
  • Rocket.Unturned NuGet Package.
  • Reset changelog.
  • For changelog use Keep a Changelog standard.
  • For versioning use SemVer.
  • Installation guides inside of the Rocket Unturned Module.
  • Keep backward compatibility.
    • Test with RocketMod plugins that uses old RocketMod libraries, and make sure current changes doesn't break anything.
    • Test with most used Modules:
      • AviRockets.
      • uScript.
      • OpenMod.
  • RocketMod Fixes:
    • Fix UnturnedPlayer.SteamProfile (cause so many lags).
    • Fix UnturnedPlayerComponent is not being added automatically.
    • Assembly Resolve fixes (don't spam with not found library or make a option to disable it, load all libraries at rocketmod start instead of searching for them only on OnAssemblyResolve)
    • Commands fixes:
      • Fix /vanish.
      • Fix /god.
      • Fix /p (not readable at all).
    • Perfomance.
  • New Features:
    • Commands:
      • /position /pos (current position of the player).
      • /tpall (teleport everyone to self or Vector3 point)
  • Gather a Team with a direct access to the repo edit without admins help.
  • RocketModFix Video Installation Guide (could be uploaded on YouTube).

After plan is finished -> Add new plans, keep coding, and don't forget to accept PR or issues.

Installation

  1. Stop the server (if running).
  2. Install latest RocketModFix Module here.
  3. Open Dropdown button Assets (if its not open).
  4. Click on Rocket.Unturned.Module-v0.0.0.zip to download (v - version can be a bit different).
  5. Keep Readme.txt instruction file inside of the installed Rocket.Unturned.Module-v0.0.0.zip archive.

Discord

Feel free to join our Discord Server.

How to Contribute

We're thrilled to have you here! Feel free to create pull requests (PRs) and open issues - your contributions are valuable to us!

Branching Guidelines

  • Avoid Committing to master: Please refrain from committing directly to the master branch.
  • Create a Branch from dev: Instead, create a new branch from the dev branch.
  • Submit PRs to dev: Submit your changes by creating a PR into the dev branch. This keeps our master branch stable, ensuring a smooth experience for all users.

Why We Use Issues

Before you dive into making changes, consider creating an issue or discussions on our discord server first. Here's why:

  • Avoid Duplicate Work: Someone might already be working on a similar update. Checking issues prevents duplication of effort.
  • Collaborative Problem Solving: Other contributors might have valuable insights or alternative solutions. Discussing changes beforehand can lead to better implementations.
  • Save Your Time: Avoid working on updates that might not align with the project's direction. Consult with others to ensure your efforts are fruitful.

NuGet Packages

Redist

RocketModFix.Unturned.Redist

RocketModFix.UnityEngine.Redist

RocketModFix

RocketModFix.Rocket.API

RocketModFix.Rocket.Core

RocketModFix.Rocket.Unturned

Resources

fr34kyn01535 has listed all of the original plugins in a post to the /r/RocketMod subreddit: List of plugins from the old repository

Following closure of the original forum the recommended sites for developer discussion are the /r/UnturnedLDM subreddit, SDG Forum, or the Steam Discussions.

The RocketMod organization on GitHub hosts several related archived projects: RocketMod (Abandoned)

History

On the 20th of December 2019 Sven Mawby "fr34kyn01535" and Enes Sadık Özbek "Trojaner" officially ceased maintenance of Rocket. They kindly released the source code under the MIT license. Read their full farewell statement here.

Following their resignation SDG forked the repository to continue maintenance in sync with the game.

On the 2nd of June 2020 fr34kyn01535 requested the fork be rebranded to help distance himself from the project.

Credits

OpenMod for nuget packages ready-to-go actions and workflows.