Skip to content
Mirage

Community & Feedback

Mirage is an open-source project, and feedback and participation are welcome. It’s still in its early stages, so your bug reports are a big help in improving compatibility.

Reporting Issues

Section titled “Reporting Issues”

When you run into a bug or unexpected behavior, please open an Issue on GitHub:

To make it easier to pin down, please try to state clearly:

  • Your system version and Mirage version;
  • Steps to reproduce;
  • The expected result and the actual behavior;
  • Relevant logs (you can enable “Verbose logging” in General Settings, and for Workshop issues you can export a redacted support report).

You can also join the QQ group 2160040437 to chat and share feedback.

Contributing

Section titled “Contributing”

Pull Requests are welcome. Before submitting, please confirm at least that:

  1. The three renderers build independently;
  2. ./Mirage/scripts/build.sh Release produces a complete app bundle;
  3. The app bundle contains the three renderers, the runtime dynamic libraries, the MoltenVK ICD, and assets;
  4. You haven’t committed API Keys, Steam login data, build directories, or user wallpapers.

For build instructions, see Building from Source.

Sponsoring

Section titled “Sponsoring”

Mirage will continue to be developed freely and openly. If it brings value to your desktop, you’re welcome to sponsor it as you see fit — every bit of support goes toward ongoing maintenance, compatibility improvements, and new features. Sponsorship is entirely voluntary and does not affect access to any features.

The Support Mirage page shows Afdian, WeChat Pay, Alipay, and USDT directly, without sending you to the project README.

License

Section titled “License”

Mirage is released under GPL-3.0. Third-party code and resources in the repository remain under their respective licenses.

Acknowledgments

Section titled “Acknowledgments”

Mirage’s implementation references and uses the following projects:

Affiliation Notice

Section titled “Affiliation Notice”

Mirage is not affiliated with, nor endorsed by, Valve, Steam, or Wallpaper Engine. Workshop content belongs to its respective authors; please observe the applicable licenses and terms of use.