StardewUI

The ultimate framework for building user interfaces for Stardew Valley mods

StardewUI

🎨 A new era for mod developers

React was born in 2013, Windows Presentation Foundation debuted in 2006, and Qt has been around since *1991*. Why are you still using the computational equivalent of bone spicules and ocher to build user interfaces? I promise, there *is* a better way! Put down that rusty old pickaxe made of an unknown but obviously cheap material and upgrade to a tool with iridium heat!

✨ Frame Features

StardewUI provides:

• **Rich component library** 📦 - Contains standard views and widgets such as frames, layouts, buttons, drop-down menus, and even keybinding editors and text input boxes
• **Exclusive UI language** 💻 - StarML language is similar to HTML. With 10 lines of markup, you can complete work that originally required hundreds or even thousands of lines of code.
• **Data Binding System** 🔗 - Supports data binding and event binding, allowing you to implement MVP, MVVM or any MV pattern according to your preference
• **Dynamic Live Layout** 🎯 - No need to manually calculate pixel positions anymore
• **Hot reload function** 🔥 - Custom resource processing, support hot reload; modify the UI definition in your favorite editor and view the changes in real time
• **Controller Support** 🎮 - Built-in focus and interaction features, no more extra work to make menus barely support controllers
• **Highly Extensible** 🚀 - A large number of extended functions, more functions are being added continuously

🛠️ Syntax Highlighting

StarML is *like* HTML, but it is *not* HTML. Provides syntax highlighting support for Visual Studio, Visual Studio Code and Notepad++. You can download these extensions from the latest GitHub release; as they are only available to modders, they will not be released on GitHub. Please visit the editor settings page for more information.

❓ Do ordinary players need to download it?

You only need to download it if you install a mod that requires this framework. Installing StardewUI alone will have no impact on your game. This is a mod developer framework, similar to SpaceCore or Item Extensions.

🔧 Compatibility

StardewUI is almost entirely a standalone framework; it only patches a method for handling SMAPI's unknown resources to be able to load StarML views as regular resources.

In other words, StardewUI does not break any other mods. However, it may *be* broken by other mods, especially if they change the way some core MonoGame graphics features work, like SpriteBatch. Having said that, it has been tested with mods like Clear Glasses and generally works very well.

---

📚 Related links

-Official documentation

• source code
• Update log

Ready to get started? Head over to the Getting Started Guide - yes, StardewUI has *real documentation*! — or check out some examples (more will be added over time).