Official Factorio Wiki - User contributions [en]

Types/Sprite

2015-03-31T04:06:07Z

Akhiros: /* priority */

== Basics ==
Specifies one picture that can be used in the game.

When there is more than one sprite or [[Types/Animation|animation]] frame with the same source file and dimensions/position in the game, they all share the same memory.
== Properties ==
=== filename ===
'''Type''':[[Types/FileName]]
=== priority ===
'''Type''':[[Types/string]]

Possible values:
* extra-high
* high
* medium
* low
* very-low

=== width ===
'''Type''': [[Types/unsigned]]

Width of the picture in pixels.
=== height ===
'''Type''': [[Types/unsigned]]

Height of the picture in pixels
=== x ===
'''Type''': [[Types/unsigned]]

'''Default''': 0

Horizontal position of the picture in the source file in pixels.

=== y ===
'''Type''': [[Types/unsigned]]

'''Default''': 0

Vertical position of the picture in the source file in pixels.

=== shift ===
'''Type''': [[Types/Vector]]

'''Default''': 0
=== scale ===
'''Type''': [[Types/double]]

'''Default''': 1

Values different than 1 specify the scale of the picture on default zoom.
Scale 2 means that the picture will be 2 times bigger on screen (and more pixelated).
== Example ==
picture =
{
filename = "__base__/graphics/entity/basic-accumulator/basic-accumulator.png",
priority = "extra-high",
width = 124,
height = 103,
shift = {0.7, -0.2}
}

Types/Animation

2015-03-31T04:04:02Z

Akhiros: /* priority */

== Basics ==
Specifies animation that can be used in the game.

Note that if any frame of the animation is specified from the same source as any other [[Types/Sprite]] or frame of other animation, it will be shared.
== Properties ==
=== filename ===
'''Type''':[[Types/FileName]]
=== stripes ===
'''Type''': [[Types/Stripes]]

Alternative picture specification to filename, it can specify more files to be used and composed as the input.
=== priority ===
'''Type''':[[Types/string]]

Possible values:
* extra-high
* high
* medium
* low
* very-low

=== width ===
'''Type''': [[Types/unsigned]]

Width of one frame in pixels.

pre v0.11 '''frame_width''' was used.
=== height ===
'''Type''': [[Types/unsigned]]

Height of one frame in pixels.

pre v0.11 '''frame_height''' was used.
=== frame_count ===
'''Type''': [[Types/unsigned]]
=== line_length ===
'''Type''': [[Types/unsigned]]

Once the specified number of pictures is loaded, other pictures are loaded on other line.
This is to allow having longer animations in matrix, to avoid pictures with too big width.
The game engine limits the width of any input picture to 2048px, so it is compatible with most graphics cards.
=== run_mode ===
'''Type''': [[Types/string]]

Possible values are:
*forward
*backward
*forward-then-backward
=== animation_speed ===
'''Type''': [[Types/float]]

Modifier of the animation playing speed, the default is 1, which means one animation frame per tick (60 fps).
The speed of playing can often vary depending on the usage (output of steam engine for example)
=== x ===
'''Type''': [[Types/unsigned]]

'''Default''': 0

Horizontal position of the animation in the source file in pixels.

