Skip to content

Support modern locations for configuration files for Unix (XDG_CONFIG_HOME and ~/.config/) #41

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

Draft
Ma11ock wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Support modern locations for configuration files for Unix (XDG_CONFIG_HOME and ~/.config/) #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions fs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1903,6 +1903,18 @@ static int FS_ChooseUserDir(userdirmode_t userdirmode, char *userdir, size_t use
if(homedir)
{
dpsnprintf(userdir, userdirsize, "%s/.%s/", homedir, gameuserdirname);
#if defined(__unix__) || defined(__unix)
// Check for darkplaces config paths in this order: ~/.darkplaces, XDG_CONFIG_HOME/darkplaces, ~/.config/darkplaces.
Copy link
Contributor

@divVerent divVerent Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This encodes a preference order. It prefers ~/.darkplaces if it exists, but creates ~/.config/darkplaces if nothing exists. Please explain this in the comment.

if(access(userdir, F_OK) != 0)
{
// Check if XDG_CONFIG_HOME exists, test if absolute path.
const char *xdgconfdir = getenv("XDG_CONFIG_HOME");
Copy link
Contributor

@divVerent divVerent Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that XDG_CONFIG_HOME may be put on version control, and thus is not appropriate for in particular the dlcache subdirectory.

Any chance that can be fixed first?

Copy link
Contributor

@divVerent divVerent Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Failing that, I guess ~/.local/share/darkplaces won't be wrong, but also not substantially better.

if(xdgconfdir && xdgconfdir[0] == '/')
dpsnprintf(userdir, userdirsize, "%s/%s/", xdgconfdir, gameuserdirname);
else
dpsnprintf(userdir, userdirsize, "%s/.config/%s/", homedir, gameuserdirname);
}
#endif
break;
}
return -1;
Expand Down