Build 0.1.5

src/main/java/me/piitex/renjava/Launch.java

@@ -1,6 +1,7 @@
 package me.piitex.renjava;
 
 import javafx.application.Application;
+import javafx.scene.paint.Color;
 import javafx.stage.Stage;
 
 import java.io.*;
@@ -19,6 +20,8 @@
 import me.piitex.renjava.configuration.RenJavaConfiguration;
 import me.piitex.renjava.gui.GuiLoader;
 import me.piitex.renjava.gui.Window;
+import me.piitex.renjava.gui.overlays.ButtonOverlay;
+import me.piitex.renjava.gui.prompts.Prompt;
 import me.piitex.renjava.loggers.ApplicationLogger;
 import me.piitex.renjava.loggers.RenLogger;
 import org.reflections.Reflections;
@@ -93,7 +96,6 @@ private static void loadClass(Class<?> clazz, String[] args, InfoFile infoFile)
 
             // Try to create info file if it didn't exist.
             if (!infoFile.exists()) {
-
                 // Try to re-create
                 infoFile = new InfoFile(new File(renJava.getBaseDirectory(), "/renjava/build.info"), true);
                 if (!infoFile.exists()) {
@@ -117,7 +119,6 @@ private static void loadClass(Class<?> clazz, String[] args, InfoFile infoFile)
 
                 infoFile.write("main", clazz.getName());
                 infoFile.write("file", fileName);
-
             } catch (URISyntaxException e) {
                 RenLogger.LOGGER.error("Could retrieve runtime information.", e);
             }
@@ -179,6 +180,10 @@ public void start(Stage stage) {
 
     /**
      * This is just a default execute for testing purposes only.
+     * To make this execute work in your own environment, create a 'test' folder.
+     * The folder should be in the root directory of this project.
+     * Place gui default assets inside /~test/game/
+     * Run {@link Main#main(String[])}
      */
     @Game(name = "Default Execute", author = "piitex", version = "0.0.0")
     @Configuration(title = "{name}", width = 1920, height = 1080)
@@ -214,7 +219,29 @@ public void createStory() {
 
         @Override
         public void start() {
+            Prompt prompt = new Prompt("Are you sure you want to start a new game?");
+            prompt.setBlockMainWindow(false);
+
+            ButtonOverlay yes = new ButtonOverlay("yes", "Yes", Color.WHITE);
+            yes.setY(325);
+            prompt.addElement(yes);
+
+            yes.onClick(event -> {
+                // TODO: Play the first story of the game. (New game)
+                System.out.println("Starting new game...");
+            });
+
+            ButtonOverlay no = new ButtonOverlay("no", "No", Color.WHITE);
+            no.setY(325);
+            no.setX(840);
+
+            no.onClick(event -> {
+                prompt.closeWindow();
+            });
+
+            prompt.addElement(no);
 
+            prompt.render();
         }
     }
 }

src/main/java/me/piitex/renjava/Main.java

@@ -4,6 +4,7 @@ public class Main {
 
     /**
      * Initializes the javafx application.
+     * This is needed because the main execute cannot be executed while extending Application.
      *
      * @param args Application parameters.
      */

src/main/java/me/piitex/renjava/RenJava.java

@@ -1,6 +1,7 @@
 package me.piitex.renjava;
 
 import javafx.application.HostServices;
+import javafx.application.Platform;
 import javafx.scene.paint.Color;
 import javafx.stage.StageStyle;
 import me.piitex.renjava.addons.AddonLoader;
@@ -16,7 +17,9 @@
 import me.piitex.renjava.configuration.SettingsProperties;
 import me.piitex.renjava.events.EventHandler;
 import me.piitex.renjava.events.defaults.*;
+import me.piitex.renjava.gui.GuiLoader;
 import me.piitex.renjava.gui.Window;
+import me.piitex.renjava.gui.WindowBuilder;
 import me.piitex.renjava.gui.containers.ScrollContainer;
 import me.piitex.renjava.gui.layouts.VerticalLayout;
 import me.piitex.renjava.gui.menus.MainMenu;
@@ -80,7 +83,6 @@ public abstract class RenJava {
 
     protected String buildVersion;
 
-
     // Error tracking
     private static long lastErrorTimeStamp;
     private static int spamTrack = 0;
@@ -99,6 +101,7 @@ protected void init() {
         // Run after super
         PLAYER = new Player();
         TRACKS = new Tracks();
+        ADDONLOADER = new AddonLoader();
         EVENTHANDLER = new EventHandler();
 
         EVENTHANDLER.registerListener(new MenuClickEventListener());
@@ -109,25 +112,71 @@ protected void init() {
         this.registerData(PLAYER);
         this.registerData(TRACKS);
         new RenLoader(this);
-        ADDONLOADER = new AddonLoader();
     }
 
+    public void reload(boolean resetGraphics) {
+        // Reloads the game. Do not call unless you know what you are doing.
+        PLAYER = null;
+        TRACKS = null;
+        EVENTHANDLER.getRegisteredListeners().clear();
+        registeredCharacters.clear();
+        registeredData.clear();
+        ADDONLOADER.disable();
+        ADDONLOADER = null;
+
+        gameWindow.clear();
+        gameWindow.render();
+
+        // Re-initialize.
+        init();
+
+        if (resetGraphics) {
+            gameWindow.getStage().setOnHiding(null);
+            gameWindow.getStage().hide();
+            new GuiLoader(gameWindow.getStage(), this, hostServices);
+        }
+    }
+
+    /**
+     * Used when displaying game information.
+     *
+     * @return The name of the project.
+     */
     public String getName() {
          return name;
      }
 
+    /**
+     * Used when displaying game information.
+     *
+     * @return The author of the project.
+     */
     public String getAuthor() {
         return author;
     }
 
+    /**
+     * Used when displaying game information.
+     *
+     * @return The version of the project.
+     */
     public String getVersion() {
         return version;
     }
 
+    /**
+     * The engine will automatically create a unique id for every project. See {@link me.piitex.renjava.utils.MDUtils#getGameID(String)}
+     * <p>
+     * The id is used as a unique game folder stored on the local system. Used for storing global data that can transfer between different save versions.
+     * @return The generated game id.
+     */
     public Integer getID() {
         return id;
     }
 
+    /**
+     * @return The applications logger.
+     */
     public Logger getLogger() {
         return logger;
     }
@@ -214,8 +263,6 @@ public void setBaseDir(File baseDir) {
 
     /**
      * Registers a character in the RenJava framework.
-     * <p>
-     * The registerCharacter() method is used to register a character in the RenJava framework.
      * Registered characters can be accessed and managed by other parts of the framework using their unique ID.
      *
      * @param character The character object to be registered.
@@ -233,8 +280,6 @@ public Collection<Character> getCharacters() {
 
     /**
      * Retrieves a character by its ID.
-     * <p>
-     * The getCharacter() method is used to retrieve a character object based on its ID.
      * Characters are registered using the registerCharacter() method and can be accessed using their unique ID.
      *
      * @param id The ID of the character to retrieve.
@@ -431,6 +476,14 @@ public static void openLink(String url) {
         getInstance().getHost().showDocument(url);
     }
 
+    /**
+     * Forcefully closes the application.
+     */
+    public static void shutdown() {
+        Platform.exit();
+        System.exit(0);
+    }
+
     public static void writeStackTrace(Exception e) {
         if (lastErrorTimeStamp > 0) {
             spamTrack++;
@@ -467,7 +520,7 @@ public static void writeStackTrace(Exception e) {
         }
 
         if (errorWindow == null) {
-            errorWindow = new Window("Error", StageStyle.DECORATED, CONFIGURATION.getGameIcon(), 920, 650, false);
+            errorWindow = new WindowBuilder("Error").setStageStyle(StageStyle.DECORATED).setIcon(CONFIGURATION.getGameIcon()).setDimensions(920, 650).setScale(false).build();
         } else {
             errorWindow.clearContainers();
         }
@@ -493,11 +546,11 @@ public static void writeStackTrace(Exception e) {
         texts.add(stackTrace);
 
         TextFlowOverlay textFlowOverlay = new TextFlowOverlay(texts, 900, 600);
-        rootLayout.addOverlay(textFlowOverlay);
+        rootLayout.addElement(textFlowOverlay);
 
-        container.addLayout(rootLayout);
+        container.addElement(rootLayout);
 
-        errorWindow.addContainers(container);
+        errorWindow.addContainer(container);
 
         errorWindow.render();
     }

src/main/java/me/piitex/renjava/RenLoader.java

@@ -32,8 +32,7 @@ public RenLoader(RenJava renJava) {
         setupGame();
         if (shutdown) {
             // Shutdown application if startup fails.
-            Platform.exit();
-            System.exit(0);
+            RenJava.shutdown();
             return;
         }
 
@@ -244,8 +243,11 @@ public synchronized String getVersion() {
         }
 
         if (version == null) {
-            // we could not compute the version so use a blank
-            version = "";
+            // Please read and understand the RenJava license.
+            // Any modifications to RenJava that are sold for commercial use must be available.
+            // Any person can request source and all authors/developers must abide by that request.
+            // Sources must be disclosed this ensures safety and security of the application.
+            version = "Unknown (Request author for source)";
         }
 
         return version;

src/main/java/me/piitex/renjava/addons/AddonLoader.java

@@ -3,6 +3,7 @@
 import me.piitex.renjava.RenJava;
 import me.piitex.renjava.configuration.InfoFile;
 import me.piitex.renjava.loggers.RenLogger;
+import org.apache.commons.io.IOUtils;
 import org.slf4j.Logger;
 import org.jetbrains.annotations.Nullable;
 
@@ -11,7 +12,6 @@
 import java.net.URL;
 import java.net.URLClassLoader;
 import java.nio.file.Files;
-import java.nio.file.Path;
 import java.nio.file.StandardCopyOption;
 import java.util.*;
 import java.util.concurrent.atomic.AtomicReference;
@@ -24,6 +24,7 @@ public class AddonLoader {
     private final List<Addon> addons = new ArrayList<>();
 
     private final Logger logger;
+
     public AddonLoader() {
         logger = RenLogger.LOGGER;
     }
@@ -39,7 +40,7 @@ public void load() {
             logger.info("No addons to load.");
             return; // No need to load if there are no addons.
         } else {
-            logger.info("Loading " + size + " addon(s)...");
+            logger.info("Loading {} addon(s)...", size);
         }
 
         Map<File, String> lateLoaders = new HashMap<>();
@@ -65,10 +66,18 @@ public void load() {
 
             // Convert entry to file then load info file
             try {
-                File buildFile = new File(RenJava.getInstance().getBaseDirectory(), "addons/build.info");
-                Files.copy(zipFile.getInputStream(entry), Path.of(buildFile.getPath()), StandardCopyOption.REPLACE_EXISTING);
+                File buildFile = File.createTempFile("build", ".info");
+                buildFile.deleteOnExit();
 
-                InfoFile build = new InfoFile(buildFile, false);
+                InfoFile build;
+                try (FileOutputStream outputStream = new FileOutputStream(buildFile)) {
+                    IOUtils.copy(zipFile.getInputStream(entry), outputStream);
+                    build = new InfoFile(buildFile, false);
+                } catch (IOException e) {
+                    RenLogger.LOGGER.error("Could not create temp-file for '{}'.", file.getName());
+                    RenJava.writeStackTrace(e);
+                    continue;
+                }
 
                 boolean invalidVersion = false;
 
@@ -107,9 +116,6 @@ public void load() {
                     nonDependants.add(file);
 
                 }
-                // Delete after
-                buildFile.delete();
-
                 extractResources(zipFile);
 
             } catch (IOException e) {
@@ -130,12 +136,19 @@ public void load() {
             }
         });
 
+        // Java will scan the files randomly with no certain order.
+        // This will loop through the addons and attempt to load them.
+        // If the addon succeeds it will be added to passed and removed from validations.
+        // The loop will continue until validations is empty or the same addon fails twice.
         Map<File, String> validations = new HashMap<>(lateLoaders);
         Collection<String> passed = new HashSet<>();
         AtomicReference<String> lastValidated = new AtomicReference<>("");
 
         while (!validations.isEmpty()) {
             lateLoaders.forEach((file, string) -> {
+
+                // The same addon can only be looped twice in a row if it's the only addon left.
+                // If the addon failed twice it means there was a problem with that addon.
                 if (lastValidated.get().equalsIgnoreCase(file.getName())) {
                     logger.error("Could not initialize " + file.getName() + ": May be the result of a missing dependency.");
                     validations.remove(file);
@@ -145,9 +158,13 @@ public void load() {
                     return;
                 }
                 String dependency = string.trim();
+
+                // Dependencies are configured; dependencies=test1,test2
+                // If it contains a ',' it is likely to have multiple dependencies.
                 if (dependency.contains(",")) {
                     boolean canExecute = true;
                     Collection<Addon> dep = new HashSet<>();
+                    // Loop the dependencies by its comma. test1,test2
                     for (String depend : dependency.split(",")) {
                         Addon addon = addons.stream().filter(addon1 -> addon1.getName().equalsIgnoreCase(depend)).findAny().orElse(null);
                         if (addon == null) {
@@ -197,6 +214,11 @@ public void load() {
     private void initAddon(File file, @Nullable Collection<Addon> dependencies) throws IOException, ClassNotFoundException, NoSuchMethodException, InvocationTargetException, InstantiationException, IllegalAccessException {
         try (JarFile jarFile = new JarFile(file)) {
             Enumeration<JarEntry> entries = jarFile.entries();
+
+            // Deprecation notice!
+            // new URL is deprecated and moved to new URI(str).toUrl();
+            // This method does not work with the string.
+            // So I'm keeping it in for now.
             URL[] urls = {new URL("jar:file:" + file.getPath() + "!/")};
             URLClassLoader cl = URLClassLoader.newInstance(urls);
             while (entries.hasMoreElements()) {
@@ -207,7 +229,7 @@ private void initAddon(File file, @Nullable Collection<Addon> dependencies) thro
 
                     // Authors should warn users about using pirated versions or getting addons from unknown sources.
                     // This can easily allow malicious code to be executed. I will not be adding any form on 'anti malware' checks. Don't download something you don't trust.
-                    // Also be aware of the licence renjava uses. Authors are required to provide source to code per the GPL 3.0 license.
+                    // Also be aware of the licence renjava uses. Authors are required to provide source code per the GPL 3.0 license.
                     Class<?> clazz = cl.loadClass(clazzName);
                     if (Addon.class.isAssignableFrom(clazz)) {
                         Object object = clazz.getDeclaredConstructor().newInstance();
@@ -216,7 +238,6 @@ private void initAddon(File file, @Nullable Collection<Addon> dependencies) thro
                             addon.getDependencies().addAll(dependencies);
                         }
                         addons.add(addon);
-                        //clazz.getMethod("onLoad").invoke(object, null);
                         boolean failed = false;
                         try {
                             addon.onLoad(); // Loads addon