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

• Recoil Engine (Open source RTS engine, RmlUi integration)
• 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

• Singing Challenge by @gleblebedev
• The Thing: Remastered by Nightdive Studios
• Killing Time: Resurrected by Nightdive Studios
• 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).
• XML Schema for RML (#760).

Other resources

• vcpkg port. See also the RmlUi port folder.
• Conan Center recipe for RmlUi. (See also #183 and C++ documentation).
• xmake. A cross-platform build utility based on Lua. See also RmlUi package source.
• 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.

[ArthurVasseur]

Hey! There is also an integration on xmake https://xmake.io/#/about/introduction

https://github.com/xmake-io/xmake-repo/blob/dev/packages/r/rmlui/xmake.lua

[mikke89]

Hey, that's great to see! Didn't know about this one, thanks for the heads-up. I've added it to the list now.

[badosu]

@mikke89 First thank you so much for RmlUi, it was integrated on Recoil RTS Engine using RmlSolLua and by all indications it should make the lives of gamedevs using Recoil much easier when writing gui components.

In hopes of finding a way to provide lua annotations for lua-language-server and our rmlui lua-based integration I searched this repos issues, pull requests and now discussions. Since this is related to resources, and maybe I just was not able to find them, I feel compelled to ask if there's some resource (to be added here) for lua documentation in a format readable by lua-language-server.

If there's none, I was unable to find how your liquid generator data is curated, is it manually edited? I was hoping to get a clue on how to achieve the type library myself using that pipeline. I'd reckon would be a valuable resource, thank you!

[rhys-vdw]

Hi, I'm the author of lua-doc-extractor. You may find that it's useful to your project. It's a little immature at present but it does have a massive stress test with RecoilEngine (and I am adding features ongoing). If there is any interest in integrating it into this project let me know.

[mikke89]

Hey, that's very cool! Thanks for letting me know.

I'd be very interested to use something like this. If we could backport the documentation to the source, and have that generate a close equivalent to what we have, that would be super cool. Right now I think it would take more time and effort than I can dedicate to this, but I'd certainly be willing to assist if somebody wants to have a go at that.

I also see that you are adding docstrings to your RmlLuaSol fork: beyond-all-reason/RecoilEngine#2247
Maybe it would make sense for us to switch our Lua plugin to this at some stage?

[rhys-vdw]

Yeah, I think it would make sense to upstream those docs once @SlashScreen is done with them.

The advantage of using this system is that it generates definition files for lua-language-server which gives intellisense in the editor. You can see the output for recoil here: https://github.com/beyond-all-reason/recoil-lua-library/

You'd have to make a separate repo like this too, and then it can be used by a submodule by your API consumers.

I probably don't have the bandwidth to actually implement the system for you, but it might be a case of copying the relevant workflows from the RecoilEngine repo and adapting them.

[mikke89]

I see, that sounds very cool. I am definitely interested in seeing this upstreamed.

[badosu]

I also see that you are adding docstrings to your RmlLuaSol fork: beyond-all-reason/RecoilEngine#2247 Maybe it would make sense for us to switch our Lua plugin to this at some stage?

Can't say for the effort related to using sol2 in RmlUi source, it's a non-trivial effort but I can see benefits (easier to reason about and maintain) and drawbacks (tied to whatever sol2 supports, e.g. this issue).

In any manner: inline docs using lua-doc-extractor for pulling Lua documentation from source (and populating a lua library for lua-language-server or EmmyLua-LanguageServer, with automatic html/markdown docgen for site) is orthogonal to Lua C API wrapper choice (at least while sol2 does not support automatic docgen, which it won't anytime soon).

One can already document using normal C Lua API as we do on Recoil, or sol2 as we also do on Recoil.

I'd be very interested to use something like this. If we could backport the documentation to the source, and have that generate a close equivalent to what we have, that would be super cool.

Example of an action item: document Element:GetElementsByName (pardon me if my understanding of the actual RmlUi API is inaccurate, but the point still stands, Element[] below could be also table<integer, Element> elements A 0-indexed list of matching elements)

1. Right above this line, (where this function is defined, could be some other source if it makes more sense, up to the author), add doc as this (assuming @class Element exists somewhere):

/*** Returns a list of all descendant elements matched by name.
 *
 * @function Element:GetElementsByName
 * @param tag_name string The tag name to be matched against
 * @return Element[] elements The list of matching elements
 */

2. Have github workflow actions (or a manual process) to extract these docs with lua-doc-extractor and populate the RmlUi "lua library" (types for language server) and/or generate html/markdown pages from them.

I see, that sounds very cool. I am definitely interested in seeing this upstreamed.

Glad to read that, thank you! Recoil requires the whole exposed API to be documented anyway, so at some point either we'll have our own RmlUi base documentation (that can be in some way upstreamed) or a strategy to do this in RmlUi itself (as PRs to this repo) and pulled to our docgen build process.