Skip to content

feat: commonlib.archive, commonlib.papyrus #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shad0wshayd3 merged 5 commits into from
Sep 3, 2026
Merged

feat: commonlib.archive, commonlib.papyrus #10

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
96a5f79
feat: `commonlib.archive` rule
shad0wshayd3 Aug 31, 2026
69d53ef
feat: `commonlib.papyrus` rule
shad0wshayd3 Aug 31, 2026
055bbe3
fix: `BSArch64` is deprecated as of xEdit 4.1.5q
shad0wshayd3 Aug 31, 2026
5d2a627
Merge branch 'main' into xmake-build-rules
shad0wshayd3 Sep 2, 2026
c5e869f
feat: update `BSArch` args
shad0wshayd3 Sep 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
224 changes: 224 additions & 0 deletions xmake.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -253,3 +253,227 @@ rule("commonlib.plugin", function()
end
end)
end)

rule("commonlib.archive", function()
on_config(function(target)
target:set("kind", "phony")

target:set("targetdir", "$(builddir)/archive")
os.mkdir(target:targetdir())

if not os.getenv("XSE_BSARCH_PATH") then
cprint("${dim}%s missing env XSE_BSARCH_PATH .. ${color.failure}${text.failure}", target:name())
return
end

if not os.exists(path.join(os.getenv("XSE_BSARCH_PATH"), "BSArch.exe")) then
cprint("${dim}%s missing \"%%XSE_BRANCH_PATH%%\\BSArch.exe\" .. ${color.failure}${text.failure}", target:name())
return
end

target:data_set("commonlib.archive.pass", true)
end)

on_build(function(target)
import("core.project.project")

local pass = target:data("commonlib.archive.pass")
if not pass then
cprint("${dim}%s .. failed archive config checks, skipping build", target:name())
return
end

local data = target:data("commonlib.archive.config") or {}
if not data.options then
data.options = {
compress = true,
share = true,
multi_threaded = true
}
end

local suffix = target:data("commonlib.archive.suffix") or ""
local extension = target:data("commonlib.archive.extension") or ".bsa"
local archivename = (data.name or target:name()) .. suffix .. extension
cprint("${dim}archiving %s .. ", archivename)

local tempdir = path.join(os.tmpdir(), "archive", project.name() or "", target:name())
os.tryrm(tempdir)
os.mkdir(tempdir)

local srcfiles, dstfiles = target:extrafiles(tempdir)
if srcfiles and #srcfiles > 0 and dstfiles and #dstfiles > 0 then
for idx, srcfile in ipairs(srcfiles) do
os.trycp(srcfile, dstfiles[idx])
end
else
return
end

local archivedir = path.absolute(target:targetdir())
local archivefile = path.join(archivedir, archivename)
os.tryrm(archivefile)

local args = { "pack", tempdir, archivefile, target:data("commonlib.archive.format") }
if data.options.compress then
if type(data.options.compress) == "boolean" and data.options.compress == true then
table.append(args, "-z")
elseif data.options.compress == "zlib" then
table.append(args, "-z:zlib")
elseif data.options.compress == "lz4" then
table.append(args, "-z:lz4")
elseif data.options.compress == "lz4f" then
table.append(args, "-z:lz4f")
end
end

if data.options.share then
if data.options.shared == true then
table.append(args, "-share:yes")
else
table.append(args, "-share:no")
end
end

if data.options.multi_threaded then
if data.options.multi_threaded == true then
table.append(args, "-mt:yes")
else
table.append(args, "-mt:no")
end
end

if data.options.archive_flags then
table.append(args, format("-af:%s", tostring(data.options.archive_flags)))
end

if data.options.file_flags then
table.append(args, format("-ff:%s", tostring(data.options.file_flags)))
end

os.vrunv(path.join(os.getenv("XSE_BSARCH_PATH"), "BSArch.exe"), args)

if data.install then
local parent = project.target(data.install)
if parent then
parent:add("installfiles", archivefile, { prefixdir = data.installdir or "" })
end
end

cprint("${dim}archiving %s to %s ... ${color.success}${text.success}", archivename, archivedir)
end)

on_install(function(target)
end)
end)

