Official Factorio Wiki - User contributions [en]

Tutorial:Modding tutorial

2020-09-05T00:34:12Z

Eradicator: added link to noise expression tutorial

These tutorials range from teaching the first steps of modding to in-depth explanations of individual mechanics:

* [[Tutorial:Modding tutorial/Gangsir|Modding tutorial/Gangsir]] — A simple modding tutorial that suits beginners well.
* [[Tutorial:Mod structure|Mod structure]] — More details on how mods need to be structured in order to be loaded by the game.
* [[Tutorial:Scripting|Scripting]] — A small tutorial that focuses on run-time scripting and provides some info on how to use the story script.
* [[Tutorial:Mod settings|Mod settings]] — A comprehensive tutorial about how to create and use mod settings.
* [[Tutorial:Localisation|Localisation]] — A tutorial about how to format and use localisation, which is how mods are translated.
* [[Tutorial:Script interfaces|Script interfaces]] — A small tutorial about script interfaces ([http://lua-api.factorio.com/latest/LuaRemote.html LuaRemote]) and custom keyboard shortcuts.
* [[Tutorial:Inspecting a live mod|Inspecting a live mod]] — An annotated tour of a mod that is live on the mod portal right now.
* [https://togos.github.io/togos-example-noise-programs/ Noise Expressions] — A tutorial about generating terrain, complete with [https://mods.factorio.com/mod/togos-example-noise-programs example mod].

=== Additional info ===
* [[Tutorial:Modding FAQ|Modding FAQ]]
* [[Prototype definitions|Prototype documentation]]
* [[Scenario system]] — Save-based mods ("soft mods") and their limitations
* [http://lua-api.factorio.com/latest/ Factorio API Documentation] — Documentation of the runtime api
* [https://lua-api.factorio.com/latest/Migrations.html Migrations guide] — All information about mod migrations
* [https://github.com/wube/factorio-data Factorio data github repository] — Tracks changes of the lua prototype definitions in factorio in between releases.
<noinclude>
== See also ==
* [[Tutorials]]
* [[Modding]]
* [[:Category:Technical]] — Documentation of technical formats and API's not related to modding</noinclude>

Tutorial:Inspecting a live mod

2020-09-04T19:25:58Z

Eradicator: unordered list fits better with the already numbered chapters

== 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 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,
[[Tutorial:Modding tutorial/Gangsir|Gangsir's modding tutorial]] is a good starting point for learning them.

First <code>settings.lua</code> shows creation of some basic setting prototypes.
Then <code>data.lua</code> covers most basic operations like creating new item,
recipe, building and technology prototypes. And how to interact with
prototypes of other mods. Finally in <code>control.lua</code> 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!

* Chapter 1 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/settings.lua settings.lua]
* Chapter 2 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/data.lua data.lua]
* Bonus Chapter : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/migrations/2020-08-28_HCG_2.0.0.json migration.json]
* Chapter 3 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/control.lua control.lua]

== Full mod ==

HCG is available in full on
[https://github.com/lossycrypt/eradicators-hand-crank-generator GitHub]
or on the
[https://mods.factorio.com/mod/eradicators-hand-crank-generator Factorio Mod Portal].

== See also ==
* [[Tutorial:Modding tutorial|Modding tutorial overview]]
* [[Prototype definitions|Prototype documentation]]
* [http://lua-api.factorio.com/latest/ Factorio runtime API documentation]

Tutorial:Inspecting a live mod

2020-09-04T15:48:54Z

Eradicator:

== 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 from [https://mods.factorio.com/mod/eradicators-hand-crank-generator Factorio Mod Portal] 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 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,
[[Tutorial:Modding tutorial/Gangsir|Gangsir's modding tutorial]] is a good starting point for learning them.

First <code>settings.lua</code> shows creation of some basic setting prototypes.
Then <code>data.lua</code> covers most basic operations like creating new item,
recipe, building and technology prototypes. And how to interact with
prototypes of other mods. Finally in <code>control.lua</code> 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 [https://github.com/lossycrypt/eradicators-hand-crank-generator 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!

# Chapter 1 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/settings.lua settings.lua]
# Chapter 2 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/data.lua data.lua]
# Bonus Chapter : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/migrations/2020-08-28_HCG_2.0.0.json migration.json]
# Chapter 3 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/control.lua control.lua]

== See also ==
* [[Tutorial:Modding tutorial|Modding tutorial overview]]
* [[Prototype definitions|Prototype documentation]]
* [http://lua-api.factorio.com/latest/ Factorio runtime API documentation]

Tutorial:Inspecting a live mod

2020-09-03T15:40:40Z

Eradicator: Created page with "== 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..."

== 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.
Hand Crank Generator 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 tutorial assumes that you already know how LUA works and that
you have have familiarized yourself with at least the basic concepts
of Factorio modding. On that basis it 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 want to give yourself a real challenge you can of course try to
read this without any prior knowledge and try to learn on-the-go.

First <code>settings.lua</code> shows creation of some basic setting prototypes. Then <code>data.lua</code> covers most basic operations like creating new item,
recipe, building and technology prototypes. And how to interact with
prototypes of other mods. Finally in <code>control.lua</code> 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 harddrive.

== Tutorial ==

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

Chapter 1 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/settings.lua settings.lua]
Chapter 2 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/data.lua data.lua]
Bonus Chapter : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/migrations/2020-08-28_HCG_2.0.0.json migration.json]
Chapter 3 : [https://github.com/lossycrypt/eradicators-hand-crank-generator/blob/master/control.lua control.lua]

== Links ==

HCG is available in full on
[https://github.com/lossycrypt/eradicators-hand-crank-generator GitHub]
or on the
[https://mods.factorio.com/mod/eradicators-hand-crank-generator Factorio Mod Portal].

== Abstract Draft ==
(''For later use in [[Tutorial:Modding_tutorial]]'')

[[Tutorial:Inspecting a live mod|Inspecting a live mod]] — An annotated tour of a mod that is live on the mod portal right now.