search

GlassBricks / typed-factorio

Complete and featureful Typescript defintions for the Factorio modding API
MIT License
33 stars 3 forks source link

What does this do over `factorio-type-kit`? #4

Open jfmmm opened 2 years ago

jfmmm commented 2 years ago

Hi,

Just found out we could use typescript to do mods now and I'm trying to figure which of those two options I should start my mod with and since you're the most recent one I figure I would ask here.

Why should I use this over factorio-type-kit.. like what was the motivation behind doing your own solution rather than using the other existing one?

Thanks!

GlassBricks commented 2 years ago

Hi, thanks for inquiring!

factorio-type-kit itself says it has 70-80% complete types. Also, when working with it a while back, I found many bugs and incomplete definitions -- such as variant parameter groups not being handled properly. I ended up manually editing the definitions during the project.

I made this project to fix those issues, provide type definitions as complete as possible, and provide more intelligent types by utilizing typescript features. This type generator also takes advantage of the machine-readable json factorio api release a few months ago (factorio-type-kit used wiki scraping), and includes many manually defined additions/overrides to fill in where the json api is lacking.

Currently, types for the runtime stage are 100% complete, i.e. all runtime factorio types have a non-trivial definition. You can find details on most of the typescript features utilized on the Readme. Also, this project is currently getting updates as the factorio version moves or additional improvements to the types are found.

cdaringe commented 1 year ago

ah man, i wish you would have filed an issue with me. would have loved to fix/refactor those problems. (:wave: factorio-type-kit guy)

cdaringe commented 1 year ago

...this is much better :)

cdaringe commented 10 months ago

Im going to mark my ftk as “dont use” and point here