Texturepack toolkit

[y.petremann]

You want to make a texture pack for Factorio, you don't want to edit base files and you'd like to be able to install it easily ? Here is the texturepack toolkit, it permit to make a texture pack inside a mod, no need of programming skill.

Files

texturepack_toolkit.lua :

Code: Select all

function findmodname()
  -- find the current mod name
  return debug.getinfo(2, "S").source:sub(2):match("(.*)/")
end

function prequire(f)
  -- protected variant of require
  local s,e=pcall(function()require(f)end)
  if not s then
    if type(value)=="string" then
      print(f..":"..e)
    else
      print(f..": can't load "..findmodname().."/"..string.gsub(f, "%.", "/")..".lua")
    end
  end
end

function patch()
  -- apply texturepack
  local function foreach(d,g,t,n,p,i) 
    if d[n]~=nil then 
      if type(d[n])=="function" then d[n](n,p,i) else p[i]=d[n] end
    end 
    if type(t)=="table" then 
      for k,v in pairs(t) do foreach(d,g,v,n.."."..k,t,k) end 
    elseif type(t)=="string" then 
      if g[t]~=nil then
        if type(g[t])=="function" then g[t](n,p,i) else p[i]=g[t] end
      end
    end
  end
  foreach(overwrite_data,overwrite_graphics,data.raw,"data.raw")
end

overwrite_data = {}
overwrite_graphics = {}
modname = findmodname()

------ Methods updating texture list ------
function merge(t1,t2)
  -- extend table with content based on key
  for k,v in pairs(t2) do
    t1[k]=v
  end
end

function update(t1,t2)
  -- update already defined key only
  for k,v in pairs(t2) do
    if t1[k] ~= nil then t1[k]=v end
  end
end

------ patching methods ------
function replace(r)
  --replace the texture with the new version and apply modifications on neighbors keys
  return function(n,p,i)
    p[i]=string.gsub(p[i],"(__[a-zA-Z0-9]+__)",findmodname().."/%1")
    if r ~= nil then
      for k,v in pairs(r) do
        p[k]=v
      end
    end
  end
end

function neighbors(r)
  --apply modifications on neighbors keys
  return function(n,p,i)
    if r ~= nil then
      for k,v in pairs(r) do
        p[k]=v
      end
    end
  end
end

function combine(r)
  --apply multiple patching methods
  return function(n,p,i)
    if r ~= nil then
      for _,v in pairs(r) do
        v(n,p,i)
      end
    end
  end
end

function fix(k,t)
  --change a value by those indicated
  return function(n,p,i)
    if t[p[k]] ~= nil then
      p[k]=t[p[k]]
    end
  end
end

update.lua :

Code: Select all

require("lfs")
function script_path()
  return debug.getinfo(2, "S").source:sub(2):match("(.*/)")
end

function dirtree(dir)
  assert(dir and dir ~= "", "directory parameter is missing or empty")
  if string.sub(dir, -1) == "/" then
    dir=string.sub(dir, 1, -2)
  end
  local function yieldtree(dir)
    for entry in lfs.dir(dir) do
      if entry ~= "." and entry ~= ".." then
        entry=dir.."/"..entry
        local attr=lfs.attributes(entry)
        coroutine.yield(entry,attr)
        if attr.mode == "directory" then
          yieldtree(entry)
        end
      end
    end
  end
  return coroutine.wrap(function() yieldtree(dir) end)
end

dir = script_path()
f=io.open(dir.."config.lua", "w")
f:write("merge(overwrite_graphics,{\n")
for filename, attr in dirtree(dir) do
  if filename:sub(-4) == ".png" then
    f:write("  [\""..filename:gsub(dir:gsub("%-","%%-"),"").."\"]=replace{},\n")
  end
end
f:write("})")

data.lua :

Code: Select all

require("texturepack_toolkit")

prequire("config")

patch()

Create a texture pack

There is 3 things to know about factorio and the toolkit :

• Factorio keep a cache that is related to textures named crop-cache.dat, if something is wrong, remove it and restart the game.
• Factorio don't let scripts listing folders, so this toolkit add a lua file named update.lua that list the mod folder and save the result in config.lua.
• Factorio consider texturepack mods (only texture modification, nothing else) as mods that need synchronisation, if you use it on a server, all other players need to use it.

Easy version :
Simply put textures inside the mod like that :
Original file :__base__/graphics/icons/iron-plate.png
Your file :__yourmod__/__base__/graphics/icons/iron-plate.png
Then start update.lua
You can't resize textures by this way, you need to go to hard version if you want to resize textures ...

Hard version :
Additionnaly to the easy version, you need to look at the code of factorio to add some important lines after prequire("config") and before patch(), Here an example for the textures of the stone-furnace on the graphic wiki :

Code: Select all

merge(overwrite_graphics,{
  ["__base__/graphics/entity/stone-furnace/stone-furnace.png"]=replace{width=91,height=69},
  ["__base__/graphics/entity/stone-furnace/stone-furnace-fire.png"]=replace{width = 25,height = 24},
})

Use a texture pack

Any texture pack is in fact a mod, so simply put the zip in the mod folder.
If you update a mod, it should be needed to remove crop-cache.dat ...

[FreeER]

Does anyone know how to do that ?

none of these are possible as far as I know. sorry

[Dark]

Done something like that. You can't guess mod's name that you are not aware of and you can't have any read access to the filesystem from game, and I'm not sure why would you need one.
If need to know what textures you have then simply list them in a constant (table), you can also use external script to generate that list.

If you're making a texture pack for another mod then you must know that mod's name in advance (and input it as optional dependency in info.json ), otherwise your pack can load before the other mod and you would not be able to override anything, because by that moment there is nothing yet exists in data.raw.

[y.petremann]

Done something like that. You can't guess mod's name that you are not aware of and you can't have any read access to the filesystem from game, and I'm not sure why would you need one.

For now I think I could put the mod name in a constant, it's only to have __mymod__ easily configurable.

If need to know what textures you have then simply list them in a constant (table), you can also use external script to generate that list.

One of my aim was to generate the two top tables before aplying them so no problem, that really a problem to not have filesystem access because for my case, I simply put files I'm modifying in the graphics folder and would like to not stop factorio from loading because of a missing file.

If you're making a texture pack for another mod then you must know that mod's name in advance (and input it as optional dependency in info.json ), otherwise your pack can load before the other mod and you would not be able to override anything, because by that moment there is nothing yet exists in data.raw.

I know that but thanks for the advice.

[y.petremann]

For my factocad and updated graphics mods, I have found a lot of things.

Firstly, finding the current mod name (or more precisely mod prefix) is possible ... throught error handling :

Code: Select all

function findmodname()
  local _,errormsg = pcall(function() _G() end)
  return string.sub(errormsg,3,string.find(errormsg, "__/", 3)-1)
end

Secondly we can't verify if a file is present for now, but with the help of some external script to write in a config file a list of files added by the texture pack, this is quite possible. The only thing to consider is that when developing the texture pack mod, you need to execute this utility script before each factorio start or each release, and that config file need to be bundled with the texture pack mod.