=== y ===
'''Type''': [[Types/unsigned]

'''Default''': 0

Vertical position of the animation in the source file in pixels.

=== shift ===
'''Type''': [[Types/Vector]]

'''Default''': 0
=== scale ===
'''Type''': [[Types/double]]

'''Default''': 1

Values different than 1 specify the scale of the animation on default zoom.
Scale 2 means that the picture will be 2 times bigger on screen (and more pixelated).

== Example ==
Specification of animation of electric furnace
on_animation =
{
filename = "__base__/graphics/entity/electric-furnace/electric-furnace.png",
priority = "high",
x = 131,
frame_width = 131,
frame_height = 102,
frame_count = 12,
animation_speed = 0.5,
shift = {0.5, 0.05 }
},

Modding

2015-03-23T09:18:43Z

Akhiros: /* Overview */

{{Languages}}
{{sublinks|Main Page}}
[[File:Fff-18-entity-graph.jpg|400px|thumb|'Diagram of entities' (objects on the map) class inheritance structure generated by doxygen. Taken From Friday Facts #18 http://www.factorio.com/blog/post/fff-18]]

Modding is one of Factorios greatest features.

== Getting started ==

A good overview is the [[Mods| list of mods]] or the [http://www.factorioforums.com/forum/index.php Factorio forum].

A good starting point is also the [http://www.factorioforums.com/forum/viewforum.php?f=25 modding-Help-Board]. The community is always answering to concrete questions. Sometimes within minutes. Or you could try the [[Modding FAQ]] page.

== Licensing ==

With v0.11 all mods needs to have a license. If a mod has no license it is assumed to have the a creative commons license: [http://creativecommons.org/licenses/by-nc/4.0 Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)].

See also
* [http://www.factorioforums.com/forum/viewtopic.php?f=6&t=6202&p=48971#p48968 this forum article].
: In this article the devs explain also, that the base-mod (which is part of Factorio) can be used to create new mods, but not used for "outside of Factorio domain".
* http://www.factorio.com/terms-of-service

== Creating a scenario from a saved game (map) ==

An often asked question is how to make a scenario (something which can be edited in the map-editor) from a map:
[http://www.factorioforums.com/forum/viewtopic.php?f=18&t=2844 Factorio can convert them] ([http://www.factorioforums.com/forum/viewtopic.php?f=5&t=3801&p=28289#p28289 see also this post]):
./bin/prod/factorio --map2scenario mapfoo

[[GameClient|More about the client parameters]]

== Creating scenarios with the map-editor ==

Another first step is also making maps with the ingame editor. That stores the map as a '''scenario''', which is just a directory on disk with some files in it. You can look into that files and try to understand, what they are for. Or you can read the following pages:

== Overview ==

* [[Modding overview]]
* [[Prototype definitions]]
* [[Lua/Events|Lua events]]
* [[Lua objects]]
* [[Script interfaces]]
* [[Lua/Data Lifecycle]]
* [[Migration scripts]]
* [[Modding FAQ]]
* [[Modding Tutorial]]

== Other interesting stuff ==

* Tutorial: [http://www.factorioforums.com/forum/viewtopic.php?f=15&t=8613 Create graphics for your mod...], how to generate sprite maps

Modding

2015-03-23T03:53:14Z

Akhiros: /* Overview */

{{Languages}}
{{sublinks|Main Page}}
[[File:Fff-18-entity-graph.jpg|400px|thumb|'Diagram of entities' (objects on the map) class inheritance structure generated by doxygen. Taken From Friday Facts #18 http://www.factorio.com/blog/post/fff-18]]

Modding is one of Factorios greatest features.

== Getting started ==

A good overview is the [[Mods| list of mods]] or the [http://www.factorioforums.com/forum/index.php Factorio forum].

A good starting point is also the [http://www.factorioforums.com/forum/viewforum.php?f=25 modding-Help-Board]. The community is always answering to concrete questions. Sometimes within minutes. Or you could try the [[Modding FAQ]] page.

== Licensing ==

With v0.11 all mods needs to have a license. If a mod has no license it is assumed to have the a creative commons license: [http://creativecommons.org/licenses/by-nc/4.0 Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)].

See also
* [http://www.factorioforums.com/forum/viewtopic.php?f=6&t=6202&p=48971#p48968 this forum article].
: In this article the devs explain also, that the base-mod (which is part of Factorio) can be used to create new mods, but not used for "outside of Factorio domain".
* http://www.factorio.com/terms-of-service

== Creating a scenario from a saved game (map) ==

An often asked question is how to make a scenario (something which can be edited in the map-editor) from a map:
[http://www.factorioforums.com/forum/viewtopic.php?f=18&t=2844 Factorio can convert them] ([http://www.factorioforums.com/forum/viewtopic.php?f=5&t=3801&p=28289#p28289 see also this post]):
./bin/prod/factorio --map2scenario mapfoo

[[GameClient|More about the client parameters]]

== Creating scenarios with the map-editor ==

Another first step is also making maps with the ingame editor. That stores the map as a '''scenario''', which is just a directory on disk with some files in it. You can look into that files and try to understand, what they are for. Or you can read the following pages:

== Overview ==

* [[Modding overview]]
* [[Prototype definitions]]
* [[Lua/Events|Lua events]]
* [[Lua objects]]
* [[Script interfaces]]
* [[Data Lifecycle]]
* [[Migration scripts]]
* [[Modding FAQ]]
* [[Modding Tutorial]]

== Other interesting stuff ==

* Tutorial: [http://www.factorioforums.com/forum/viewtopic.php?f=15&t=8613 Create graphics for your mod...], how to generate sprite maps