Description
Sphere is an open-source server-oriented plugin written in Lua for Palworld.(Windows only) It empowers game administrators with commands, such as summoning pals, distributing item kits, and opening up exciting possibilities for the future! Some upcoming features include the ability to create custom bosses on the map, implement a VIP system to reward players.
Usage
To use any command in Sphere, you need to be an admin on the server
- /gpal SteamIDorUID DataPal
- /kit SteamIDorUID DataKit
- /spawn DataPal
- /reloadsphere (Sphere must have turned on correctly at last one time)
- /tp SteamIDorUID or SteamIDorUID_PX (Where x is the palbox number, for example P1)
- /help
After installing Sphere, start it once. It will create a folder called Sphere and a file called Sphere.Logs in your Pal>Binaries>Win64 directory. The file, as the name suggests, is the log file where you can find any type of error, and you should use it for support on Discord or to find something you typed incorrectly. <<< Important
Now in the folder, you can find .json files, which is indeed the current data of your server; it will never be overwritten even in different versions.
Win64>Sphere>Data>Monsters.json
"Godnubis" <<< Required, It's the DataPal name you will use to summon or give the pal;
"Level" 1 to 50<<< Required
"DebugID" <<< Required, can be found here
"Quantity" 1 to 10 <<< Required
"Talent_X" 0 to 100 <<< Individual values (100 = +30%)
"Rank_X" 0 to 5 <<< Condenser values
"PassiveSkillList" 0 to 4 <<< Can be found here
"WildHPMultiplier" 1 to inf
"EquippedSkills" 0 to 3 <<< Can be found here
A pal cannot have a skill that it does not learn via level up or fruits
The list of all skills by fruits, can be here
The list of all skills by level, can be here
"MasteredSkills" 0 to 15 <<< The list of skills in the pals' backpack, an equipped skill will be lost if it is not mastered.
Win64>Sphere>Data>Kits.json
"Pro" <<< Required, It's the DataKit name you will use to give the kit
"ItemID" <<< Can be found here
Sphere Installation
- 1-Download the latest version of UE4SS; (Like: UE4SS_v-.-.-.zip)
- 2-Extract UE4SS.dll, UE4SS-settings.ini and dwmapi.dll, into "PalServer/Pal/Binaries/Win64" folder;
- 3-Create a Mods folder (if you don't already have one)
- 4-Extract all the files inside SphereProject.zip into "PalServer/Pal/Binaries/Win64/Mods" folder;
- 5-Go to PalServer/Pal/Binaries/Win64/UE4SS-settings.txt;
- Inside the txt file set -->bUseUObjectArrayCache = false;
- Inside the txt file set -->ConsoleEnabled = 0;
- Inside the txt file set -->GuiConsoleEnabled = 0;
- Inside the txt file set -->GuiConsoleVisible = 0;
Installing Palguard(recommended)
- 1-Follow the steps above;
- 2-Open the github releases of Palguard;
- 3-Download the latest ProtonWine version --Even if you are a Windows server-- (Like: PalGuard---_ProtonWine.zip);
- 4-Extract palguard.dll into "PalServer/Pal/Binaries/Win64" folder;
- 5-Put the palguard folder into "PalServer/Pal/Binaries/Win64/Mods" folder;
- 6-Support their discord! (I'm not the creator of the anticheat).
Contact
Well, we finally reached the end. I must say that since day 1 until today, February 22nd, 2024, I've been working on this project for at least 12 hours a day, with the other 12 spent sleeping or thinking about it. It was my first time working with Lua and making modifications to a game, and the most exhausting part was definitely trying to make the code as clean and scalable as possible to accept contributions...
But honestly, I think in the end, this was a good job, and I hope it can be useful to someone. If you encounter any bugs, use the button below to join our Discord; I can almost always respond there! The plugin and any version of it will always remain open-source, but if you feel extremely grateful and would like to help me directly, I kindly ask for a subscription to my Patreon—it's only $4.99. I dream of making a living from programming someday, and being in Brazil seems to complicate that more and more. That said, thank you very much for reading this far!
