Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jfmmm opened this issue Nov 1, 2021 · 4 comments
Open

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

jfmmm opened this issue Nov 1, 2021 · 4 comments

Comments

@jfmmm
Copy link

jfmmm commented Nov 1, 2021

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
Copy link
Owner

GlassBricks commented Nov 2, 2021

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.

@GlassBricks GlassBricks pinned this issue Nov 8, 2021
@cdaringe
Copy link

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
Copy link

...this is much better :)

@cdaringe
Copy link

cdaringe commented Nov 4, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants