sm.regui is a Scrap Mechanic library mod that allows modders to create graphical user interfaces that are normally not possible with sm.gui.
Note
Thanks to The Red Builder, I have been able to create this GUI library for all modders out there! Without him, this library wouldn’t even exist and none of this would've been possible.
With sm.regui, you can:
- Create, destroy, and fully control widgets
- Use a flexible template system
- Support fullscreen GUIs (allowing widgets to be placed anywhere on the screen and adapt to all in-game resolutions)
- Use functions that are now implemented! (e.g.,
GuiInterface:setData) - Easily translate text with a built-in translation system
- Draw any font you desire in any rotation*
- Create lists with the flexible widgets API.
- Play high-quality compressed 720p video.
For examples, check out the Examples directory!
For documentation, refer to the ReGuiDef.lua definition file!
Important
This GUI library uses a JSON bug that allows modders to create MyGui Layout Files! As a result, the library may break in future game updates.
Caution
Consider optimization if you're using sm.regui for animations, etc.
The JSON bug being used will result in bloated files that cannot be deleted without user assistance.
For example, Anything related for positioning and resizing (as a animation) should be done with controllers to reduce bloat.
Note
The latest known version that works with this library is: Scrap Mechanic BETA Ver 0.7.3 Build 776
Warning
Not Supported in MyGui LayoutEditor
sm.regui uses a custom layout file structure (called relayout with the .relayout extension) that wont work with the MyGui Layout editor at all!
If you want to create relayout files, you only got a few choices:
- Use a editor like
MyGui.NET For SM(Note: MyGui.NET For SM does not support this yet, but support is planned.) - Write the relayout file manually.
- Use a
.layoutto.relayoutconverter. (One provided in DevTools/LayoutToRelayout/)