WIP Tutorial

Author: flamendless

CMakeLists.txt

@@ -111,6 +111,7 @@ add_executable(CodeNect
 	src/ui/sidebar_indicator.cpp
 	src/ui/simulation_control.cpp
 	src/ui/terminal.cpp
+	src/ui/tutorial.cpp
 	src/ui/zoom.cpp
 
 	# color text editor

config.ini

@@ -1,5 +1,5 @@
 [general]
-version = 0.8
+version = 1.0
 terminal = termite
 fullscreen = false
 width = 1024
@@ -8,6 +8,8 @@ vsync = 1
 style = DARK
 font = ProggyClean
 font_size = 13
+first_time = true
+tutorial_done = false
 
 [clear_color]
 r = 0.45

src/core/config.cpp

@@ -26,6 +26,8 @@ const char* Config::fonts[6] = {
 	"CousineRegular", "KarlaRegular", "RobotoMedium"
 };
 const char* Config::version;
+bool Config::first_time = true;
+bool Config::tutorial_done = false;
 
 //Sidebar_c
 int Config::Sidebar_c::fade_in;
@@ -145,6 +147,11 @@ void Config::init_general(void)
 	Config::win_height = std::stoi(ini.GetValue("general", "height", "720"));
 	Config::vsync = std::stoi(ini.GetValue("general", "vsync", "1"));
 
+	const char* first_time = ini.GetValue("general", "first_time", "true");
+	Config::first_time = Utils::bool_from_string(first_time);
+	const char* tutorial_done = ini.GetValue("general", "tutorial_done", "false");
+	Config::tutorial_done = Utils::bool_from_string(tutorial_done);
+
 	const float r = std::stof(ini.GetValue("clear_color", "r", "0.45f"));
 	const float g = std::stof(ini.GetValue("clear_color", "g", "0.55f"));
 	const float b = std::stof(ini.GetValue("clear_color", "b", "0.60f"));

src/core/config.hpp

@@ -25,6 +25,8 @@ struct Config
 	static CSimpleIniA ini;
 	static const char* fonts[6];
 	static const char* version;
+	static bool first_time;
+	static bool tutorial_done;
 
 	struct Sidebar_c
 	{

src/main.cpp

@@ -24,6 +24,7 @@
 #include "ui/assessments.hpp"
 #include "ui/diff_viewer.hpp"
 #include "ui/info.hpp"
+#include "ui/tutorial.hpp"
 
 int main(int argv, char** args)
 {
@@ -92,6 +93,10 @@ int main(int argv, char** args)
 	if (CodeNect::Terminal::init() != RES_SUCCESS) return -1;
 	CodeNect::Terminal::register_commands();
 
+	//Tutorial
+	if (CodeNect::Tutorial::init() != RES_SUCCESS) return -1;
+	CodeNect::Tutorial::register_commands();
+
 #if DEBUG_MODE
 	bool is_imgui_demo = true;
 #endif
@@ -144,6 +149,7 @@ int main(int argv, char** args)
 		CodeNect::Terminal::draw();
 		CodeNect::SimulationControl::draw();
 		CodeNect::Docs::draw();
+		CodeNect::Tutorial::draw();
 
 		app.render_end();
 	}

src/modules/transpiler.cpp

@@ -507,6 +507,11 @@ int Transpiler::run(void)
 	{
 		// tcc_output_file(Transpiler::tcc_state, filename.c_str());
 		Transpiler::add_message(std::move("Launching program..."));
+#ifdef OS_LINUX
+		Transpiler::add_message(std::move("Switch to the terminal to see the program"));
+#elif OS_WIN
+		Transpiler::add_message(std::move("Switch to the command prompt to see the program"));
+#endif
 		Transpiler::has_ran = true;
 	}
 

src/ui/info.cpp

@@ -40,8 +40,8 @@ void Info::draw(void)
 			ICON_FA_EXCLAMATION_TRIANGLE " You have a warning\nin your visual code");
 		if (ImGui::Button("Click here for more info"))
 			Terminal::is_open = true;
+		ImGui::End();
 	}
-	ImGui::End();
 
 	ImGui::PopStyleVar(2);
 }

src/ui/tutorial.cpp

