[1.1] Modding Info References

Place to get help with not working mods / modding interface.
Locked
Bilka
Factorio Staff
Factorio Staff
Posts: 3123
Joined: Sat Aug 13, 2016 9:20 am
Contact:

[1.1] Modding Info References

Post by Bilka »

This post/topic is obviously meant as a list of links to Factorio modding information.

If you are just starting out, the modding tutorial page is the best points to start learning. Then when you are looking for documentation of the API's, the wiki's main modding page or the main documentation index are good start points that links to all of the general documentation pages (which then link to other, increasingly specific, pages). Everything is complete and up-to-date for 1.1.

From there the primary links are:
  • Documentation of the runtime API: Lists all of the properties and methods of different lua objects, and which events are available. This is one of the pages you'll want to bookmark when starting out.
  • Prototypes documentation: Lists all of the prototypes that you can create, and their properties.
  • Factorio data github repository: Tracks changes of the lua prototype definitions in factorio in between releases. Also useful to browse and search prototypes without opening the game files locally.
  • Data.raw: Lists the names and types of all built-in prototypes.
  • Data Lifecycle page: Events? Prototypes? When can use what? This page from the official API documentation explains it.
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.

Bilka
Factorio Staff
Factorio Staff
Posts: 3123
Joined: Sat Aug 13, 2016 9:20 am
Contact:

Re: [Updated to 0.17] Modding Info References

Post by Bilka »

All documentation is now completely updated to 0.17! Furthermore, over the year since the first post in this topic, many of the missing pages of the prototype documentation have been created, so currently only 4 out of the total 199 prototypes are missing documentation! Completeness greatly improves the overall quality, so I hope that the prototype documentation can now show its full potential :)
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.

eduran
Filter Inserter
Filter Inserter
Posts: 344
Joined: Fri May 09, 2014 2:52 pm
Contact:

Re: [Updated to 0.17] Modding Info References

Post by eduran »

Thank you, the quality of the documentation is really appreciated.

I would also add a link to the Data Lifecycle page. I know it is already at the bottom of the API page, but a lot of new modders miss it and I find it rather important.

Bilka
Factorio Staff
Factorio Staff
Posts: 3123
Joined: Sat Aug 13, 2016 9:20 am
Contact:

Re: [1.0] Modding Info References

Post by Bilka »

Checking in here with the news that all modding documentation is complete and has been updated to 1.0 as of today.
Furthermore, since the creation of this thread, multiple modding tutorials have been created and I estimate that in the future we will have even more. So the modding tutorial page is highly recommended for both new and old modders.
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.

Bilka
Factorio Staff
Factorio Staff
Posts: 3123
Joined: Sat Aug 13, 2016 9:20 am
Contact:

Re: [1.1] Modding Info References

Post by Bilka »

Checking in here with the news that all modding documentation is complete and has been updated to 1.1 as of today.
With this comes the addition of another modding tutorial, the long awaited GUI tutorial. It was created by Therenas, who has joined me in maintaining the documentation and is currently focusing on improving the runtime docs.

To aid us in improving the docs, we are asking for your feedback on missing descriptions and examples: 97880
I'm an admin over at https://wiki.factorio.com. Feel free to contact me if there's anything wrong (or right) with it.

Locked

Return to “Modding help”