search

Pryaxis / TShock

☕️⚡️TShock provides Terraria servers with server-side characters, anti-cheat, and community management tools.
GNU General Public License v3.0
2.39k stars 374 forks source link

Provide a way for plugins to override TShock SSC #3022

Open ZakFahey opened 5 months ago

ZakFahey commented 5 months ago

Add TShock.UseSSCInventory, which can be set to false by another plugin on initialization to override TShock's SSC implementation while keeping SSC on. This fixes the use case where you want to be able to override players' inventories from the server, but you don't want to use TShock's SSC system or force players to stay logged in.

Context: this functionality is in the internal Penguin Games server fork of TShock that we have, but I'm trying to merge everything from there upstream because I don't want to have to deal with maintaining a fork. Especially with 1.4.5 coming out any day now, I don't want to create more work for myself. We use SSC but allow logged-out users to play, and I'm sure that that's the case for other public servers as well.

Not all instances of Main.ServerSideCharacter were replaced because this is the code our server uses, and it works. I could understand wanting to change most if not all instances of it, though.

FFRiftMerge commented 5 months ago

In my opinion, it'd be better to use SSC config's enabled value instead of introducing a new member under TShock

ZakFahey commented 4 months ago

That config value combines two things: enabling SSC mode for Terraria clients, which lets you directly set their inventory, and TShock's SSC system, which saves players' inventories to TShock's database and disables logged out characters. I want one but not the other.

I'd acknowledge that this PR may be redundant if it's trivial to just have the config flag be off but override Terraria's SSC checks in my own plugin.

sgkoishi commented 4 months ago

There are three fields related: Main.ServerSideCharacter, the newly introduced TShock.UsingTShockSSC, and the (almost) unused SscSettings.Enabled. I guess he is proposing moving the function of the new TShock.UsingTShockSSC to replace the unused SscSettings.Enabled (since the latter is only used once for Main.ServerSideCharacter = SscSettings.Enabled)?

Arthri commented 4 months ago

Yeah, that's what I did on my fork https://github.com/Arthri/TShock/commit/a1fce06b7a4007ebe5afd37b03230e98332b27f9. I replaced the parts relevant to TShock's SSC and left the others untouched(like /rocket)

ZakFahey commented 4 months ago

Hmm, I'm noticing that if I turn off TShock's SSC just in the config on a normal version of it, while Main.ServerSideCharacter is false, players can still have their inventory slots set directly. Looking at the code, it does seem like it being false affects some things, but I can't immediately see them when joining a server.