Key Guide & Pause Menu

CMakeLists.txt

@@ -91,6 +91,7 @@ add_executable(waveforge
 	src/items/water.cpp
 	src/items/oil.cpp
 	src/scenes/duckdeath.cpp
+	src/scenes/help.cpp
 	src/scenes/level_menu.cpp
 	src/scenes/level_switch.cpp
 	src/scenes/level.cpp

assets/manifest.json

@@ -435,6 +435,24 @@
 			"input": "ui/level-link/raw",
 			"description": "Creating level link texture"
 		},
+		{
+			"id": "ui/help/raw",
+			"type": "image",
+			"file": "ui/help.png",
+			"description": "Loading help background image"
+		},
+		{
+			"id": "ui/help",
+			"type": "create-texture",
+			"input": "ui/help/raw",
+			"description": "Creating help background texture"
+		},
+		{
+			"id": "ui-config/help",
+			"type": "json",
+			"file": "ui/help.json",
+			"description": "Loading help UI configuration"
+		},
 		{
 			"id": "ui-config/level-menu",
 			"type": "json",

assets/ui/help.json

@@ -0,0 +1,4 @@
+{
+	"width": 256,
+	"height": 192
+}

assets/ui/main-menu.json

@@ -19,53 +19,22 @@
 		"play": {
 			"x": 72,
 			"y": 80,
-			"size": 2,
-			"color": [
-				0,
-				0,
-				0,
-				200
-			],
-			"active-color": [
-				207,
-				158,
-				9,
-				255
-			]
+			"size": 2
 		},
 		"settings": {
 			"x": 72,
 			"y": 104,
-			"size": 2,
-			"color": [
-				0,
-				0,
-				0,
-				200
-			],
-			"active-color": [
-				207,
-				158,
-				9,
-				255
-			]
+			"size": 2
 		},
-		"exit": {
+		"help": {
 			"x": 72,
 			"y": 128,
-			"size": 2,
-			"color": [
-				0,
-				0,
-				0,
-				200
-			],
-			"active-color": [
-				207,
-				158,
-				9,
-				255
-			]
+			"size": 2
+		},
+		"exit": {
+			"x": 72,
+			"y": 152,
+			"size": 2
 		}
 	}
 }

assets/ui/settings.json

@@ -28,18 +28,6 @@
 		"y": 64,
 		"width": 192,
 		"spacing": 12,
-		"size": 1,
-		"color": [
-			0,
-			0,
-			0,
-			255
-		],
-		"active-color": [
-			255,
-			200,
-			0,
-			255
-		]
+		"size": 1
 	}
 }

include/wforge/audio.h

