Download Links :
Website : https://michaelpstanich.com/?mode=modhack&view=2024-10-16_Palworld_UniPalUI
Nexus Mods : https://www.nexusmods.com/palworld/mods/1894
Lover’s Lab : https://www.loverslab.com/files/file/37188-unipalui/
Mega : https://mega.nz/folder/9hZQ2IIR#Ou77tq4qQxw9UBQsozh6zg
GDrive : https://drive.google.com/drive/folders/1IMQz8qlVyUj3I7kuUYK5p0p2N7b7jFiN?usp=drive_link
What is UniPalUI?
Unified Palworld User Interface for Mods (UniPalUI for short) is a mod menu mod with a custom input handler and several UI features for other mods to use through a simple API and callbacks system. UniPalUI makes it easy for mods to implement keybinds and/or mod menus without having to build their own unique systems or manage conflicts on their own. UniPalUI is built with its own custom UI and input handlers so it can run parallel from the game with its own mod register system. UniPalUI’s systems are designed to be highly flexible, leaving the vast majority of logic up to the modder, this makes UniPalUI suitable for not just configuring settings, but also setting up gameplay related menus like options selections, setting up custom controls for a free cam, adding gameplay elements with their own interact component (like a custom crafting table), and any other feature a modder may need a menu for.
NOTICE - MOD IN DEVELOPMENT
UniPalUI is still in its early development stages and you may encounter issues or undefined behavior! If you find issues or have suggestions on what to add or how to improve UniPalUI, please let me know; given this is a framework style mod I need to know what other modders want to see/use! (The best place to leave suggestions and report bugs is our Discord - The Broken Chatbox - https://discord.gg/h3vB7S4FEw)
Known Critical Issues
Sometimes the menu can get ‘stuck’ without the mouse visible when toggling between in-game menus, pressing escape a few extra times will close UniPalUI’s menu pop-up and then can be re-opened without issue.
Broken mods that don’t manage input states can put UniPalUI in a locked state. This isn’t really an issue with UniPalUI but is worth mentioning, UniPalUI is very flexible and that does put some responsibility on modders to use these tools appropriately to ensure a good experience for users!
Opening and Interacting with the Menu
Open/Close menu keybind : Shift+Y
While UniPalUI is installed, hold shift and press Y (Shift+Y) to open the initial Mod Menu Selection screen of UniPalUI. You should then be able to interact with the menu via mouse controls (controller and keyboard navigation support planned as optional in future versions). To close the menu you can use the Exit Menu button or press Shift+Y again which should return to gameplay. UniPalUI was designed to be flexible and useable during gameplay, this means you can still move, aim, shoot, and interact while UniPalUI is open!
Features List
Custom User Interface
UniPalUI adds its own custom built User Interface which loosely tries to follow the base game’s UI themes and colors while maintaining its own unique look to keep itself easily identify-able. The interface is not tied to base game assets in any way which helps make UniPalUI game-version safe. Modders can add their own menu and options using the API with a range of available menu button options. (More box types being worked on for future versions)
Notifications Display
Within UniPalUI’s API is an option to display notifications in the top left of the screen. These are not only useful for modders to quickly set up debug messages that show up on-screen, but can display useful information for players such as displaying quick information about events, show current interact information, or just displaying an ‘installed’ message on start up so users know your mod is running properly! (Altermatic uses this feature!)
Custom Input Handler
UniPalUI has its own custom input handler that runs along-side the game to ensure the most flexible options for modders and their input. Modders can add inputs using the API and listen for callbacks for when those inputs are pressed/held/released with configurable delays, and UniPalUI will also manage conflicts, reporting back when another mod is already using a keybinding. (Rebinding and additional conflict handling is planned for future versions)
Modders API and SDK
UniPalUI is designed to be used in the Unreal Engine editor and features its own publically available SDK. This SDK features dummy assets and some examples to help modders use the API to create their awesome menus! However modders that prefer lua can still access the API using the included Metadata.txt doc which lists the functions and features.
Independent Systems
To ensure UniPalUI remains game-version safe, all the systems within UniPalUI are completely custom and the design focuses on ensuring updates are less likely to break functionality or features. The internal systems are also designed so that modders shouldn’t need to update their SDK to take advantage of new features and older versions should work on newer versions (within reason).
How to Install UniPalUI
- Unzip the archive and from inside the folder of your platform, copy the ‘LogicMods’ folder into “[Palworld Install]/Pal/Content/Paks”
- Install the proper version of UE4SS (Latest version with updated Palworld) - https://github.com/UE4SS-RE/RE-UE4SS
[ + Ensure inside the UE4SS install, inside the “mods” folder, open the “mod.txt” and make sure “BPModLoaderMod” is set to 1 ]
[ + If your game starts crashing after installed UE4SS, open the UE4SS-settings.ini file that is within the UE4SS install and set “bUseObjectArrayCache” to false ]
Notes for Modders
UniPalUI is pretty powerful and has very few guardrails in-place. This makes UniPalUI slightly more complicated to use (think something like MCM from the Skyrim scene) but offers a lot of flexibility in how you use these systems. This also means you can ‘break’ functionality if you are too careless! Avoid situations where you switch input states and stay there for longer than instended, always close out your interactions by leaving input states if you ever use them, avoid excessive menu pop-ups through gameplay when not neccesary and try to limit it to player-driven input, and try to use modifier keys for any input that isn’t going to be time critical during gameplay such as interacting with static objects or opening menus (this also helps prevent conflicts). It’s also worth being mindful of in-game keybindings, UniPalUI will allow keybindings to match in-game keybinds in-case you have a use case for it, but that means you’re on your own for managing conflicts with base-game keybinds.
UniPalUI was originally created for my own use cases as a way to have a universal UI solution instead of creating individual solutions per-mod (which was very quickly going to become a pain if it went unsolved). As a modder, UniPalUI has made my menu and input handling systems much more clean and straight-forward while also speeding up implementation. If you’re interested in using UniPalUI for your own mod, please check out the “UniPalUI - Metadata.txt” included with UniPalUI’s download for more info on the API features, as well as checking out the SDK for a starting point within Unreal Engine and working with Blueprints! (If you need help at any point, you can join our friendly and helpful Discord, The Broken Chatbox - https://discord.gg/h3vB7S4FEw to ask any questions you may have!)
Questions and Answers (FAQ)
At the time of writing, UniPalUI’s SDK and proper release version are not publicly available, so I don’t really have anything to put in FAQ! If you have questions please consider asking in our Discord, The Broken Chatbox - https://discord.gg/h3vB7S4FEw and we may find some things to add here!
Got an awesome mod that needs a menu but need help with UniPalUI? Feel free to contact me or interact with our Discord! ( https://discord.gg/h3vB7S4FEw ) We’re a community thriving on creativity and would be really glad to help!
