Releases: ModShardTeam/ModShardLauncher
v0.13.2.0
Description
New minor version of ModShardLauncher (MSL)
Please backup your saves before using mods.
Note
You can find out how to use MSL and install mods right over here !
Warning
- If you find any issue, you can report them here.
- See the
Modder Changelog
section for any breaking changes.
Modder Changelog:
- Methods like
MatchFrom
,MatchBelow
, andMatchFromUntil
will throw errors if there are no matches. - Fixed
UIComponentType.Slider
. - Fixed
InjectTableItemLocalization
andInjectTableDialogLocalization
.
v0.13.1.0
Description
New major version of ModShardLauncher (MSL) for RtR
Please backup your saves before using mods.
Note
You can find out how to use MSL and install mods right over here !
Warning
- If you find any issue, you can report them here.
- See the
Modder Changelog
section for any breaking changes.
User Changelog:
- Nothing new here, this is a modder's update.
- Make sure you're on the modbranch version of the game !
- Note that when loading your
.win
file using MSL, it's not unusual for the application to pause or hang, give it time and be patient. - You can also enable the logging console in MSL's settings to ensure everything is running smooth even when freezing.
Modder Changelog:
- Re-added support for tables for RtR. New tables are also available, including those for crafting and cooking recipes. If any table doesn't inject properly, feel free to let us know on discord.
- Fixed a bug where underscores (
_
) in mod names would be removed.
v0.13.0-alpha.0
Description
New major version of ModShardLauncher (MSL) for RtR
Please backup your saves before using mods.
Note
You can find out how to use MSL and install mods right over here !
Warning
- If you find any issue, you can report them here.
- See the
Modder Changelog
section for any breaking changes.
User Changelog:
- You can now add mods to RtR using MSL, but you have to switch to the beta version of Stoneshard on Steam (modbranch).
- Note that when loading
data.win
using MSL, it's not unusual for the application to pause or hang, give it time and be patient. - The mods listed below have been fixed and will be updated soon:
- QuickSave
- SpeedManager
- AutoPathfinder
- Holy Diagonal
- Rusty Inventory Extension
- Rusty Darker Map
Modder Changelog:
- Currently, none of the APIs involving Tables have been checked or fixed. As such, mods relying on them will not work at the moment.
- Allows a new room to be created by
AddRoomJson
.
v0.12.1
Description
New major version of ModShardLauncher (MSL)
Please backup your saves before using mods.
Note
You can find out how to use MSL and install mods right over here !
Warning
- If you find any issue, you can report them here.
- See the
Modder Changelog
section for any breaking changes.
User Changelog:
- Installing and merging mods is much, much faster.
- Small screens everywhere, rejoice! The MSL window can now shrink. Only if your screen is actually small, though, don't get any ideas.
Modder Changelog:
- It now uses a different version of the UnderTaleModdingTool (UTMTCE) under the hood, which is better, faster, and wears sunglasses indoors. For an actual list of actual features, check out the repo here: https://github.com/XDOneDude/UndertaleModToolCE. This means that we now reccomend you use UTMTCE when viewing Stoneshard's code for modding.
- This also means that the code is decompiled in a slightly different way. Mainly:
true
andfalse
are correctly decompiled instead of showing up as1
and0
; object names are often shown instead of their cryptic ID number. If you have any questions, feel free to join the Stoneshard Mod Hub discord server: https://discord.gg/VT3jeDwjR3 - You can now access and edit many important scripts that were extremely complicated to edit before. This makes modding certain parts of the game, such as right-click context menus, 10 times faster and more reliable. This stat is a made up number and yet 110% correct.
- Note that
.sml
files compiled by this version of the MSL can not be used by older versions of the MSL. However, the reverse is feasible. This means that you need to clarify the version compatibility of MSL in the Mod installation guide.
v0.11.3
Description
New minor version of ModShardLauncher (MSL)
The vast majority of mods for previous versions of MSL should not break since backward compatibility is still an important issue, but mistakes can happen. As usual, please backup your saves before using mods.
Note
You can find out how to use MSL and install mods right over here !
Warning
- If you find any issue, you can report them here.
- See the
Modder Changelog
section for any breaking changes.
Maintainer Changelog
- Logs the version of MSL when launching the App and stores it, preventing the need to recompute the MSL version during patching.
- Logs a warning if the checksum of the data.win being loaded is different from the vanilla gog and steam version [ experimental ].
- Uses the packer module from MSPref instead of its own packing. From now on MSL and MSP will rely on the same packing algorithm [ warning: a new dependancy is needed to compile MSL ].
- Removes some legacy code.
- Logs the list of mods applied to a data.win even if the patching is successful. In previous version, it was only log if the patching failed.
Modder Changelog
- Adds a way to inject multiple events to a unique GameObject at once by providing the code of said events directly. In previous version you could do the same but by providing the path where to find said events in the mod folder.
- Adds new methods to create a new code from ASM abstraction and to create a new event by giving ASM abstraction instead of relying exclusively on GML.
User Changelog
- Removes the warning window when patching a mod built with a different version of MSL and logs it as a warning instead.
v0.11.2.0
Description
New minor version of ModShardLauncher (MSL)
The vast majority of mods for previous versions of MSL should not break since backward compatibility is still an important issue, but mistakes can happen. As usual, please backup your saves before using mods.
Note
You can find out how to use MSL and install mods right over here !
Warning
- If you find any issue, you can report them here.
- See the
Modder Changelog
section for any breaking changes.
Modder Changelog
- 🆕 MSL now exports all items, weapons and armors to a
.csv
file when a.win
file is loaded. - 🔧 Fixed a typo in
Consum_Param
table injection method (thanks @altairwei !) - 🔧 Fixed multiple issues with the log
- 🔧 Fixed a bug where
display_mouse_lock
not being found would cause a crash (thanks @DownToTwo !) - 📝 Removed
EventName
and addedUIComponent
to the documentation. - 📝 Some old assembly methods are now properly flagged as legacy.
- 📝 API is being updated, though not quite finished, this will still be worked on regardless of updates.
Note
The only download you need is msl.zip
.
v0.11.1.0
Description
Bugfix of the last release of ModShardLauncher (MSL)
The vast majority of mods for previous versions of MSL should not break since backward compatibility is still an important issue, but mistakes can happen. As usual, please backup your saves before using mods.
Note
You can find out how to use MSL and install mods right over here !
Warning
- If you find any issue, you can report them here.
- See the
Modder Changelog
section for breaking changes.
Don't forget to include ModShard.dll
in your Stoneshard folder !
Modder Changelog
- 🆕 Added an in-game async log to enhance debug for modders.
- 🆕 Added a timer independant of the gamespeed (unlike the alarm system), used notably in the msl log.
- 🔧 Fixed and completed the loot table tool. It can now support tiers related loot table.
Note
The downloads you need are msl.zip
and ModShard.dll
v0.11.0.0
Description
Third proper release of ModShardLauncher (MSL)
The vast majority of mods for previous versions of MSL should not break since backward compatibility is still an important issue, but mistakes can happen. As usual, please backup your saves before using mods.
Note
You can find out how to use MSL and install mods right over here !
Warning
- If you find any issue, you can report them here.
- See the
Modder Changelog
section for breaking changes.
Don't forget to include ModShard.dll
in your Stoneshard folder !
User Changelog
- 🆕 Added a Mod Menu in Stoneshard's settings, allowing for in-game customization of mod settings.
- 🆕 Playing with mods now displays a disclaimer to stop players from reporting bugs to the Stoneshard developers.
- 🛠️ Removed autoload / autosave when loading or saving a .win file.
- 🔧 Fixed an issue where patching a non-vanilla
.win
file would cause MSL to crash. - 🔧 Fixed an issue where malformed code files / sprites could crash MSL when patching.
Modder Changelog
- ❗❗ Disabled legacy Weapons class, as it is now replaced with table injections which serve the same purpose.
- 🆕 Added table injections for all non-localizable tables. (
ConsumParam
,StatsSkills
,Weapons
,Armor
...) - 🆕 Added
Room
,Layers
andInstance GameObjects
support, which allows creating and populating rooms through MSL. - 🆕 Added
Pre-Create
Event forGameObjects
. - 🆕 Added an in-game Mod Menu to let players configure settings mid-game. Supports
Checkbox
,ComboBox
andSlider
components. - 🔧 Fixed an issue where patching a non-vanilla
.win
file would cause MSL to crash. - 🔧 Fixed an issue where reading empty code files / sprites when patching a mod could crash MSL.
- 🔧 Fixed a rare bug where trying to add a global variable through assembly with a similar name to an existing local variable would prevent you from creating it.
Note
The downloads you need are msl.zip
and ModShard.dll
v0.10.0.0
Second proper release of the ModShardLauncher (MSL).
Mods for previous versions of MSL should not break since backward compatibility was an important issue, but mistakes can happen. If you encounter a breaking mod feel free to report it in the Issues.
As usual, please backup your saves before using mods.
Don't forget to include ModShard.dll
in your Stoneshard folder !
User Changelog
- 🛠️ Improve MSL stability
- 🆕 Made the console log togglable in the settings
- 🆕 MSL's logs now display patched mods when patching fails
- 🔧 Fixed a bug where failing to patch the .win would lead to MSL being unable to save
- 🔧 Fixed loading the .win twice after patching
Modder Changelog
- 🛠️ Adding more dll in the project to ensure smoother compilation
- 🛠️ MSL no longer needs to load a .win to compile mods into .sml
- 🆕 Added
AddNewEvent
overload, it can now be used both with strings and gameobjects - 🆕 Added
ApplyEvent
method to GameObjects to quickly apply multiple events to objects - 🆕 Added
Apply
method to FileEnumerables to quickly apply a custom iterator - 🆕 Added
LocalizationItem
to easily inject items localization table - 🆕 Added
LocalizationSentence
andLocalizationDialog
to easily inject dialogue localization table - 🆕 Improved
AddObject
to allow initialization of members in constructor - 🆕 When injecting assembly, MSL will auto create newly defined variables
- 🔧 Fixed FileVersion crash due to using a single file publish
- 🔧 Fixed a crash when opening MSL's server with an already existing one, now displays a warning
v0.9.0.0
First proper release of the ModShardLauncher (MSL).
Mods for previous versions of MSL are likely to break.
This release is an early build, and may very well contain bugs.
Please backup your saves before using mods.
Don't forget to include ModShard.dll
in your Stoneshard folder !
User Changelog
- 🔧 Fixed issue where Stoneshard's
.win
file would load forever. - 🔧 Fixed multiple crashes and made MSL less prone to crash overall.
- 📦 MSL is now bundled with the
.NET 6.0 Framework
and should not require the.NET 6.0 Desktop Runtime
anymore.
Modder Changelog
- ❗❗ Changed
ModLoader
class toMsl
. - 🆕 Added Assembly support.
- 🆕 Added Events support with basic validation.
- 🆕 Added a multitude of new methods to inject GML / Assembly more dynamically.
- 🆕 Added a
targetVersion
field to theMod
class to specify which Stoneshard version your mod was written for. - 🛠️ Compiling mods (into .sml files) no longer requires having a
.win
file loaded. - 📝 Overhauled documentation, with guides for both users and modders and API documentation.