Ultimate Saver

UltimateSaver

Each weapon keeps its own ultimate charge, including a partly filled charge bar. Switch weapons, move one to another slot or a chest, drop it, or give it to another player: the charge stays with the item.

Installation

Version 0.0.3 requires MixinTale 3.0.0 or later. Hyxin is no longer needed by UltimateSaver. Installing UltimateSaver alone is not enough: you must also install the MixinTale bootstrap.

Single player — Windows

1. Close Hytale completely. If upgrading from 0.0.2, follow the upgrade steps below before continuing.
2. Download MixinTale-Bootstrap-3.0.0.jar from MixinTale on CurseForge. Choose the Bootstrap download, not Developer Tools. Download UltimateSaver-0.0.3.jar from UltimateSaver on CurseForge. Keep both files as .jar files; do not unzip them.
3. Open File Explorer. Paste %AppData%\Hytale\UserData into its address bar and press Enter. %AppData% normally expands to C:\Users\<your Windows username>\AppData\Roaming. If your launcher uses a custom install folder, find that installation's UserData folder instead. For example, an installation in D:\Hytale may use D:\Hytale\UserData. Use that same UserData folder for all the following steps.
4. Inside UserData, open EarlyPlugins. Create the folder if it does not exist. Put MixinTale-Bootstrap-3.0.0.jar directly inside it. Default full destination: %AppData%\Hytale\UserData\EarlyPlugins\MixinTale-Bootstrap-3.0.0.jar.
5. Go back to UserData, then open Mods. Create the folder if it does not exist. Put UltimateSaver-0.0.3.jar directly inside it. Default full destination: %AppData%\Hytale\UserData\Mods\UltimateSaver-0.0.3.jar. You can also install UltimateSaver through the CurseForge app or the in-game mod browser, but the manual MixinTale step above is still required.
6. Check the two files are in different folders: MixinTale must NOT go into Mods; UltimateSaver must NOT go into EarlyPlugins. Do not put either JAR inside an extra subfolder.
7. Start Hytale. Before entering your world, open that world's settings and its Mods tab. Under Global Mods, enable UltimateSaver for that world, then apply/save the change. Copying the JAR is not enough. Repeat this for each world where you want the mod.
8. Enter the world and check the log as described below. Then charge a weapon a little, switch to another weapon, and switch back. The first weapon should keep its charge.

Dedicated server

1. Stop the server. Download the same two JAR files listed above.
2. In the server's root folder, create earlyplugins if it does not exist. Put MixinTale-Bootstrap-3.0.0.jar directly in <ServerRoot>/earlyplugins/.
3. In the same server root, create mods if it does not exist. Put UltimateSaver-0.0.3.jar directly in <ServerRoot>/mods/. MixinTale must NOT go into mods; UltimateSaver must NOT go into earlyplugins.
4. Add --accept-early-plugins to the server launch arguments, then start the server. Check the startup log for the lines below.

On Linux, folder names are case-sensitive. For a dedicated server, use lowercase earlyplugins and mods exactly; EarlyPlugins and Mods are different folders.

Check that it loaded

After entering the world, open %AppData%\Hytale\UserData\Logs. With a custom install, open UserData\Logs under that installation instead, for example D:\Hytale\UserData\Logs. Open the newest log from this launch in a text editor and search for these messages. If there are several logs for the launch, check the server log too. On a dedicated server, check its console/startup log.

• [MixinTale/INFO] MixinTale 3.0.0 ready — the line continues with patch counts. A newer MixinTale will show its own version.
• [UltimateSaver] Loaded! Each weapon stores its own ultimate charge.

Both messages should be present. The MixinTale message alone does not show that UltimateSaver loaded. [UltimateSaver] StatModifiersManager is not patched means the patch did not apply; check the MixinTale log messages and the checklist below.

Not working?

• Wrong folder? Check the launcher's actual UserData folder, especially if you have more than one installation. MixinTale belongs in EarlyPlugins; UltimateSaver belongs in Mods.
• MixinTale missing? You need the Bootstrap JAR, not just UltimateSaver or the Developer Tools ZIP. Restart Hytale completely after installing it.
• Old Hyxin-based UltimateSaver still installed? Remove the old UltimateSaver JAR from the global or world-specific earlyplugins folders as described below. Keep only one UltimateSaver version. Hyxin itself is only needed if another mod still requires it.
• Mod disabled for this world? Open the world's Mods tab and enable UltimateSaver under Global Mods.
• Linux server? Check the lowercase folder names earlyplugins and mods, and the --accept-early-plugins launch argument.

Upgrading from 0.0.2

1. Close the game or stop the server.
2. Remove the old UltimateSaver-0.0.2.jar from the early-plugin folders where you installed it. Check %AppData%\Hytale\UserData\EarlyPlugins and %AppData%\Hytale\UserData\Saves\<World>\earlyplugins for each affected world, or <ServerRoot>/earlyplugins on a dedicated server. Substitute your actual UserData path if the launcher uses a custom folder. Remove any other older UltimateSaver JAR copies too.
3. Remove the Hyxin JAR only if no other mod needs it. UltimateSaver 0.0.3 uses MixinTale instead.
4. Install the two new JARs in their separate folders using the steps above, then enable UltimateSaver for your world.

The charge on the weapon you were holding when you updated may be lost once during this upgrade.

Charge and commands

Charge is stored on the weapon item as SignatureEnergy metadata. Death, respawn, effects, and ordinary stat resets do not erase its saved charge. Using that weapon's own ultimate spends it; switching away during the ultimate also counts as spent.

Administrators can still change the held weapon's saved charge with /player stats set|add|reset SignatureEnergy and the corresponding /entity stats commands. Here set|add|reset means choose one action, not type the vertical bars. For example: /player stats set SignatureEnergy 10.

If another effect lowers charge while that same weapon's ultimate is running, that decrease can also be saved.

Compatibility

• Hytale 0.6.x; built against Server 0.6.8.
• Works with weapons that use the standard SignatureEnergy system, including weapons added by other mods.
• Other mods that change ultimate charge or weapon-switch handling may conflict.

Source and license

By Morgott. Source and issue tracker. License: CC BY-NC 4.0. Patching framework: MixinTale by Traktool.