What is the "correct" way to write to a .json file from a mod?
Hey, i'm currently working on a mod that dumps a bunch of Information from the game into a .json file, since the communityDocs do not include all the information i need, so i'll be creating an entirely different file.
The problem is: I'm not sure what to use for JSON (De-)Serialization, i thought about using nlohmann json But quickly realized that that is not a great idea, it would conflict with any other mod that also uses it...
Is there a well documented library or some satisfactory docs page that i can orient myself on? i've seen JsonStructs, but i'm not sure if that is what i should be using (no documentation and seems to be more of a tool specificially for ContentLib)
Thanks in advance :feyxel:
27 Replies
worst case i'll just use nlohmann json and put it inside another namespace block or something
Look at ContentInspector
There's JSON file generation somewhere in there, I'm pretty sure
Solution
Oh you're right, just wonder if i can automate it
https://github.com/Th3Fanbus/Th3MapAreaDumper/blob/master/Source/Th3MapAreaDumper/Private/Th3ChatCommand.cpp
Well, you can write C++ code to generate the JSON
And I think UE has some sort of auto-JSON thing (no idea how it works)
i'd like to do so since i want to make it use the same format as SatisfactoryTools does actually
BTW, the only reason why the code prefixes some variables with
J is to remember those are JSON thingsI am pretty sure ue5 has some built in json stuff now. I think mod config files are stored as json right now so maybe check the SML code for that?
JsonStructs used to be used by ContentLib but it isn't any more, now only Content Inspector uses it
Yeah it does use FJsonObject
i see, i've worked with thse inside blueprints before, should be fine
https://docs.ficsit.app/contentlib/latest/index.html
docs still reference it, might want to update that
ContentLib Documentation :: Satisfactory Modding Documentation
These docs are a continual work in progress. If you have any suggestions, or are willing to contribute, please open a Pull Request or cont...
FRM (Ficsit Remote Monitoring) also uses JSON (and uses
FJsonObject and friends as well)this is very useful
your code coming to my rescue once more 😛 Thank you
that part is still up to date because ContentLib code has a reference to ContentInspector for a debugging feature, and ContentInspector needs JsonStructs. I could probably do some reflection shenanigans to not need Inspector in the editor... but that's pretty low priority for me
the reference only matters at editor time which is why CL doesn't depend on CI at runtime
ahhh i see yeah that makes sense
Well i'll make it work with FJsonObject, probably, i hope
forgot UE5 has it inbuilt but that makes alot of sense to be fair. Now i just need to find the functions to get the recipes/items present in the world again
Look at FRM
It might do quite a bit of the stuff you need
https://github.com/porisius/FicsitRemoteMonitoring
Yep, just need to get UE5 to acknowledge that my c++ & blueprint mod does indeed have c++
Yeah the c++ classes fodler is not showing up inside UE5 for me, using the UE5 Class wizard thing just places the cpp and h file in the intermediates directory, do i just use the "normal" visual studio file creation, or is there something else i should be doing?
Create a new mod using the alpakit template as a test and compare their structure? The ue5 new class tool shouldn't be putting stuff in intermediate...
that was a completely new mod
managed to add it via rightclick in VS, still had to type out the path manually for public/private though... but it is running
I don't understand; yes, creating a separate mod in alpakit to compare their structures is a completely new mod. I thought something was going wrong with the mod you were currently working with?
when using the ue5 new class tool, are you selecting your mod's module from the dropdown?
yeah, well i tried using it from within VS because the c++ files folder did not appear until i had a second header in there
it probably does work from inside UE5, but i'm a bit confused why the c++ classes folder is just missing inside UE5 until another file is created
you don't need the C++ files folder to use the new class utility, it's in the Tools menu
hm i see i could just create it on some other mod and select that one huh
yeah i just realized that myself rip
well that was alot of suffering for no reason LOL
should probably update the C++ docs to mention that. they are really in need of a reword in general
i think it was mentioned somewhere
i just could not find it at all
it's probably buried in some doc
god damn it
...i scrolled down until "Finishing Up" like twice today
I'll be going offline for today, but thanks again for the help everyone, really helped 🙂
now to cover random edge cases like the alternate recipe for turbofuel, compacted coal, polyester fabric and distilled silica not being marked as an alternate recipe...
@Zitronenwasser