Implement character archive feature

Also adds support for multiple savegame location and lists custom quest
characters.

Author: epinter

README.md

@@ -26,10 +26,32 @@ This software requires **Microsoft Windows (64-bit recommended)**. You don't nee
 
 Keep in mind that this software make modifications to your save game (more specifically the file Player.chr). You shouldn't modify your characters while the game is running, you can corrupt your save game. ***YOU SHOULD ALWAYS KEEP A FULL BACKUP OF YOUR SAVE GAME FOLDER*** (Documents/My Games/Titan Quest - Immortal Throne).
 
-![TQRespec Screenshot 1](assets/screenshot_attributes.png "Attributes")
-![TQRespec Screenshot 2](assets/screenshot_skills.png "Skills")
-![TQRespec Screenshot 3](assets/screenshot_misc.png "Misc")
-![TQRespec Screenshot 4](assets/screenshot_characters.png "Characters")
+#### ***Screenshots***
+
+- *Attributes*
+
+  ![TQRespec Screenshot 1](assets/screenshot_attributes.png "Attributes")
+
+
+- *Remove Skills and masteries*
+
+  ![TQRespec Screenshot 2](assets/screenshot_skills.png "Skills")
+
+
+- *Copy, Backup, Convert and JSON export*
+
+  ![TQRespec Screenshot 3](assets/screenshot_misc.png "Misc")
+
+
+- *Characters list and export CSV*
+
+  ![TQRespec Screenshot 4](assets/screenshot_characters.png "Characters")
+
+
+- *Characters Archive and Unarchive **(archive to hide character in game)***
+
+  ![TQRespec Screenshot 5](assets/screenshot_archive.png "Archive")
+
 
 #### ***Running without the game installed***
 
@@ -74,7 +96,7 @@ If you have a mastery on level 24 and 7 skills with points allocated, you can cl
 
 #### ***Characters list and stats***
 
-When you click on the button near the character selection list, you will be able to see a table with all your characters, with attributes and stats. There's also an option to export the table to CSV.
+When you click on the button near the character selection list, you will be able to see a table with all your characters, with attributes and stats. There's also an option to export the table to CSV. To Archive or Unarchive a character, right click on the row and select the option desired. When the archive is done, the character directory is moved from "SaveData/Main/_charactername" to "SaveData/Main/ArchivedCharacters/_charactername", hiding it from the game. Unarchive moves the character back to default directory.
 
 #### ***Android support***
 

assets/screenshot_archive.png

@@ -24,6 +24,8 @@
 import br.com.pinter.tqrespec.core.UnhandledRuntimeException;
 import br.com.pinter.tqrespec.core.WorkerThread;
 import br.com.pinter.tqrespec.logging.Log;
+import br.com.pinter.tqrespec.save.SaveLocation;
+import br.com.pinter.tqrespec.save.player.Archiver;
 import br.com.pinter.tqrespec.save.player.PlayerLoader;
 import br.com.pinter.tqrespec.tqdata.*;
 import br.com.pinter.tqrespec.util.Build;
@@ -36,6 +38,9 @@
 import javafx.scene.Cursor;
 import javafx.scene.Scene;
 import javafx.scene.control.*;
+import javafx.scene.control.Button;
+import javafx.scene.control.Label;
+import javafx.scene.control.MenuItem;
 import javafx.scene.control.cell.PropertyValueFactory;
 import javafx.scene.input.KeyCode;
 import javafx.scene.input.KeyEvent;
@@ -45,6 +50,7 @@
 import javafx.scene.paint.Color;
 import javafx.scene.text.Text;
 import javafx.stage.*;
+import javafx.stage.Window;
 import javafx.util.Callback;
 import org.apache.commons.lang3.SystemUtils;
 
