Skip to content

RocketModFix/RocketModFix

Repository files navigation

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 plugins without any changes/recompilation/updates.

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 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, current implementation cause so many lags (fixed, but still requires fixes).
    • Fix UnturnedPlayerComponent is not being added and removed automatically.
    • /admin /unadmin doesn't work when use offline player (now it possible to use steam id of the offline player).
    • 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)
    • Fix problem when TaskDispatcher is not calling an action (example: when some plugins queue a player which connected to the server the action might not be called = bypassed checks/bans etc).
    • Commands fixes:
      • Fix /vanish.
      • Fix /god. (oxygen isn't fixed)
      • Fix /p (not readable at all).
    • Perfomance.
  • New Features:
    • Commands:
      • /position /pos (current position of the player).
      • /tpwp (improved version of /tp wp).
      • /savelogs (a fast way for sending logs to plugin developer or whatever).
  • Remove Features:
    • Command /compass
  • Gather a Team with a direct access to the repo edit without admins help. (We still gather a team)
  • RocketModFix Video Installation Guide (could be uploaded on YouTube).

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

Installation

  1. Stop the Server: If your server is running, stop it.
  2. Remove Old Rocket: Delete the entire Rocket.Unturned folder located in Modules (if it exists).
  3. Download the Latest RocketModFix: Go to the RocketModFix releases page.
  4. Access the Assets: Open the "Assets" section if it's not already expanded.
  5. Download the Module: Click Rocket.Unturned.Module.zip to download the latest module.
  6. Final: Extract the downloaded archive, open the Rocket.Unturned.Module folder, and copy the Rocket.Unturned folder to Modules (copy the folder, not it's content, and if its asks to Replace the existing files then press to replace them).

Contact in our discord if you have any problems. Just in case you can also read Readme_EN.txt or Readme_RU.txt inside of the installed Module.

Discord

Feel free to join our Discord Server.

We're used by

If you also use RocketModFix, contact us, we will add a link to you!

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!

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.

Guidelines for Contributors

Follow these guidelines to make our work smoother and faster, otherwise your change might not be accepted:

  1. Check for Compatibility:

    • Does your change break backward compatibility?
    • If it does then your change might not accepted, keep it compatible with old versions.
  2. Ensure Broad Usability:

    • Will your changes work with other versions of Rocket or older versions, or if other Rocket for example LDM installed but your edited version of RocketModFix is not installed?
    • If not, your change may not be accepted as it could cause problems such as breaking changes.
  3. Test Your Changes:

    • Have you tested your change locally or in a test environment?
    • If not, test it to confirm it works as expected.
  4. Keep Things Simple:

    • Do you keep things simple?
    • If not, try to keep things simple, for example: "Don't try to make things/code unique, hard, complex, etc, use and do simple and working solutions for the issue, no need to show yourself as a hulk.".

Keep these points in mind to help everyone use RocketModFix without issues.

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.

Packages

 
 
 

Contributors

Languages

  • C# 98.9%
  • Other 1.1%