Added custom splash files!

Author: AlphiiGD

README.md

@@ -0,0 +1,40 @@
+# Splash Text!
+This is a simple mod that adds some splash text like in Minecraft to your GD main menu!
+
+# Creating Custom Splashes
+To create custom splashes, create a file somewhere and give it
+the file extension `.splash`, `.txt`, or `.text`. Making a splash
+is as simple as just writing one per line. However, there are some
+additional features which may help you in writing cooler splashes.
+
+> [!WARNING]
+> Only ASCII characters supported by `goldFont.fnt` are supported and
+> **invalid characters will result in the file failing to be parsed.**
+> If your file is failing to parse, the reason why will be outputted
+> as an error in the developer console.
+
+## Comments
+You can add comments to the file which will be ignored by the mod.
+To make one you simply type a hashtag `#` and all characters after it will
+be ignored.
+
+```
+I'm a custom splash!
+# This is a comment!
+
+I have an inline comment! # Hello, world!
+```
+
+- The first line will be unmodified.
+- The second line will be ignored.
+- The third line will be ignored.
+- The fourth line will be stripped of its inline comment.
+
+## Macros
+Additionally, there are some special macros you can use. These can
+add some special flair to your splashes.
+| Macro | Description |
+| ----- | ----------- |
+| \_\_LINE\_\_ | The line number in the file |
+| \_\_PLAYER\_USERNAME\_\_ | The GD account username of the user |
+| \_\_RANDOM\_\_ | Random number between 0 and 100 |

changelog.md

@@ -1,3 +1,9 @@
+# 1.1.0
+- Users can now create their own splashes!
+
+# 1.0.3
+- Fixed newline parsing
+
 # 1.0.2
 - Updated Geode SDK to 4.6.1
 

mod.json

@@ -8,12 +8,40 @@
 	},
 	"id": "alphii.gd-splash-text",
 	"name": "Splash Text!",
-	"version": "v1.0.2",
+	"version": "v1.1.0",
 	"developer": "Alphii",
 	"description": "",
+	"tags": ["enhancement", "offline"],
+	"links": {
+		"community": "https://discord.gg/tVPtwJexSX",
+		"source": "https://github.com/AlphiiGD/Splash-Text"
+	},
 	"resources": {
 		"files": [
 			"resources/*.splash"
 		]
+	},
+	"settings": {
+		"extra-splash-file": {
+			"type": "file",
+			"name": "Extra Splashes",
+			"description": "Additional splash texts, one per line. Restart your game to apply. See more info about writing these on the GitHub page!",
+			"requires-restart": true,
+			"default": {
+				"win": "",
+				"mac": "",
+				"android": "",
+				"ios": "{gd_dir}/Clubstep.mp3"
+			},
+			"control": {
+				"dialog": "open",
+				"filters": [
+					{
+						"files": ["*.splash", "*.txt", "*.text"],
+						"description": "Splash files."
+					}
+				]
+			}
+		}
 	}
 }

resources/splash.splash

@@ -3,13 +3,13 @@ Mod by Alphii!
 Also try The Impossible Game!
 What's your hardest?
 Over 9000 Stars!
-This splash text message is very long and at line 6 in the file!
+This splash text message is very long and at line __LINE__ in the file!
 rust sucks
 Look! Creator points!
 As seen on YouTube!
 Uses OpenGL!
 Yaaay!
-you are fuck map
+"Unlock new icons and colors by completing achievements!"
 Closed source!
 Open source!
 4,294,967,296 colors!
@@ -68,4 +68,8 @@ Jump up, jump up, and get down!
 IDDQD
 impulse 101
 swpreme
-Good luck Doggie!
+Good luck Doggie!
+__PLAYER_USERNAME__ is you!
+You are __RANDOM__% complete!
+Unlock icons from achievements!
+Triple Spikes!

src/MenuLayer.cpp

@@ -21,9 +21,22 @@ class $modify(ST_MenuLayer, MenuLayer)
 			return false;
 		}
 
-		if (!m_fields->m_SplashRead) m_fields->m_SplashRead = new SplashRead("splash.splash");
+		if (!m_fields->m_SplashRead)
+		{
+			m_fields->m_SplashRead = new SplashRead();
+			if (!m_fields->m_SplashRead->loadFile(Mod::get()->getResourcesDir() / "splash.splash"))
+			{
+				log::error("Failed to load file {}", Mod::get()->getResourcesDir() / "splash.splash");
+			}
+
+			auto extraPath = Mod::get()->getSettingValue<std::filesystem::path>("extra-splash-file");
+			if (!extraPath.empty() && !m_fields->m_SplashRead->loadFile(extraPath))
+			{
+				log::error("Failed to load file {}", extraPath.string());
+			}
+		}
 		m_fields->m_SplashStr = m_fields->m_SplashRead->getRandomLine();
