NEED HELP: Creating Custom Game User Settings (CPP)

Development Programming & Scripting
,
1

So I’m trying to create my own Custom Game User Settings.
Cuz Unreal’s default one’s quite an spaghetti code. And I tried to simplify it, using my own structs, and Applying Settings based of Category.

I gotta ask:

  1. Can I make my custom name for the ini of Custom Game User Settings (CndGameUserSettings.ini), and save my Settings there?

  2. What should happen first, when it’s being initialized?
    Like… Validating Settings first, then Loading Them (Applying Defaults)?

Should fetching all supported resolutions and all that be initialized when being initialized too, to determine max values?

  1. If I set the value using this for ex.:
    Does CndGameUserSettings.ini, if it doesn’t exist, gets created?

GConfig->SetInt(*SectionName, *KeyName, Cnd_Version, GGameUserSettingsIni);

2

The short answer is:

  1. Yes you can.
  2. Ini files are loaded on the startup of Unreal Engine. I think they are validated on assignment.
  3. No. If you want to have additional .ini files you have to create them yourself. (not only that but I think you need to have your categories added inside)

Here is the documentation if you need more in-depth answers.

P.S. You can also check this Config Files, Read & Write to Config Files | Unreal Engine Community Wiki for particular exmples.

3

[Unreal Engine 5, File, Config, CSV, Json, Plugin, C++]
(https://www.youtube.com/watch?v=bUDyxA5PZdQ)

4

So… how I can create this custom INI?

With this?

// INITIALIZER CONSTRUCTOR (DEFAULT)
UCndSysSave_UserSettings::UCndSysSave_UserSettings()
{

GGameUserSettingsIni = FPaths::ProjectSavedDir() + TEXT("CndGameUserSettings.ini");

CreateCustomIniFile():

}

void CreateCustomIniFile()
{

	// if (FileExists) {} else {}

	FString CustomFileName = FPaths::ProjectConfigDir() + TEXT("CndGameUserSettings.ini");
	FString SectionName = TEXT("CustomSettings");
	FString KeyName = TEXT("Version");
	int32 Cnd_Version_Initial = 1;

GConfig->SetInt(*SectionName, *KeyName, Cnd_Version_Initial, *CustomFileName);

GConfig->Flush(false, *CustomFileName);

}
5

Oh, by “create them yourself” I meant manually creating a .txt file and changing its name to .ini. (also adding your categories in square brackets and even your initial values)

I guess you can create it runtime but I don’t see why would you you want do that.

6

Did some thinkering… and I think I set it right.

UCndSysSave_UserSettings::UCndSysSave_UserSettings()
{

	Cnd_SetupIniFile();

	BPF_Init_GetMaxSettingsValues();

}

void Cnd_SetupIniFile()
{

	// Set a custom name for the user settings ini file
	FString Cnd_US_FilePath = FPaths::ProjectConfigDir() + TEXT("CndGameUserSettings.ini");	
	GGameUserSettingsIni = Cnd_US_FilePath;

//	UE_LOG(LogTemp, Log, TEXT("Game User Settings will be saved in: %s"), *GGameUserSettingsIni);
	
	bool FileExists = FPlatformFileManager::Get().GetPlatformFile().FileExists(*Cnd_US_FilePath);

	if (!FileExists)
	{

		FString SectionName = TEXT("CndGeneral");
		FString KeyName = TEXT("Version");
		int32 Cnd_Version_Initial = 1;

		// Write the initial version to the custom ini file
		GConfig->SetInt(*SectionName, *KeyName, Cnd_Version_Initial, *Cnd_US_FilePath);

		// Flush changes to disk (this creates the file)
		GConfig->Flush(false, *Cnd_US_FilePath);

		// UE_LOG(LogTemp, Log, TEXT("Custom ini file '%s' created with initial version %d."), *Cnd_US_FilePath, Cnd_Version_Initial);

	}
}
7

I haven’t used FPlatformFileManager but I guess this would work. However, make sure you also set your variables because I don’t think the engine will read the newly created file on this run. (I think you’ll create it after all the .ini files are loaded)