Thirdparty integrations and resources

[mikke89]

Hi all.

I've been collecting some resources and thirdparty integrations for RmlUi. They may be useful for people making their own integrations, or just for having a look around out of curiosity.

Open source integrations and backends

• Godot RmlUi. (A GDExtension port of RmlUi to Godot 4.2+).
• rmlui-bgfx. (RmlUi backend for bgfx, compatible with D3D11, Vulkan, Metal).
• DiligentEngineXRmlUI. (RmlUi backend for Diligent engine)
• rbfx. (Game engine based on Urho3D. RmlUi integration)
• Raylib+RmlUi. (RmlUi backend for raylib)
• QFusion. (OpenGL, RenderInterface)
• RavEngine. (bgfx, RenderInterface)
• Rootex. (DirectX11, RenderInterface)
• ezEngine. (RmlUi plugin source, RmlUi documentation and sample)
• Kisak-Strike. (Unofficial CS:GO port, OpenGL, Integration)
• Conquer Space. (OpenGL, RenderInterface)
• RmlUE4. (Unreal Engine 4 integration, Chinese)

Games and applications

• Beyon All Reason (Blog post on RmlUi integration)
• TruckersMP (Blog post on chat system implemented with RmlUi)
• Unvanquished (Blog post on RmlUi integration)
• alt:V installer
• Portal Dogs

Plugins

• RmlSolLua. Unofficial Lua plugin based on sol3, supports Lua 5.1+ and LuaJIT/MoonJIT.

Tools

• RCSS Spritesheet Editor.
• rml-sublime. RmlUi syntax definition for Sublime Text 4 (#304).

Other resources

• Conan Center recipe for RmlUi. (See also #183 and C++ documentation).
• vcpkg port. See also the RmlUi port folder.
• Alternate Conan recipe and sample project.
• Covellite++. (Cross-platform framework, multiple backends, Russian).

Feel free to post your own or missing projects below!

[xland]

It would be great if integrate QuickJs into RmlUi,just like Lua.

[mikke89]

Yeah, I know some users have integrated Duktape for JS support. There is more discussion on this topic here: #268. If anyone publishes such a plugin let me know and I'll be sure to add it to the list.

[ShawnCZek]

Hey @mikke89,

First of all, huge thanks for all the work you have been doing on this library! It is apparent that a lot of work goes into it and that the library is heading in a great direction. There is a bright feature for this project, I believe.

I am one of the game developers on TruckersMP, which is a multiplayer modification for Euro Truck Simulator 2 and American Truck Simulator. The user interface is one of my responsibilities. Throughout the past months, we have been doing extensive research, searching for the best fit for our needs. Even after considering commercial solutions, RmlUi turned out to be the best candidate, particularly because it is open source and is easy to contribute to, unlike other HTML-like and CSS solutions.

Right now, we are switching over from our previous solution, GWEN, to RmlUi. And the first UI document to be reworked is our chat system. We also used this opportunity to completely rewrite the backend, so it is quite a major change for our community.

Here is a showcase of our new chat: https://youtu.be/sspcPSymg54

The changes include stuff like UI scaling, proper support for all character sets, proper word wrapping, a dynamic autocomplete for player mentions and slash commands (a bit of Lua scripting), and so on. It is incredible what one can achieve with CSS and scripting instead of placing some elements around in a designer.

At TruckersMP, we look forward to what's coming next for this library!

[ShawnCZek]

Thanks for the kind words!

And sure, it would be an honor to be a part of the gallery! I have uploaded a screenshot from the game to my Google Drive so we avoid any compression (from GitHub or any other service) on the way.

[mikke89]

Perfect, thanks! I've added it now. Let me know if you want to change something, or have more screenshots in the future :)

[ShawnCZek]

Hey @mikke89,

It has been a while since our last update, but the user interface is obviously not our only project. The last time, we looked at improving the chat system, which we later iterated by adding support for IME. This time, we are improving our "Scoreboard", a panel with a player list.

There were a few issues, many of which were discussed in #653. With your help and a few iterations, we created a decent-looking panel that performs really well, even in areas with hundreds of players. Furthermore, we could easily add features like player icons and action buttons. And everything now scales nicely based on the resolution. We think it is a significant improvement compared to the previous version, as seen in one of our promotional images. Or check out our blog post for more details.

Anyway, we are still using the 5.1 version but plan to upgrade soon. Let's see how that goes!

By the way, so that you know, this is not an unusual number of players in one area:

[mikke89]

Wow, that's a great looking scoreboard, and a massive improvement. Nice job!

I'm very happy to see that it worked out, despite some challenges along the way. It's a nice real-world learning experience for the library too.

If you have a full resolution version of just the new scoreboard, I'd love to put that on the readme if you'd like.

[ShawnCZek]

Sure! I made a few changes to exclude players' names for privacy reasons. I have uploaded a screenshot from the game to my Google Drive.

There are a few misalignments of icons, but those should be resolved once we move to 6.0.

[ashifolfi]

Hey! I've had my eye on this library for a while and actually just started learning how to use it a few days ago. I ended up creating a Godot addon to add support for RmlUi via GDExtension. It's still quite early on but I might as well share this with others now that it's sort of useful.

Source Code

[mikke89]

That's awesome, nice work! Thanks a lot for posting, and for sharing the code :) I have added it to the list. Great to see the interest from the Godot community, and looking forward to following the progress.