Plugins v3

[catornot]

yes

what changed

• nuked presence ( will be move to the discord rpc plugin )
• more exposed sq functions
• exposed dll addresses
• g_pCVar is exposed
• added "userdata" to plugin's async call
• added runframe to plugins

 

Related

• discord rpc pr: Refactor for v3 NorthstarDiscordRPC#10
• mods pr: Plugins v3 NorthstarMods#652
• test plugins: Plugins v3 #472 (comment)

[Jan200101]

Small wish I have:
make plugin_abi.h a pure C header.

Right now, plugins need to maintain the same data structure in their own codebase, making it rather tedious to maintain.
Turning plugin_api.h into a pure C header would allow languages that can understand C headers (e.g. C, C++, Zig) to import it directly, with little to no modification needed.

[catornot]

plugins that can be used to test plugins v3 :)
r2rcon-rs: r2rcon_rs.zip
rrplug_test: rrplug_test.zip
^ no src code

they don't work after b292371 commit

[F1F7Y]

As much as some changes I like, my main problem with our current plugin system is that increasing the version breaks all existing plugins.

Ill probably draft up an issue of how i think we could do better as increasing version on every minor change doesnt sound feasible at all

[GeckoEidechse]

As much as some changes I like, my main problem with our current plugin system is that increasing the version breaks all existing plugins.

In the case of v3 here, it's more than just a minor change, right? ^^

[Jan200101]

I tried testing with the given plugin but it just panics and gets the game stuck after the company logos

[2023-10-21] [08:35:45] [PLUGINSYS] [info] Succesfully loaded R2Northstar\plugins\r2rcon_rs.dll
[2023-10-21] [08:35:45] [PLUGINSYS] [info] Loading plugin r2rcon-rs version 1.0
[2023-10-21] [08:35:45] [r2rcon-rs] [info] plugin logging initialized
[2023-10-21] [08:35:45] [r2rcon-rs] [info] plugin static initialized : true
[2023-10-21] [08:35:45] [r2rcon-rs] [error] 
[2023-10-21] [08:35:45] [r2rcon-rs] [error] plugin panicked at src\lib.rs:50:18
[2023-10-21] [08:35:45] [r2rcon-rs] [error] full message:
[2023-10-21] [08:35:45] [r2rcon-rs] [error] panicked at 'a rcon cmd wasn't present', src\lib.rs:50:18
[2023-10-21] [08:35:45] [r2rcon-rs] [error] 

I updated SouthRPC to Plugins v3 but calling Cbuf_Execute causes a crash.
Had no luck debugging it thus far.
EDIT: Is a bug in wine caused by a debug trap. Hiding in x64dbg or not calling Execute fixes it. Uploaded a new version with it removed, tested on x64 Windows and Fedora 38.

SouthRPC V3 Source Code
SouthRPC V3 Plugin Zip

You can test SouthRPC is working by sending a request to
http://localhost:26503
with the body

{
	"jsonrpc": "2.0",
	"method": "execute_squirrel",
	"params": {
		"code": "printt(\"Hello World!\")"
	}
}

Here is a short form curl command:
curl --request POST --url http://localhost:26503/ --header 'Content-Type: application/json' --data '{"jsonrpc": "2.0", "method": "execute_squirrel", "params": {"code": "printt(\"Hello World!\")"}}'

[catornot]

I tried testing with the given plugin but it just panics and gets the game stuck after the company logos

panicking is intended behavior since it didn't find the correct command line args and it's in a thread so it's fine.
The game probably got stuck because that plugin is outdated and shouldn't work after b292371.

[Jan200101]

Tested already with SouthRPC.
Code is good.

[GeckoEidechse]

Confirmed working in testing together with R2Northstar/NorthstarMods#652 and R2Northstar/NorthstarDiscordRPC#10

Joined a bunch of servers and watched Discord activity status update

(No code review done in this review)

[Jan200101]

Looked over the code again and it still looks good to me.

[GeckoEidechse]

merged based on reviews ig