modinfo.lua

-- This file is just for reference.
return {
	-- These fields are mandatory
	name = "Folk Test: Foo bar",
	path = "folk_testmodlulz",
	-- tags = {}, -- Can be an empty table, but not false or nil
	tags = { "Buildings", "Technologies" },
	picture = "thumb.png",
	--picture = false, -- Ignored, not written to .mod file by stlrel
	supported_version = "1.7.*",
	remote_file_id = 123457890,
	--remote_file_id = false, -- Ignored, not written to .mod file by stlrel

	-- This field is required because unless you are the original uploader
	-- of a mod on steam, there's certain things the Stellaris launcher will
	-- error on, for example the picture= property in the .mod file can't
	-- be set.
	-- So stlrel et.al. compare this value to $STELLARIS_UPLOADER_ID, and
	-- if they are not equal, it circumvents the Stellaris Launchers weird
	-- requirements.
	originalUploader = "folk",

	-- These two fields are optional, but .steambb requires .readme
	readme = "test-readme.md", -- best named README.md or readme.md
	steambb = "test.bbcode", -- I usually call it steam.bbcode, but whatever you want
	bbheadinglevel = 2, -- How many #'s to prepend to headings for BB translation, default 2

	-- stlrel uses git-archive, which means that any files in
	-- .gitignore are not included. If you want to include any,
	-- you need to add relative paths here.
	-- This table is optional.
	zip = {
		-- include all absolute files from .gitignore
		-- this does not include empty folders, globs, patterns, or
		-- anything else that luafilesystem does not recognize as mode=file.
		-- this key is optional
		gitignore = true,
		-- can contain relative file paths
		-- this key is optional
		files = {
			"file1.txt",
			"common/on_actions/file2.txt",
		},
	},
	-- You obviously should not include "common" and "localisation" in .exclude.
	-- Files and folders added here will not be copied over to the Paradox Interactive
	-- local mod folder when you run `stlrel --steam`.
	-- The most common things to list are ".git", and possibly if you have a folder
	-- that contains the source files for your graphics, like "3d Models" or "graphics".
	-- Note that the stellaris launcher automatically excludes a lot of files from your
	-- folder anyway, so this isn't "necessary" in any way. It can just help to keep the
	-- size of the mod down.
	exclude = { ".git", "test.bbcode", "test-readme.md", "common", "localisation" }
}

-- path:
-- Should be the same string you enter in the stellaris launchers mod tools as
-- "Directory:", the second text field under Create Mod.
-- In a local mods .mod file, this usually looks like path="mod/mymoddirectory",
-- which means you should set path = "mymoddirectory" in this file.

-- steambb:
-- This file should contain the bbcode for the addons steam workshop description,
-- if you want this to be added to the readme file automatically.
-- Note that we don't support nested [list] or [olist] within themselves, because
-- the parser is stupid at the moment.

-- readme:
-- The file stlrel should update when steambb has changed since the
-- last pushed tag.
-- Content from the steambb file will be translated to markdown and inserted
-- between these markers in the readme:
-- [//]: # (start)
-- [//]: # (stop)
-- Please make sure there is a clear newline before, between, and after both.