Skip to content

Commit

Permalink
Merge branch 'useropenmwcscfg' into 'master'
Browse files Browse the repository at this point in the history
Adjust intro comment for user openmw-cs.cfg (#5859)

Closes #5859

See merge request OpenMW/openmw!4437
  • Loading branch information
Assumeru committed Oct 31, 2024
2 parents 34b6a9d + e277324 commit 20d9105
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 6 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,7 @@
Feature #8078: OpenMW-CS Terrain Equalize Tool
Feature #8087: Creature movement flags are not exposed
Feature #8145: Starter spell flag is not exposed
Task #5859: User openmw-cs.cfg has comment talking about settings.cfg
Task #5896: Do not use deprecated MyGUI properties
Task #6085: Replace boost::filesystem with std::filesystem
Task #6149: Dehardcode Lua API_REVISION
Expand Down
23 changes: 17 additions & 6 deletions components/settings/parser.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -287,13 +287,24 @@ void Settings::SettingsFileParser::saveSettingsFile(
// exist), start the newly created file with a helpful comment.
if (!existing)
{
ostream << "# This is the OpenMW user 'settings.cfg' file. This file only contains" << std::endl;
const std::string filename = Files::pathToUnicodeString(file.filename());
ostream << "# This is the OpenMW user '" << filename << "' file. This file only contains" << std::endl;
ostream << "# explicitly changed settings. If you would like to revert a setting" << std::endl;
ostream << "# to its default, simply remove it from this file. For available" << std::endl;
ostream << "# settings, see the file 'files/settings-default.cfg' in our source repo or the documentation at:"
<< std::endl;
ostream << "#" << std::endl;
ostream << "# https://openmw.readthedocs.io/en/master/reference/modding/settings/index.html" << std::endl;
ostream << "# to its default, simply remove it from this file." << std::endl;

if (filename == "settings.cfg")
{
ostream << "# For available settings, see the file 'files/settings-default.cfg' in our source repo or the "
"documentation at:"
<< std::endl;
ostream << "#" << std::endl;
ostream << "# https://openmw.readthedocs.io/en/master/reference/modding/settings/index.html" << std::endl;
}
else if (filename == "openmw-cs.cfg")
{
ostream << "# For available settings, see the file 'apps/opencs/model/prefs/values.hpp' in our source repo."
<< std::endl;
}
}

// We still have one more thing to do before we're completely done writing the file.
Expand Down

0 comments on commit 20d9105

Please sign in to comment.