[WIP] User-installable mods, gfx, & sounds #15836

lucianposton · 2016-03-20T01:44:24Z

This patch adds additional directories inside the user's directory from which
to load gfx, sounds, and mods. The use case is that the user wants to install
additional gfx packs, sound packs, and/or mods to the game installed on the
system where the user cannot (or doesn't want to) modify system files e.g.
/usr/share/cataclysm-dda/mods. With this patch, the user can install sound
packs, etc to $XDG_DATA_HOME/cataclysm-dda/data/sound/, etc.

Data from the application's data dir are loaded first and thus take
precendence over user data with duplicate names. The use case is for end users
who want to install additional mods, rather than moders who may have a use
case to override pre-installed data packs and mods to make modifications.

Fixes #16023

remyroy · 2016-03-20T05:12:50Z

This is similar to #14418 if you wanna check.

BevapDin · 2016-03-21T12:59:33Z

src/main.cpp

@@ -349,6 +349,22 @@ int main(int argc, char *argv[])
               FILENAMES["user_dir"].c_str());
        exit(1);
    }
+    if (!assure_dir_exist(FILENAMES["user_datadir"].c_str())) {


assure_dir_exist accepts a std::string, there is no need to call .c_str() here.

Edit: why do those folder need to exists at all?

It makes it easier for the end user to find where to install mods (rather than the extra step of the end user creating the directories himself).

I'll change that to pass a std::string.

This patch adds additional directories inside the user's directory from which to load gfx, sounds, and mods. The use case is that the user wants to install additional gfx packs, sound packs, and/or mods to the game installed on the system where the user cannot (or doesn't want to) modify system files e.g. /usr/share/cataclysm-dda/mods. With this patch, the user can install sound packs, etc to $XDG_DATA_HOME/cataclysm-dda/data/sound/, etc. Data from the application's data dir are loaded first and thus take precendence over user data with duplicate names. The use case is for end users who want to install additional mods, rather than moders who may have a use case to override pre-installed data packs and mods.

kevingranade · 2016-05-05T03:05:32Z

src/path_info.cpp

@@ -158,6 +158,12 @@ void PATH_INFO::set_standard_filenames(void)
    update_pathname("obsolete-mods", FILENAMES["moddir"] + "obsolete-mods.json");
    update_pathname("defaultsounddir", FILENAMES["datadir"] + "sound");

+    // User's data directories
+    update_pathname("user_datadir", FILENAMES["user_dir"] + "data/");
+    update_pathname("user_gfxdir", FILENAMES["user_datadir"] + "gfx/");


The default gfx dir lives under <user_dir>/gfx, not <user_datadir>/gfx, see line 122 in this method. This will break your check in build_tilesets_list() and also cause the creation of a phantom directory in the default install.

The default gfx dir lives under /gfx, not /gfx, see line 122 in this method.

Don't understand this feedback. They are separate directories, and the location of the gfxdir depends on DATA_DIR_PREFIX. 122 puts gfxdir under base_path. 118 puts gfxdir under datadir. This line puts user_gfxdir under user_datadir, mirroring the behavior at 118, except in a user modifiedable directory instead of a system dir.

This will break your check in build_tilesets_list()

Which check?

also cause the creation of a phantom directory in the default install.

That's the idea. It creates a directory that the user can easily locate to install mods. See BevapDin's comment.

Aagh, html formatting strikes again. What I meant to say is with the default install, user_dir is the build directory, and gfx is in that directory, not under data/. As a result, the test for FILENAMES["user_datadir"] != FILENAMES["datadir"] is going to pass when it shouldn't.

Ah, I see. For the case you describe, you have to define neither USE_HOME_DIR nor USE_XDG_DIR.

gfx is the only one that works properly actually, because the paths are different. sound and user_sound (and mod) paths are equivalent; however the strings are different (e.g. "./data/sound" and "data/sound"), causing the string comparison to pass when it shouldn't. I knew those naive string comparisons would fail for path comparisons. :)

I'll see if I can figure out a solution to compare filesystem paths w/o bringing in os-specific code.

