About this mod
A C++ Papyrus library that helps to optimize scripts. When a player has this plugin installed, mod developers can take advantage of getters, filters, sorters, and more, to make their mods more efficient, performant, and stable.
- Requirements
- Permissions and credits
- Mirrors
- Changelogs
-------
For Players:
A mod developer will direct you to this plugin if their mod can take advantage of it. All you need to do is meet the two requirements, download the plugin, install, and you're ready to go!
For Developers:
When a player has this plugin installed, you can utilize SkyPal's various global scripts to handle large amounts of objects in a single function call. Instead of iterating too many objects in Papyrus and bogging down the game or even worse, dumping stacks, you can use SkyPal to natively execute batch operations for you. Currently, the most developed SkyPal script lets you interact with and handle ObjectReferences in a variety of ways. Checkout the FAQ and the examples sections for more information. You may also wish to check out the GitHub page for the source code.
Requirements:
- Skyrim SE 1.5.97.0
- SKSE 2.0.17+ (2.0.19 recommended)
Whenever Bethesda releases a new version of Skyrim, this mod will require an update, just as SKSE does. In that event, you will need to install the updated version when it comes out. For more information, see the FAQ section.
FAQ:
Will you use the Address Library so I don't have to update when Bethesda releases a new version of Skyrim?
Will SkyPal be backwards compatible when it has received an update?
Can you add this or that function?
Developer Examples:
You can check if the player has correctly installed SkyPal:
Also what version they are running:
Let's combine a filter and sort to greatly improve our efficiency:
Find a weapon in the player's grid that has one of the keywords, but not both:
Special Thanks:
Special thanks goes to IDontEvenKnow for providing SkyPal's first use-case with his excellent and highly recommended mod IHarvest. He also provided assistance and support without which SkyPal would not exist.
Thank you:
- Bethesda for Skryim, which is such an endearing masterpiece.
- SSEEdit/TesVEdit/xEdit Team for such an amazing tool.
- Mod Organizer 2 Team for your indispensable program.
- SKSE Team for your extender, which has extended the life of the game itself.
- joelday for papyrus-lang and the excellent guide on how to use the Creation Kit with Mod Organizer 2.
- fireundubh for your parallel papyrus compiler pyro and the wiki that goes with it.
- Ryan-rsm-McKenzie of CommonLibSSE for decompiling useful parts of the SkyrimSE engine.
- meh321 of Address Library for SKSE Plugins for making it easy to get the executable's offsets.
- Polacode VS Code extension, for making it viable to share a screen shot of the source code.
- Creation Kit Wiki for the wealth of knowledge with which this mod was made.
- GitHub for giving my codebase a place to live online.
- NexusMods for such a great site, and for hosting my mod!
- testers and developers, for your interest, bug reports, and suggestions to make this mod better and better.
- my family, for giving me the time, space, and sustenance to make this mod.
- and every one else who has helped me directly or indirectly, if I have failed to mention you!
Last but not least, a big thank you to all who try out my mod, and to all of you who enjoy it and find value in it.