@@ -0,0 +1,123 @@
+#include "ui/tutorial.hpp"
+
+#include "IconsFontAwesome5.h"
+#include "core/defines.hpp"
+#include "core/commands.hpp"
+#include "core/config.hpp"
+#include "core/font.hpp"
+#include "core/utils.hpp"
+#include "ui/alert.hpp"
+
+namespace CodeNect
+{
+ImGuiWindowFlags Tutorial::flags =
+	ImGuiWindowFlags_NoCollapse |
+	ImGuiWindowFlags_NoMove | ImGuiWindowFlags_NoResize |
+	ImGuiWindowFlags_NoSavedSettings | ImGuiWindowFlags_NoTitleBar |
+	ImGuiWindowFlags_AlwaysAutoResize;
+bool Tutorial::is_open = false;
+ImVec2 Tutorial::pos;
+ImVec2 Tutorial::size;
+unsigned int Tutorial::current_step = 0;
+std::map<const std::string, bool> Tutorial::m_steps = {
+	{"Open Sidebar", false},
+	{"Open Command Palette", false},
+	{"Create New Project", false},
+	{"Create Node Variables", false},
+	{"Create Node Operation", false},
+	{"Create Node Print", false},
+	{"Connecting Nodes", false},
+	{"Transpiling Visual Code", false},
+	{"Running Visual Code", false},
+};
+
+int Tutorial::init(void)
+{
+	const int x = Config::win_width;
+	const int y = (float)Config::win_height/2;
+
+	Tutorial::pos = ImVec2(x, y);
+	Tutorial::size = ImVec2(Config::win_width * 0.30, Config::win_height - 16);
+
+	if (Config::first_time && !Config::tutorial_done)
+	{
+		Alert::open(ALERT_TYPE::SUCCESS, "Hi, this is the first time you have\nopened this software, would you like to start the tutorial?");
+		Alert::has_cb = true;
+		Alert::fn_custom_draw = []()
+		{
+			if (ImGui::Button(ICON_FA_CHECK " Yes, begin the tutorial"))
+			{
+				Tutorial::is_open = true;
+				// Config::first_time = false;
+				// Config::ini.SetValue("general", "first_time", "false");
+				// Config::save_user_config();
+				Alert::close();
+			}
+
+			ImGui::SameLine();
+
+			if (ImGui::Button(ICON_FA_TIMES " No, I already know how to use it"))
+			{
+				Tutorial::is_open = false;
+				// Config::first_time = false;
+				// Config::ini.SetValue("general", "first_time", "false");
+				// Config::save_user_config();
+				Alert::close();
+			}
+		};
+	}
+
+	return RES_SUCCESS;
+}
+
+void Tutorial::register_commands(void)
+{
+	Command* cmd = new Command("Tutorial", "start the tutorial wizard", ICON_FA_MAGIC);
+	cmd->set_fn(Tutorial::toggle);
+	cmd->m_close_command_palette = true;
+	Commands::register_cmd(*cmd);
+}
+
+void Tutorial::toggle(void)
+{
+	Tutorial::is_open = !Tutorial::is_open;
+}
+
+void Tutorial::draw(void)
+{
+	if (!Tutorial::is_open)
+		return;
+
+	ImGui::SetNextWindowPos(Tutorial::pos, ImGuiCond_Always, ImVec2(1, 0.5));
+	ImGui::SetNextWindowSize(Tutorial::size);
+	ImGui::PushStyleVar(ImGuiStyleVar_WindowPadding, ImVec2(16, 16));
+
+	if (ImGui::Begin("Tutorial", &Tutorial::is_open, Tutorial::flags))
+	{
+		Font::use_font(FONT_SIZE::LARGE);
+		Utils::center_text(ICON_FA_MAGIC " TUTORIAL", true);
+		Font::unuse_font();
+		ImGui::Separator();
+		unsigned int step = 0;
+
+		for (std::pair<const std::string, bool>& e : Tutorial::m_steps)
+		{
+			const char* id = e.first.c_str();
+			ImGui::PushID(id);
+			if (step == Tutorial::current_step)
+				ImGui::SetNextItemOpen(true);
+
+			if (ImGui::TreeNode(id))
+			{
+				ImGui::TreePop();
+			}
+			ImGui::PopID();
+			++step;
+		}
+
+		ImGui::End();
+	}
+
+	ImGui::PopStyleVar(1);
+}
+}

src/ui/tutorial.hpp

@@ -0,0 +1,26 @@
+#ifndef _TUTORIAL_HPP
+#define _TUTORIAL_HPP
+
+#include <string>
+#include <map>
+#include "imgui.h"
+
+namespace CodeNect
+{
+struct Tutorial
+{
+	static ImGuiWindowFlags flags;
+	static bool is_open;
+	static ImVec2 pos;
+	static ImVec2 size;
+	static unsigned int current_step;
+	static std::map<const std::string, bool> m_steps;
+
+	static int init(void);
+	static void register_commands(void);
+	static void toggle(void);
+	static void draw(void);
+};
+}
+
+#endif //_TUTORIAL_HPP

src/ui/zoom.cpp

@@ -63,7 +63,7 @@ void Zoom::draw(void)
 	if (ImGui::Begin("Zoom", &Zoom::is_open, Zoom::flags))
 	{
 		ImGui::Text(ICON_FA_SEARCH_PLUS " %d%%", (int)(Zoom::zoom_factor * 100));
+		ImGui::End();
 	}
-	ImGui::End();
 }
 }