@@ -33,6 +33,7 @@ class BGMManager {
 	void fadeInCurrent(int duration_ticks, float starting_volume);
 	void step();
 	void nextMusic();
+	void setVolume(float volume);
 
 private:
 	float _cur_volume;

include/wforge/colorpalette.h

@@ -17,6 +17,11 @@ constexpr sf::Color ui_text_color(std::uint8_t a) {
 	return sf::Color(0, 0, 0, a);
 }
 
+constexpr sf::Color ui_active_color{250, 200, 46, 255};
+constexpr sf::Color ui_text_bright_color(std::uint8_t a) {
+	return sf::Color(255, 255, 255, a);
+}
+
 // All indexed colors must be here, for dynamic generated textures
 // Colors in static assets (e.g. PNG files) can be outside this palette
 constexpr ColorPaletteEntry _colors[] = {

include/wforge/save.h

@@ -21,6 +21,7 @@ struct SaveData {
 	void save() const;
 	void resetSettings();
 	void resetAll();
+	bool is_first_launch() const noexcept;
 
 	SaveData(const SaveData &) = delete;
 	SaveData &operator=(const SaveData &) = delete;

include/wforge/scene.h

@@ -82,6 +82,12 @@ class SceneManager {
 	int _scale;
 };
 
+struct ButtonDescriptor {
+	int x;
+	int y;
+	int size;
+};
+
 namespace scene {
 
 struct LevelPlaying {
@@ -96,6 +102,9 @@ struct LevelPlaying {
 		const SceneManager &mgr, sf::RenderTarget &target, int scale
 	) const;
 
+	void pause(SceneManager &mgr) noexcept;
+	void unpause(SceneManager &mgr) noexcept;
+
 private:
 	void _restartLevel(SceneManager &mgr, bool is_failed = true);
 
@@ -105,6 +114,12 @@ struct LevelPlaying {
 	int _hint_type;
 	int _hint_opacity;
 	PixelFont &font;
+	bool _paused;
+
+	// Paused Menu
+	int _paused_menu_current_button_index;
+	bool _show_help;
+	sf::Texture *_help_texture;
 };
 
 struct DuckDeath {
@@ -242,17 +257,10 @@ struct MainMenu {
 	const PixelFont &font;
 	sf::Texture *_background_texture;
 
-	struct ButtonDescriptor {
-		int x;
-		int y;
-		int size;
-		sf::Color color;
-		sf::Color active_color;
-	};
-
 	int _current_button_index;
 	ButtonDescriptor _play_button;
 	ButtonDescriptor _settings_button;
+	ButtonDescriptor _help_button;
 	ButtonDescriptor _exit_button;
 	UITextDescriptor _version_text;
 };
@@ -321,6 +329,23 @@ struct Credits {
 	std::vector<std::pair<std::string, std::string>> _content;
 };
 
+struct Help {
+	Help();
+
+	std::array<int, 2> size() const;
+	void setup(SceneManager &mgr);
+	void handleEvent(SceneManager &mgr, sf::Event &evt);
+	void step(SceneManager &mgr);
+	void render(
+		const SceneManager &mgr, sf::RenderTarget &target, int scale
+	) const;
+
+private:
+	sf::Texture *_background_texture;
+	int _width;
+	int _height;
+};
+
 } // namespace scene
 
 } // namespace wf

src/audio.cpp

@@ -120,6 +120,14 @@ void BGMManager::step() {
 	}
 }
 
+void BGMManager::setVolume(float volume) { {
+		_cur_volume = volume;
+		if (_cur_bgm) {
+			_cur_bgm->setVolume(_cur_volume);
+		}
+	}
+}
+
 void BGMManager::nextMusic() {
 	if (!_collection) {
 		return;

src/main.cpp

@@ -13,7 +13,7 @@
 #include <iostream>
 #include <proxy/proxy.h>
 
-void entry(const std::string &level_id, int scale_config);
+void entry(const std::string &level_id, int scale_config, bool is_first_launch);
 
 std::filesystem::path wf::_executable_path;
 int main(int argc, char **argv) {
@@ -64,7 +64,10 @@ int main(int argc, char **argv) {
 	}
 
 	CPPTRACE_TRY {
-		entry(program.get<std::string>("level"), program.get<int>("--scale"));
+		entry(
+			program.get<std::string>("level"), program.get<int>("--scale"),
+			save.is_first_launch()
+		);
 	}
 	CPPTRACE_CATCH(const std::exception &e) {
 		std::cerr << "Unhandled exception: " << e.what() << "\n";
@@ -75,14 +78,25 @@ int main(int argc, char **argv) {
 	return 0;
 }
 
-void entry(const std::string &level_id, int scale_config) {
+void entry(
+	const std::string &level_id, int scale_config, bool is_first_launch
+) {
+	auto initialScene = [&](const std::string &level_id, bool is_first_launch) {
+		if (level_id == "-") {
+			if (is_first_launch) {
+				return pro::make_proxy<wf::SceneFacade, wf::scene::Help>();
+			} else {
+				return pro::make_proxy<wf::SceneFacade, wf::scene::MainMenu>();
+			}
+		} else {
+			return pro::make_proxy<wf::SceneFacade, wf::scene::LevelPlaying>(
+				level_id
+			);
+		}
+	};
+
 	wf::SceneManager scene_mgr(
-		level_id == "-"
-			? pro::make_proxy<wf::SceneFacade, wf::scene::MainMenu>()
-			: pro::make_proxy<wf::SceneFacade, wf::scene::LevelPlaying>(
-				  level_id
-			  ),
-		scale_config
+		initialScene(level_id, is_first_launch), scale_config
 	);
 
 	auto &window = scene_mgr.window;

src/save.cpp

@@ -94,7 +94,7 @@ SaveData &SaveData::instance() noexcept {
 			}
 		}
 
-		// Please don't relay on this saving mechanism
+		// Please don't rely on this saving mechanism
 		// it only works as an extra safeguard against data loss
 		// Please save manually whenever change is made
 		std::atexit([]() {
@@ -142,6 +142,10 @@ void SaveData::resetAll() {
 	save();
 }
 
+bool SaveData::is_first_launch() const noexcept {
+	return completed_levels == 0;
+}
+
 UserSettings UserSettings::defaultSettings() noexcept {
 	return UserSettings{
 		.scale = 0,

src/scenes/help.cpp

@@ -0,0 +1,53 @@
+#include "wforge/assets.h"
+#include "wforge/scene.h"
+#include <nlohmann/json.hpp>
+
+namespace wf::scene {
+
+Help::Help() {
+	const auto &json_data = AssetsManager::instance().getAsset<nlohmann::json>(
+		"ui-config/help"
+	);
+
+	_width = json_data.at("width");
+	_height = json_data.at("height");
+
+	_background_texture = &AssetsManager::instance().getAsset<sf::Texture>(
+		"ui/help"
+	);
+}
+
+std::array<int, 2> Help::size() const {
+	return {_width, _height};
+}
+
+void Help::handleEvent(SceneManager &mgr, sf::Event &evt) {
+	if (auto kb = evt.getIf<sf::Event::KeyPressed>()) {
+		switch (kb->code) {
+		case sf::Keyboard::Key::Escape:
+		case sf::Keyboard::Key::Enter:
+		case sf::Keyboard::Key::Space:
+			UISounds::instance().forward.play();
+			mgr.changeScene(pro::make_proxy<SceneFacade, MainMenu>());
+			return;
+
+		default:
+			break;
+		}
+	}
+}
+
+void Help::setup(SceneManager &mgr) {}
+void Help::step(SceneManager &mgr) {}
+
+void Help::render(
+	const SceneManager &mgr, sf::RenderTarget &target, int scale
+) const {
+	sf::Sprite background_sprite(*_background_texture);
+	background_sprite.setPosition(sf::Vector2f(0, 0));
+	background_sprite.setScale(sf::Vector2f(scale, scale));
+
+	target.draw(background_sprite);
+}
+
+} // namespace wf::scene