plugins: Allow plugins to customize their log colors (#823)

Allows plugins to specify a custom colour for their indicator in the logs
R2Northstar · Oct 14, 2024 · 27e1711 · 27e1711
1 parent 42d9702
commit 27e1711
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/primedev/plugins/interfaces/IPluginId.h b/primedev/plugins/interfaces/IPluginId.h
@@ -18,6 +18,7 @@ enum class PluginString : int
 enum class PluginField : int
 {
 	CONTEXT = 0,
+	COLOR = 1,
 };
 
 // an interface that is required from every plugin to query data about it

diff --git a/primedev/plugins/plugins.cpp b/primedev/plugins/plugins.cpp
@@ -23,6 +23,7 @@ bool isValidSquirrelIdentifier(std::string s)
 
 Plugin::Plugin(std::string path)
 	: m_location(path)
+	, m_logColor(NS::Colors::PLUGIN)
 {
 	HMODULE pluginModule = GetModuleHandleA(path.c_str());
 
@@ -69,6 +70,13 @@ Plugin::Plugin(std::string path)
 	m_runOnServer = context & PluginContext::DEDICATED;
 	m_runOnClient = context & PluginContext::CLIENT;
 
+	int64_t logColor = m_pluginId->GetField(PluginField::COLOR);
+	// Apply custom colour if plugin has specified one
+	if ((logColor & 0xFFFFFF) != 0)
+	{
+		m_logColor = Color((int)(logColor & 0xFF), (int)((logColor >> 8) & 0xFF), (int)((logColor >> 16) & 0xFF));
+	}
+
 	if (!name)
 	{
 		NS::log::PLUGINSYS->error("Could not load name of plugin at '{}'", path);
@@ -105,7 +113,7 @@ Plugin::Plugin(std::string path)
 		return;
 	}
 
-	m_logger = std::make_shared<ColoredLogger>(m_logName, NS::Colors::PLUGIN);
+	m_logger = std::make_shared<ColoredLogger>(m_logName, m_logColor);
 	RegisterLogger(m_logger);
 
 	if (IsDedicatedServer() && !m_runOnServer)

diff --git a/primedev/plugins/plugins.h b/primedev/plugins/plugins.h
@@ -20,6 +20,7 @@ class Plugin
 	std::string m_location; // path of the dll
 	bool m_runOnServer;
 	bool m_runOnClient;
+	Color m_logColor;
 
 public:
 	HMODULE m_handle;