-		auto mainTitle = getChildByID("main-title");
+		auto mainTitle = getChildByIDRecursive("main-title");
 
 		m_fields->m_SplashText = ScalingLabel::create(m_fields->m_SplashStr.c_str(), "goldFont.fnt");
 		m_fields->m_SplashText->setScale(0.5f / (1.0f + 0.05f * strlen(m_fields->m_SplashText->getLabel()->getString())));

src/SplashRead.cpp

@@ -4,11 +4,14 @@
 using namespace geode::prelude;
 
 // Loads the file into a std::vector<string>, returns false if it fails.
-bool SplashRead::loadFile()
+bool SplashRead::loadFile(std::filesystem::path filePath)
 {
+	if (filePath.empty()) return false;
+
+	m_FileStream.open(filePath);
 	if (!m_FileStream.is_open())
 	{
-		log::error("Attempting to load a file from unopened stream!");
+		log::error("File failed to open! May not exist!");
 		return false;
 	}
 
@@ -45,53 +48,51 @@ bool SplashRead::loadFile()
 				continue;
 			}
 		}
+		
+		// Replace __LINE__ with the line number
+		std::string lineMacro = "__LINE__";
+		if (size_t pos = line.find(lineMacro);
+			pos != std::string::npos)
+		{
+			line.replace(pos, lineMacro.length(), std::to_string(lineNum));
+		}
+
+		// Replace __PLAYER_USERNAME__ with player name
+		std::string playerMacro = "__PLAYER_USERNAME__";
+		if (size_t pos = line.find(playerMacro);
+			pos != std::string::npos)
+		{
+			line.replace(pos, playerMacro.length(), GJAccountManager::get()->m_username);
+		}
 
-		// Non-alphanumeric characters are not allowed, if we see one, we fail.
 		// Algorithm provided by undefined06855 on Discord and Git
+		std::string trimmedLine;
+		trimmedLine.reserve(line.length());
 		for (int i = 0; i < line.length(); i++)
 		{
-			if (line[i] == '\0') continue;
-			if (line[i] < ' ' || line[i] > '~')
-			{
-				if (line[i] != '\n' && line[i] != '\r')
-				{
-					log::error("Non-alphanumeric character detected at col {} of line {}", i + 1, lineNum);
-					return false;
-				}
-			}
+			if (line[i] == '\0' || line[i] == '\n' || line[i] == '\r' || line[i] < ' ' || line[i] > '~') continue;
+			trimmedLine += line[i];
 		}
 
 		// If our file stream fails during loading then we gotta return false
 		if (m_FileStream.fail())
 		{
 			log::error("File stream failed during load.");
+			m_FileStream.close();
 			return false;
 		}
 
 		// Finally we can push back our processed string
-		m_Lines.push_back(line);
+		m_Lines.push_back(trimmedLine);
 		lineNum++;
 	}
 
+	m_FileStream.close();
 	return true;
 }
 
-SplashRead::SplashRead(std::string filePath)
+SplashRead::SplashRead()
 {
-	m_FileStream.open(Mod::get()->getResourcesDir() / filePath);
-	if (m_FileStream.fail())
-	{
-		log::error("Failed to open file {}", Mod::get()->getResourcesDir() / filePath);
-		m_FileStream.close();
-	}
-	
-	if (!loadFile())
-	{
-		log::error("Failed to load file {}", filePath);
-		m_Lines.clear();
-	}
-
-	m_FileStream.close();
 }
 
 std::string SplashRead::getRandomLine()
@@ -105,5 +106,17 @@ std::string SplashRead::getRandomLine()
 	std::random_device rd;
     std::mt19937 gen(rd());
     std::uniform_int_distribution<> dis(0, m_Lines.size() - 1);
-	return m_Lines[dis(gen)];
+
+	std::string selected = m_Lines[dis(gen)];
+	std::string splashText(selected); // Copy to avoid modifying original
+	
+	std::string randMacro = "__RANDOM__";
+	if (size_t pos = splashText.find(randMacro);
+		pos != std::string::npos)
+	{
+		std::uniform_int_distribution<> dis0_100(0, 100);
+		splashText.replace(pos, randMacro.length(), std::to_string(dis0_100(gen)));
+	}
+
+	return splashText;
 }

src/SplashRead.hpp

@@ -8,8 +8,8 @@ class SplashRead
 private:
 	std::ifstream m_FileStream;
 	std::vector<std::string> m_Lines;
-	bool loadFile();
 public:
-	SplashRead(std::string filePath);
+	bool loadFile(std::filesystem::path filePath);
+	SplashRead();
 	std::string getRandomLine();
 };