In other languages:

Tutorial:Inspecting a live mod: Difference between revisions

From Official Factorio Wiki
Jump to navigation Jump to search
mNo edit summary
(updated doc links to migrated prototype docs)
Line 45: Line 45:
== See also ==
== See also ==
* [[Tutorial:Modding tutorial|Modding tutorial overview]]
* [[Tutorial:Modding tutorial|Modding tutorial overview]]
* [[Prototype definitions|Prototype documentation]]
* [https://lua-api.factorio.com/latest/index-prototype.html Prototype documentation]
* [http://lua-api.factorio.com/latest/ Factorio runtime API documentation]
* [https://lua-api.factorio.com/latest/index-runtime.html Runtime API documentation]

Revision as of 11:27, 21 September 2023

Introduction

Welcome to the Inspecting-a-live-mod tutorial!

In this tutorial I will take you on an annotated tour of my mod Eradicator's Hand Crank Generator Deluxe. That's a rather long name so I'll often call it just HCG hereafter. HCG is a fully functional mod that you can download and play with right now! It has extensive comments in the code to explain how and why it works.

This is an advanced tutorial that assumes that you already know how Lua works and that you have familiarized yourself with at least the basic concepts of Factorio modding. On that basis this tutorial aims to provide a rough overview on how real-life mods work and shows you how to assemble the theoretical concepts you have learned so far into a working whole. If you are not yet familiar with the basics, Gangsir's modding tutorial is a good starting point for learning them.

First settings.lua shows creation of some basic setting prototypes. Then data.lua covers most basic operations like creating new item, recipe, building and technology prototypes. And how to interact with prototypes of other mods. Finally in control.lua I explain how to make custom behavior for buildings - namely how to make the Hand Crank Generator produce power when the player presses a key on the keyboard.

You can read the files on the web on GitHub or download and extract the mod locally to your hard-drive.

Tutorial

I recommend reading in the order that the files are loaded by the game. Have fun!

Full mod

HCG is available in full on GitHub or on the Factorio Mod Portal.

See also