@@ -91,6 +97,9 @@ public class CharactersViewController implements Initializable {
     @FXML
     private TableColumn<PlayerCharacter, String> colName;
 
+    @FXML
+    private TableColumn<PlayerCharacter, String> colStore;
+
     @FXML
     private TableColumn<PlayerCharacter, Integer> colLevel;
 
@@ -176,6 +185,9 @@ public class CharactersViewController implements Initializable {
 
     private AtomicBoolean loadingCharacters = new AtomicBoolean(false);
 
+    @Inject
+    private Archiver archiver;
+
     @FXML
     public void closeWindow(@SuppressWarnings("unused") MouseEvent evt) {
         close();
@@ -225,6 +237,34 @@ public void moveWindow(MouseEvent evt) {
         }
     }
 
+    private void loadCharacters() {
+        loadingCharacters.set(true);
+
+        Platform.runLater(() -> {
+            charactersTable.setPlaceholder(new Label(ResourceHelper.getMessage("characters.loadingPlaceholder")));
+            rootElement.getScene().setCursor(Cursor.WAIT);
+
+        });
+
+        characters = new ArrayList<>();
+        for (PlayerCharacterFile p : gameInfo.getPlayerCharacterList()) {
+            try {
+                player.loadPlayer(p.getPlayerName(), p.getLocation());
+            } catch (RuntimeException e) {
+                logger.log(System.Logger.Level.ERROR, String.format("Error loading character '%s'", p));
+                continue;
+            }
+            characters.add(player.getCharacter());
+        }
+
+        Platform.runLater(() -> {
+            setupTable();
+            charactersTable.setPlaceholder(new Label(""));
+            Platform.runLater(() -> rootElement.getScene().setCursor(Cursor.DEFAULT));
+            loadingCharacters.set(false);
+        });
+    }
+
     @Override
     public void initialize(URL url, ResourceBundle resourceBundle) {
         player.reset();
@@ -269,31 +309,7 @@ public void initialize(URL url, ResourceBundle resourceBundle) {
         stage.addEventHandler(WindowEvent.WINDOW_SHOWING, e -> new WorkerThread(new MyTask<>() {
             @Override
             protected Void call() {
-                loadingCharacters.set(true);
-
-                Platform.runLater(() -> {
-                    charactersTable.setPlaceholder(new Label(ResourceHelper.getMessage("characters.loadingPlaceholder")));
-                    rootElement.getScene().setCursor(Cursor.WAIT);
-
-                });
-
-                characters = new ArrayList<>();
-                for (PlayerCharacterFile p : gameInfo.getPlayerCharacterList()) {
-                    try {
-                        player.loadPlayer(p.getPlayerName(), p.isExternal());
-                    } catch (RuntimeException e) {
-                        logger.log(System.Logger.Level.ERROR, String.format("Error loading character '%s'", p));
-                        continue;
-                    }
-                    characters.add(player.getCharacter());
-                }
-
-                Platform.runLater(() -> {
-                    setupTable();
-                    charactersTable.setPlaceholder(new Label(""));
-                    Platform.runLater(() -> rootElement.getScene().setCursor(Cursor.DEFAULT));
-                    loadingCharacters.set(false);
-                });
+                loadCharacters();
                 return null;
             }
         }).start());
@@ -305,14 +321,84 @@ protected Void call() {
 
         exportButton.setGraphic(Icon.FA_FILE_EXPORT.create());
 
+        ContextMenu contextMenu = new ContextMenu();
+        MenuItem archive = new MenuItem(ResourceHelper.getMessage("characters.archive"));
+        MenuItem unarchive = new MenuItem(ResourceHelper.getMessage("characters.unarchive"));
+        MenuItem explore = new MenuItem(ResourceHelper.getMessage("characters.explore"));
+        contextMenu.getItems().add(explore);
+        contextMenu.getItems().add(new SeparatorMenuItem());
+        contextMenu.getItems().add(archive);
+        contextMenu.getItems().add(unarchive);
+
+        explore.setOnAction(event -> {
+            try {
+                Runtime.getRuntime().exec(Constants.EXPLORER_COMMAND + " "
+                        + charactersTable.getSelectionModel().getSelectedItem().getPath().toString());
+            } catch (IOException e) {
+                logger.log(System.Logger.Level.WARNING, "unable to open explorer: ", e);
+            }
+        });
+        archive.setOnAction(event -> archiveAction(false));
+        unarchive.setOnAction(event -> archiveAction(true));
+
+        charactersTable.setContextMenu(contextMenu);
+        contextMenu.setOnShowing(e -> {
+            int selectedCount = charactersTable.getSelectionModel().getSelectedItems().size();
+            PlayerCharacter selected = charactersTable.getSelectionModel().getSelectedItem();
+            archive.setDisable(selectedCount > 1 || !selected.isArchivable());
+            unarchive.setDisable(selectedCount > 1 || !selected.isArchived());
+        });
         stage.show();
     }
 
+    private void archiveAction(boolean undo) {
+        PlayerCharacter selected = charactersTable.getSelectionModel().getSelectedItem();
+
+        String toastHeader = null;
+        String toastContent = null;
+
+        try {
+            rootElement.getScene().setCursor(Cursor.WAIT);
+            if(undo) {
+                archiver.unarchive(selected);
+                toastHeader = "characters.unarchive";
+                toastContent = "characters.unarchivedmessage";
+            } else {
+                archiver.archive(selected);
+                toastHeader = "characters.archive";
+                toastContent = "characters.archivedmessage";
+            }
+        } catch (IOException e) {
+            throw new UnhandledRuntimeException(e);
+        } finally {
+            reset();
+            SaveLocation locationMessage = selected.getLocation();
+            if(locationMessage.equals(SaveLocation.ARCHIVEMAIN)) {
+                locationMessage = SaveLocation.MAIN;
+            }
+            if(locationMessage.equals(SaveLocation.ARCHIVEUSER)) {
+                locationMessage = SaveLocation.USER;
+            }
+
+            rootElement.getScene().setCursor(Cursor.DEFAULT);
+            Toast.show((Stage) rootElement.getScene().getWindow(),
+                    ResourceHelper.getMessage(toastHeader),
+                    ResourceHelper.getMessage(toastContent,
+                            selected.getName(), ResourceHelper.getMessage("characters.store." + locationMessage)),
+                    5000);
+        }
+    }
+
     private void setupTable() {
         //setup tableview
         setupTableColumnString(colName, ResourceHelper.getMessage("characters.characterName"), "name");
+        setupTableColumnString(colStore, ResourceHelper.getMessage("characters.store"), null);
         setupTableColumnInteger(colLevel, ResourceHelper.getMessage("main.charlevel"), "level");
         setupTableColumnString(colGender, ResourceHelper.getMessage("main.gender"), null);
+
+        colStore.setCellValueFactory( f ->  new SimpleStringProperty(
+                ResourceHelper.getMessage("characters.store."+ f.getValue().getLocation().toString().toUpperCase())
+        ));
         colGender.setCellValueFactory(f -> new SimpleStringProperty(
                 ResourceHelper.getMessage("main.gender." + f.getValue().getGender().name().toLowerCase())));
 
@@ -399,6 +485,15 @@ private void setupTable() {
 
         charactersTable.getItems().addAll(characters);
 
+        charactersTable.getSelectionModel().setSelectionMode(SelectionMode.MULTIPLE);
+
+        resizeCharactersTable();
+    }
+
+    private void reset() {
+        charactersTable.getItems().clear();
+        characters.clear();
+        loadCharacters();
         resizeCharactersTable();
     }
 
@@ -448,6 +543,7 @@ public void exportCsv() {
 
         String[] header = new String[]{
                 ResourceHelper.getMessage("characters.characterName"),
+                ResourceHelper.getMessage("characters.store"),
                 ResourceHelper.getMessage("main.charlevel"),
                 ResourceHelper.getMessage("main.gender"),
                 ResourceHelper.getMessage("main.charclass"),
@@ -517,6 +613,7 @@ public void exportCsv() {
 
             String[] row = new String[]{
                     p.getName(),
+                    ResourceHelper.getMessage("characters.store." + p.getLocation()),
                     String.valueOf(p.getLevel()),
                     gender,
                     p.getCharacterClass(),

src/main/java/br/com/pinter/tqrespec/gui/CharactersViewController.java

@@ -22,6 +22,7 @@
 
 import br.com.pinter.tqrespec.core.*;
 import br.com.pinter.tqrespec.logging.Log;
+import br.com.pinter.tqrespec.save.SaveLocation;
 import br.com.pinter.tqrespec.save.player.Player;
 import br.com.pinter.tqrespec.save.player.PlayerWriter;
 import br.com.pinter.tqrespec.tqdata.Db;
@@ -154,12 +155,20 @@ protected Void call() {
 
         State.get().gameRunningProperty().addListener((value, oldV, newV) -> {
             if (BooleanUtils.isTrue(newV)) {
+                Platform.runLater(() -> {
+                    Parent rootCharWindow = fxmlLoaderCharacter.getRoot();
+                    if(rootCharWindow != null) {
+                        Stage charactersWindow = (Stage) rootCharWindow.getScene().getWindow();
+                        charactersWindow.close();
+                    }
+                });
+
                 Platform.runLater(() -> {
                     reset();
                     Toast.show((Stage) rootelement.getScene().getWindow(),
                             ResourceHelper.getMessage("alert.errorgamerunning_header"),
                             ResourceHelper.getMessage("alert.errorgamerunning_content"),
-                            8000);
+                            30000);
                 });
             }
         });
@@ -170,7 +179,7 @@ protected Void call() {
     public void addCharactersToCombo() {
         try {
             characterCombo.getSelectionModel().clearSelection();
-            characterCombo.getItems().setAll(gameInfo.getPlayerCharacterList());
+            characterCombo.getItems().setAll(gameInfo.getPlayerCharacterList(SaveLocation.MAIN, SaveLocation.EXTERNAL));
             characterCombo.getItems().sort(Comparator.comparing(PlayerCharacterFile::getPlayerName));
         } catch (ClassCastException | UnsupportedOperationException | IllegalArgumentException e) {
             logger.log(System.Logger.Level.ERROR, Constants.ERROR_MSG_EXCEPTION, e);
@@ -228,9 +237,14 @@ public void openCharactersWindow(ActionEvent evt) throws IOException {
             fxmlLoaderCharacter.setLocation(ResourceHelper.getResourceUrl("/fxml/characters.fxml"));
             fxmlLoaderCharacter.setResources(ResourceBundle.getBundle("i18n.UI", State.get().getLocale()));
             fxmlLoaderCharacter.load();
+            Parent r = fxmlLoaderCharacter.getRoot();
+            Stage charactersWindow = (Stage) r.getScene().getWindow();
+            charactersWindow.setOnHiding(e -> reset());
         } else {
             root = fxmlLoaderCharacter.getRoot();
-            ((Stage) root.getScene().getWindow()).show();
+            Stage charactersWindow = (Stage) root.getScene().getWindow();
+            charactersWindow.setOnHiding(e -> reset());
+            charactersWindow.show();
         }
     }
 
@@ -371,7 +385,7 @@ public void characterSelected(ActionEvent evt) {
         MyTask<Boolean> loadTask = new MyTask<>() {
             @Override
             protected Boolean call() {
-                return player.loadPlayer(playerCharacterFile.getPlayerName(), playerCharacterFile.isExternal());
+                return player.loadPlayer(playerCharacterFile.getPlayerName(), playerCharacterFile.getLocation());
             }
         };
 

src/main/java/br/com/pinter/tqrespec/gui/MainController.java

@@ -0,0 +1,13 @@
+/*
+ * Copyright (C) 2022 Emerson Pinter - All Rights Reserved
+ */
+
+package br.com.pinter.tqrespec.save;
+
+public enum SaveLocation {
+    MAIN,
+    USER,
+    EXTERNAL,
+    ARCHIVEMAIN,
+    ARCHIVEUSER
+}