Just curious, why even have the option to use the current directory for user_dir? The gentoo ebuild actually had a bug where it could fail to define one of those, causing save games, etc to spill out into current directory (leycec/raiagent#44). Is it just to keep dev save games separate?

I'm confused, because it looks to me like the gfx case is the broken one, it will trigger the "external user dir" behavior even when the game is deployed in the "run from unpacked archive" configuration since the paths don't match, and all you need to do is define that path as FILENAMES ["user_dir"] + "gfx". This difference makes me think we need to be more formal about checking this, we need to write up the expected behavior of each configuration to review the actual behavior against.

Just curious, why even have the option to use the current directory for user_dir?

That's a hilarious question. That is the default, and the dominant way the game is packaged and distributed. Literally everything else is support for secondary packaging. Look at the RELEASE target, it doesn't set any of those flags when building.

all you need to do is define that path as FILENAMES ["user_dir"] + "gfx".

I see what you're saying. What's irking me is that the standard gfx, sound, and mods are in the same dir when a package manager would create a package for this (i.e. by setting PREFIX at compile time). I suppose I could mirror that by conditionally compiling based on DATA_DIR_PREFIX here, as done on line 118.

That's a hilarious question. That is the default, and the dominant way the game is packaged and distributed.

Hmm.. interesting that most people install it that way. I wonder how much that'd change if users had a way to install it via their os's package manager, like in gentoo.

lucianposton · 2016-05-05T16:48:48Z

Going to mark as WIP until I get around to fixing this for the "run from current directory" mode.

mugling · 2016-06-24T17:43:54Z

Closed as appears stalled, can reopen if work resumes

lucianposton force-pushed the user-data-paths branch from 66065ef to 9565e8f Compare March 20, 2016 09:17

BevapDin reviewed Mar 21, 2016
View reviewed changes

lucianposton force-pushed the user-data-paths branch 2 times, most recently from 68d719f to 6078cb4 Compare March 23, 2016 08:35

lucianposton changed the title ~~[WIP][CR] Load additional gfx, sounds, & mods from user directory~~ Load additional gfx, sounds, & mods from user directory Mar 24, 2016

lucianposton force-pushed the user-data-paths branch 3 times, most recently from 821d76e to 265ba3f Compare March 30, 2016 06:27

lucianposton mentioned this pull request Apr 2, 2016

User-installable Mods: Install soundpacks/gfxpacks/mods w/o modifying system files (or compiling) #16023

Closed

lucianposton force-pushed the user-data-paths branch from 265ba3f to 6a2076a Compare April 3, 2016 05:43

lucianposton changed the title ~~Load additional gfx, sounds, & mods from user directory~~ User-installed mods, gfx, & sounds Apr 13, 2016

lucianposton changed the title ~~User-installed mods, gfx, & sounds~~ User-installable mods, gfx, & sounds Apr 14, 2016

lucianposton added 2 commits April 16, 2016 07:08

Remove unnecessary calls to c_str()

8060501

lucianposton force-pushed the user-data-paths branch from 6a2076a to 8060501 Compare April 16, 2016 14:12

lucianposton changed the title ~~User-installable mods, gfx, & sounds~~ [Ready] User-installable mods, gfx, & sounds Apr 20, 2016

kevingranade reviewed May 5, 2016
View reviewed changes

lucianposton changed the title ~~[Ready] User-installable mods, gfx, & sounds~~ [WIP] User-installable mods, gfx, & sounds May 5, 2016

mugling closed this Jun 24, 2016

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] User-installable mods, gfx, & sounds #15836

[WIP] User-installable mods, gfx, & sounds #15836

lucianposton commented Mar 20, 2016

remyroy commented Mar 20, 2016

BevapDin Mar 21, 2016

lucianposton Mar 21, 2016

kevingranade May 5, 2016

lucianposton May 5, 2016

kevingranade May 5, 2016 via email

lucianposton May 5, 2016 •

edited

Loading

kevingranade May 5, 2016 via email

lucianposton May 5, 2016

lucianposton commented May 5, 2016

mugling commented Jun 24, 2016

[WIP] User-installable mods, gfx, & sounds #15836

[WIP] User-installable mods, gfx, & sounds #15836

Conversation

lucianposton commented Mar 20, 2016

remyroy commented Mar 20, 2016

BevapDin Mar 21, 2016

Choose a reason for hiding this comment

lucianposton Mar 21, 2016

Choose a reason for hiding this comment

kevingranade May 5, 2016

Choose a reason for hiding this comment

lucianposton May 5, 2016

Choose a reason for hiding this comment

kevingranade May 5, 2016 via email

Choose a reason for hiding this comment

lucianposton May 5, 2016 • edited Loading

Choose a reason for hiding this comment

kevingranade May 5, 2016 via email

Choose a reason for hiding this comment

lucianposton May 5, 2016

Choose a reason for hiding this comment

lucianposton commented May 5, 2016

mugling commented Jun 24, 2016

lucianposton May 5, 2016 •

edited

Loading