rule("commonlib.papyrus", function()
on_config(function(target)
target:set("kind", "phony")

target:set("targetdir", "$(builddir)/papyrus")
os.mkdir(target:targetdir())

if not os.getenv("XSE_CAPRICA_PATH") then
cprint("${dim}%s missing env XSE_CAPRICA_PATH .. ${color.failure}${text.failure}", target:name())
return
end

if not os.exists(path.join(os.getenv("XSE_CAPRICA_PATH"), "Caprica.exe")) then
cprint("${dim}%s missing \"%%XSE_CAPRICA_PATH%%\\Caprica.exe\" .. ${color.failure}${text.failure}", target:name())
return
end

target:data_set("commonlib.papyrus.pass", true)
end)

on_build(function(target)
import("core.project.project")

local pass = target:data("commonlib.papyrus.pass")
if not pass then
cprint("${dim}%s failed papyrus config checks, skipping build .. ${color.failure}${text.failure}", target:name())
return
end

local data = target:data("commonlib.papyrus.config") or {}
if not data.options then data.options = {} end
cprint("${dim}compiling %s .. ", target:name())

local tempdir = path.join(os.tmpdir(), "papyrus", project.name() or "", target:name())
os.tryrm(tempdir)

local rootdir = path.join(tempdir, "Scripts")
os.mkdir(rootdir)

local srcfiles, dstfiles = target:extrafiles(rootdir)
if srcfiles and #srcfiles > 0 and dstfiles and #dstfiles > 0 then
for idx, srcfile in ipairs(srcfiles) do
os.trycp(srcfile, dstfiles[idx])
end
else
return
end

local args = { tempdir, format("--game=%s", target:data("commonlib.papyrus.game")), "--recurse", "--ignorecwd" }
local imports = { rootdir }
if data.options.imports then
if type(data.options.imports) ~= "table" then
cprint("${dim}%s options.imports is defined, but not a table .. ${color.failure}${text.failure}", target:name())
return
end

for _, import in ipairs(data.options.imports) do
table.append(imports, import)
end
end

if not data.options.skip_default_imports then
local gamevar = target:data("commonlib.papyrus.gamevar")
if not os.getenv(gamevar) then
cprint("${dim}%s missing env %s .. ${color.failure}${text.failure}", target:name(), gamevar)
return
end

local gamepath = os.getenv(gamevar)
local defaults = target:data("commonlib.papyrus.defaults") or {}
for _, default in ipairs(defaults) do
table.append(imports, path.join(gamepath, default))
end
end

table.append(args, format("--import=%s", table.concat(imports, ";")))
table.append(args, format("--flags=%s", target:data("commonlib.papyrus.flags")))

local scriptdir = path.absolute(target:targetdir())
table.append(args, format("--output=%s", scriptdir))

if data.options.optimize then table.append(args, "--optimize") end
if data.options.release then table.append(args, "--release") end
if data.options.final then table.append(args, "--final") end
if data.options.anonymize then table.append(args, "--anonymize") end
if data.options.parallel_compile then table.append(args, "--parallel-compile=1") end
if data.options.strict then table.append(args, "--strict") end
if data.options.language_extensions then table.append(args, "--enable-language-extensions=1") end
os.execv(path.join(os.getenv("XSE_CAPRICA_PATH"), "Caprica.exe"), args)

if data.archive then
local parent = project.target(data.archive)
if parent then
parent:add("extrafiles", format("%s/(**)", scriptdir))
end
end

if data.install then
local parent = project.target(data.install)
if parent then
parent:add("installfiles", format("%s/(**)", scriptdir), { prefixdir = data.installdir or "" })
end
end

cprint("${dim}compiling %s to %s ... ${color.success}${text.success}", target:name(), scriptdir)
end)

on_install(function(target)
end)
end)
Loading