Proposal: Publish JSON schema for mod's info.json on API Docs portal

Tools which are useful for mod development.
User avatar
Hares
Filter Inserter
Filter Inserter
Posts: 749
Joined: Sat Oct 22, 2022 8:05 pm
Contact:

Proposal: Publish JSON schema for mod's info.json on API Docs portal

Post by Hares »

TL;DR
API Docs should provide JSON schema for `info.json` file.
Why?
JSON schema is popular and well-supported format for validating JSONs before submission.
It is also integrated to most of the IDEs.
I've seen JSON shemas for 1.1, but for 2.0 there're none.

Why not?
I can hear you suggesting me to use modding development toolkit, but it's supported only for VSCode IDE, and thus its usage is rather limited.
Disclaimer: Biased opinion.
VSCode has horrible UI clearance, terrible performance, and has many other problems. Not all mods require extended Lua checkers, and for file-tree management I would 100% prefer JetBrains' IDEs.
User avatar
BraveCaperCat
Filter Inserter
Filter Inserter
Posts: 425
Joined: Mon Jan 15, 2024 10:10 pm
Contact:

Re: Proposal: Publish JSON schema for mod's info.json on API Docs portal

Post by BraveCaperCat »

Screenshot 2025-03-27 212528-modified.png
Screenshot 2025-03-27 212528-modified.png (46.66 KiB) Viewed 90 times
As seen in the provided image, the FMTK is compatible with NPM-supporting editors. I'm sorry if your editor of choice doesn't support NPM packages.
Disclaimer: Biased opinion. Copied and Modified from your post.
VSCode has great UI clearance, performant performance, and has very little problems. Not all mods require extended Lua checkers, but it is sometimes helpful. And for file-tree management I 100% prefer VSCode. Don't get me started on how plain VS is bad, though.
Creator of multiple mods, including Quality Assurance - My most popular one.
Go check them out with the first and second links!
I'll probably be wanting or giving help with modding most of the time I spend here on the forum.
Post Reply

Return to “Development tools”