Skip to content

Implement ForceAffinity client option and set process priority from high to above normal #7160

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

Open
lL1l1 wants to merge 6 commits into
base: develop
Choose a base branch
from
Open

Implement ForceAffinity client option and set process priority from high to above normal #7160

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c1c706d
Set process priority from high to above normal
lL1l1 Jun 22, 2026
f1a7ba7
Implement ForceAffinity client option
lL1l1 Jun 22, 2026
a1fe0e9
Put copyable sections of inits into regions
lL1l1 Jun 22, 2026
5989274
Copy copyable section to other init files
lL1l1 Jun 30, 2026
2a20d37
Create fix.7160.md
lL1l1 Jun 30, 2026
4af9b9d
Merge branch 'develop' into fix/init-file-ecores
lL1l1 Jun 30, 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
3 changes: 3 additions & 0 deletions changelog/snippets/fix.7160.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
- (#7160) Fix turning off the "force affinity" client option not disabling adjustment of process affinity.

- (#7160) Set process priority to "above normal" instead of "high" to prevent game freezes from freezing the functionality or UI of other programs.
55 changes: 30 additions & 25 deletions init.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- START OF COPY --
--#region START OF COPY

-- in an ideal world this file would be loaded (using dofile) by the other
-- initialisation files to prevent code duplication. However, as it stands
Expand Down Expand Up @@ -36,39 +36,44 @@ if SetProcessPriority and GetProcessAffinityMask and SetProcessAffinityMask then

-- priority values can be found at:
-- - https://learn.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-setpriorityclass
local success = SetProcessPriority(0x00000080)
local success = SetProcessPriority(0x00008000)
if success then
LOG("Process - priority set to: 'high'")
LOG("Process - priority set to: 'above normal'")
else
LOG("Process - Failed to adjust process priority, this may impact your framerate")
end

-- affinity values acts like a bit mask, we retrieve the mask and shift it if we think there are sufficient computing units
local success, processAffinityMask, systemAffinityMask = GetProcessAffinityMask();
if success then
-- system has 24 (logical) computing units or more, skip the first two computing units and all cores beyond the first 24. We need
-- to do this because of floating point imprecision - we simply can't deduct a few digits to prevent using the first two cores
if systemAffinityMask >= 16777215 then
processAffinityMask = 16777212 -- 2 ^ 24 - 3 - 1

-- system has 6 (logical) computing units or more, skip first two computing units
elseif (systemAffinityMask >= 63) then
processAffinityMask = systemAffinityMask - 3 -- (2 ^ 6 - 1) - 3
end

-- update the afinity mask
if processAffinityMask != systemAffinityMask then
local success = SetProcessAffinityMask(processAffinityMask);
if success then
LOG("Process - affinity set to: " .. tostring(processAffinityMask))
local forceAffinity = ForceAffinity == "true"
if forceAffinity then
-- affinity values acts like a bit mask, we retrieve the mask and shift it if we think there are sufficient computing units
local success, processAffinityMask, systemAffinityMask = GetProcessAffinityMask();
if success then
-- system has 24 (logical) computing units or more, skip the first two computing units and all cores beyond the first 24. We need
-- to do this because of floating point imprecision - we simply can't deduct a few digits to prevent using the first two cores
if systemAffinityMask >= 16777215 then
processAffinityMask = 16777212 -- 2 ^ 24 - 3 - 1

-- system has 6 (logical) computing units or more, skip first two computing units
elseif (systemAffinityMask >= 63) then
processAffinityMask = systemAffinityMask - 3 -- (2 ^ 6 - 1) - 3
end

-- update the afinity mask
if processAffinityMask != systemAffinityMask then
local success = SetProcessAffinityMask(processAffinityMask);
if success then
LOG("Process - affinity set to: " .. tostring(processAffinityMask))
else
LOG("Process - Failed to adjust the process affinity, this may impact your framerate")
end
else
LOG("Process - Failed to adjust the process affinity, this may impact your framerate")
LOG("Process - Failed to update the process affinity, this may impact your framerate")
end
else
LOG("Process - Failed to update the process affinity, this may impact your framerate")
LOG("Process - Failed to retrieve the process affinity, this may impact your framerate")
end
else
LOG("Process - Failed to retrieve the process affinity, this may impact your framerate")
LOG("Process - Process affinity adjustment is disabled in client settings, this may impact your framerate")
end
else
LOG("Process - Failed to find process priority and affinity related functions, this may impact your framerate")
Expand Down Expand Up @@ -581,7 +586,7 @@ local function LoadVaultContent(path)
MountModContent(path .. '/mods')
end

-- END OF COPY --
--#endregion END OF COPY

-- -- minimum viable shader version - should be bumped to the next release version when we change the shaders
-- local minimumShaderVersion = 3745
Expand Down
113 changes: 53 additions & 60 deletions init_faf.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
-- START OF COPY --
--#region START OF COPY

-- in an ideal world this file would be loaded (using dofile) by the other
-- initialisation files to prevent code duplication. However, as it stands
Expand Down Expand Up @@ -36,40 +36,44 @@ if SetProcessPriority and GetProcessAffinityMask and SetProcessAffinityMask then

-- priority values can be found at:
-- - https://learn.microsoft.com/en-us/windows/win32/api/processthreadsapi/nf-processthreadsapi-setpriorityclass
local success = SetProcessPriority(0x00000080)
local success = SetProcessPriority(0x00008000)
if success then
LOG("Process - priority set to: 'high'")
LOG("Process - priority set to: 'above normal'")
else
LOG("Process - Failed to adjust process priority, this may impact your framerate")
end

-- affinity values acts like a bit mask, we retrieve the mask and
-- shift it if we think there are sufficient computing units
local success, processAffinityMask, systemAffinityMask = GetProcessAffinityMask();
if success then
-- system has 24 (logical) computing units or more, skip the first two computing units and all cores beyond the first 24. We need
-- to do this because of floating point imprecision - we simply can't deduct a few digits to prevent using the first two cores
if systemAffinityMask >= 16777215 then
processAffinityMask = 16777212 -- 2 ^ 24 - 3 - 1

-- system has 6 (logical) computing units or more, skip first two computing units
elseif (systemAffinityMask >= 63) then
processAffinityMask = systemAffinityMask - 3 -- (2 ^ 6 - 1) - 3
end

-- update the afinity mask
if processAffinityMask != systemAffinityMask then
local success = SetProcessAffinityMask(processAffinityMask);
if success then
LOG("Process - affinity set to: " .. tostring(processAffinityMask))
local forceAffinity = ForceAffinity == "true"
if forceAffinity then
-- affinity values acts like a bit mask, we retrieve the mask and shift it if we think there are sufficient computing units
local success, processAffinityMask, systemAffinityMask = GetProcessAffinityMask();
if success then
-- system has 24 (logical) computing units or more, skip the first two computing units and all cores beyond the first 24. We need
-- to do this because of floating point imprecision - we simply can't deduct a few digits to prevent using the first two cores
if systemAffinityMask >= 16777215 then
processAffinityMask = 16777212 -- 2 ^ 24 - 3 - 1

-- system has 6 (logical) computing units or more, skip first two computing units
elseif (systemAffinityMask >= 63) then
processAffinityMask = systemAffinityMask - 3 -- (2 ^ 6 - 1) - 3
end

-- update the afinity mask
if processAffinityMask != systemAffinityMask then
local success = SetProcessAffinityMask(processAffinityMask);
if success then
LOG("Process - affinity set to: " .. tostring(processAffinityMask))
else
LOG("Process - Failed to adjust the process affinity, this may impact your framerate")
end
else
LOG("Process - Failed to adjust the process affinity, this may impact your framerate")
LOG("Process - Failed to update the process affinity, this may impact your framerate")
end
else
LOG("Process - Failed to update the process affinity, this may impact your framerate")
LOG("Process - Failed to retrieve the process affinity, this may impact your framerate")
end
else
LOG("Process - Failed to retrieve the process affinity, this may impact your framerate")
LOG("Process - Process affinity adjustment is disabled in client settings, this may impact your framerate")
end
else
LOG("Process - Failed to find process priority and affinity related functions, this may impact your framerate")
Expand All @@ -78,6 +82,10 @@ end
--#endregion

-- upvalued performance
local dofile = dofile

local StringFind = string.find
local StringGsub = string.gsub
local StringSub = string.sub
local StringLower = string.lower

Expand Down Expand Up @@ -118,21 +126,6 @@ local function LowerHashTable(t)
return o
end

local function FindFilesWithExtension(dir, extension, prepend, files)
files = files or { }

for k, file in IoDir(dir .. "/*") do
if not (file == '.' or file == '..') then
if StringSub(file, -3) == extension then
TableInsert(files, prepend .. "/" .. file)
end
FindFilesWithExtension(dir .. "/" .. file, extension, prepend .. "/" .. file, files)
end
end

return files
end

-- mods that have been integrated, based on folder name
local integratedMods = { }
integratedMods["nvidia fix"] = true
Expand Down Expand Up @@ -209,8 +202,8 @@ allowedAssetsScd = LowerHashTable(allowedAssetsScd)

-- default wave banks to prevent collisions
local soundsBlocked = { }
local sounds = FindFilesWithExtension(fa_path .. '/sounds', "xwb", "/sounds")
for k, v in sounds do
local faSounds = IoDir(fa_path .. '/sounds/*')
for k, v in faSounds do
if v == '.' or v == '..' then
continue
end
Expand Down Expand Up @@ -365,16 +358,16 @@ local function MountMapContent(dir)
MountDirectory(dir .. "/" .. map .. '/movies', '/movies')
end
elseif folder == 'sounds' then
local banks = FindFilesWithExtension(dir .. '/' .. map .. "/sounds", "xwb", "/sounds")

-- find conflicting files
local conflictingFiles = { }
for _, bank in banks do
local identifier = StringLower(bank)
if soundsBlocked[identifier] then
TableInsert(conflictingFiles, { file = bank, conflict = soundsBlocked[identifier] })
else
soundsBlocked[identifier] = StringLower(map)
for _, file in IoDir(dir .. '/' .. map .. '/sounds/*') do
if not (file == '.' or file == '..') then
local identifier = StringLower(file)
if soundsBlocked[identifier] then
TableInsert(conflictingFiles, { file = file, conflict = soundsBlocked[identifier] })
else
soundsBlocked[identifier] = StringLower(map)
end
end
end

Expand Down Expand Up @@ -542,23 +535,23 @@ local function MountModContent(dir)

-- if we found a directory named 'sounds' then we mount its content
if folder == 'sounds' then
local banks = FindFilesWithExtension(dir .. '/' .. mod .. "/sounds", "xwb", "/sounds")

-- find conflicting files
local conflictingFiles = { }
for _, bank in banks do
local identifier = StringLower(bank)
if soundsBlocked[identifier] then
TableInsert(conflictingFiles, { file = bank, conflict = soundsBlocked[identifier] })
else
soundsBlocked[identifier] = StringLower(mod)
for _, file in IoDir(dir .. '/' .. mod .. '/sounds/*') do
if not (file == '.' or file == '..') then
local identifier = StringLower(file)
if soundsBlocked[identifier] then
TableInsert(conflictingFiles, { file = file, conflict = soundsBlocked[identifier] })
else
soundsBlocked[identifier] = StringLower(mod)
end
end
end

-- report them if they exist and do not mount
if TableGetn(conflictingFiles) > 0 then
LOG("Found conflicting sound banks for mod: '" .. mod .. "', cannot mount the sound bank(s):")
for _, v in conflictingFiles do
for k, v in conflictingFiles do
LOG(" - Conflicting sound bank: '" .. v.file .. "' of mod '" .. mod .. "' is conflicting with a sound bank from: '" .. v.conflict .. "'" )
end
-- else, mount folder
Expand Down Expand Up @@ -593,7 +586,7 @@ local function LoadVaultContent(path)
MountModContent(path .. '/mods')
end

-- END OF COPY --
--#endregion END OF COPY

-- minimum viable shader version - should be bumped to the next release version when we change the shaders
local minimumShaderVersion = 3759
Expand Down
Loading