1.4.0: Initial Sundarpatan support, new logo, migrate to FreeSimpleGUI

Author: RyMaxim

.gitignore

@@ -5,6 +5,7 @@ apc.egg-info
 mods
 backups
 venv
+.python-version
 */__pycache__
 .DS_Store
 build

README.md

@@ -1,8 +1,10 @@
 # animal-population-changer
 
-A tool that allows anyone to change the animal population on all the reserves in theHunter: Call of the Wild (COTW).
+A tool to modify attributes of animals across all reserves in theHunter: Call of the Wild (COTW).
 
-![GUI](https://user-images.githubusercontent.com/2107385/248629158-47bec7aa-a978-4cc7-8fd0-dfeaea8e6777.gif)
+Release builds are available here on GitHub and on NexusMods: https://www.nexusmods.com/thehuntercallofthewild/mods/440
+
+![Screenshot](screenshot.png)
 
 This tool can make all species a diamond, the appropriate species a Great one, or have a rare fur.
 
@@ -13,30 +15,32 @@ The following mods are possible with this tool:
 1. Make a female animal a male.
 1. Make a male a female.
 
-The modded population files can be found in a `mods` folder in the same directory you are running the tool. 
-
-To download the latest releases of this tool, go to [NexusMods](https://www.nexusmods.com/thehuntercallofthewild/mods/225) where you can also post bugs and have a conversation with the COTW modding community.
-
-Testing with game version: 2649775
+The modded population files can be found in a `mods` folder in the same directory you are running the tool.
 
 ## Limitations:
+
 * This tool was tested on Windows 11 with the game installed via Steam. It is smart enough to also look where Epic Games saves its files too. If your game files are saved somewhere else besides where Steam or Epic saves them, use the `Configure Game Path` button.
 * The species that use the newer TruRACS trophy system may not become a diamond. This is an area where I am still doing research to figure out how exactly to manipulate.
 * If you use the executables (EXE) files, your system may complain there is a virus. This is not true, but the `pyinstaller` package that builds the executable is often used by hackers, and so it is being flagged. To avoid this, simply install the tool from the `wheel` file or build it from source.
-  
+
 ## How To Build
 
 > Note: This code was built and tested with Python 3.10.10.
 
-To install dependencies:
+Setup virtual environment:
+```sh
+python -m venv venv
+venv\Scripts\activate
+```
+
+Install dependencies:
 ```sh
 pip install -r requirements.txt
-python -m PySimpleGUI.PySimpleGUI upgrade
 ```
 
 You can run the packages directly by using:
 ```sh
-pyton -m apcgui
+python -m apcgui
 ```
 
 You can install a developer version by using:
@@ -48,15 +52,15 @@ If you want to build from a wheel:
 ```sh
 pip install -U build
 python -m build
-pip install dist/apc-0.1.0-py3-none-any.whl
+pip install dist/apc-1.4.0-py3-none-any.whl
 ```
 
 If you want to build directly from GitHub:
 ```sh
-pip install -e git+https://github.com/rollerb/apc.git#egg=apc
+pip install -e git+https://github.com/RyMaxim/apc.git#egg=apc
 ```
 
-If you want to build an executable (i.e., from Windows):
+If you want to build an executable (for Windows):
 ```sh
 pip install -U pyinstaller
 pyinstaller --noconsole --add-data "apc/config;config" --add-data "apc/locale;locale" --add-data "apcgui/locale;locale" apcgui.py

apc/config.py

@@ -21,11 +21,11 @@ def get_languages() -> list:
     use_languages = env_language.split(':')
   else:
     use_languages = [default_locale]
-  
-  use_languages = list(filter(lambda x: x in SUPPORTED_LANGUAGES, use_languages))  
+
+  use_languages = list(filter(lambda x: x in SUPPORTED_LANGUAGES, use_languages))
   if len(use_languages) == 0:
     use_languages = ["en_US"]
-    
+
   return (default_locale, use_languages)
 
 LOCALE_PATH = Path(getattr(sys, '_MEIPASS', Path(__file__).resolve().parent)) / "locale/"
@@ -317,6 +317,10 @@ def _find_saves_path() -> str:
 # TODO: diamonds that can be both genders need different weight / score values
 # TODO: kangaroos with multiple white furs
 # TODO: crocodiles with multiple spots
+# TODO: wild hogs with multiple light brown variants
+# TODO: bengal tigers with multiple pseudo leucistic and pseudo melanistic variants
+# TODO: tahr great one
+# TODO: missing great one furs
 
 class Reserve(str, Enum):
    hirsch = "hirsch"
@@ -332,6 +336,8 @@ class Reserve(str, Enum):
    mississippi = "mississippi"
    revontuli = "revontuli"
    newengland = "newengland"
+   emerald = "emerald"
+   sundarpatan = "sundarpatan"
 
 class Strategy(str, Enum):
    go_all = "go-all"
@@ -352,6 +358,7 @@ class GreatOnes(str, Enum):
    whitetail_deer = "whitetail_deer"
    red_deer = "red_deer"
    fallow_deer = "fallow_deer"
+   tahr = "tahr"
 
 class Levels(int, Enum):
   TRIVIAL = 1
@@ -364,7 +371,7 @@ class Levels(int, Enum):
   MYTHICAL = 8
   LEGENDARY = 9
   GREAT_ONE = 10
-  
+
 def get_level_name(level: Levels):
   if level == Levels.TRIVIAL:
    return translate("Trivial")
@@ -388,11 +395,36 @@ def get_level_name(level: Levels):
     return translate("Great One")
   return None
 
+def get_difficulty(difficulty: str):
+  match difficulty:
+    case "Trivial":
+      return 1
+    case "Minor":
+      return 2
+    case "Very Easy":
+      return 3
+    case "Easy":
+      return 4
+    case "Medium":
+      return 5
+    case "Hard":
+      return 6
+    case "Very Hard":
+      return 7
+    case "Mythical":
+      return 8
+    case "Legendary":
+      return 9
+    case "Great One":
+      return 10
+    case _:
+      return None
+
 def format_key(key: str) -> str:
   key = [s.capitalize() for s in re.split("_|-", key)]
   return " ".join(key)
 
-def load_config(config_path: Path) -> int: 
+def load_config(config_path: Path) -> int:
   config_path.read_text()
 
 def get_save_path() -> Path:
@@ -450,7 +482,7 @@ def get_reserve_species_name(species_key: str, reserve_key: str) -> str:
   renames = get_reserve_species_renames(reserve_key)
   species_key = renames[species_key] if species_key in renames else species_key
   return get_species_name(species_key)
-  
+
 def get_reserve_name(key: str) -> str:
   return translate(RESERVE_NAMES[key]["reserve_name"])
 
@@ -459,7 +491,7 @@ def reserve_keys() -> list:
 
 def reserves(include_keys = False) -> list:
    keys = list(dict.keys(RESERVES))
-   return [f"{get_reserve_name(r)}{' (' + r + ')' if include_keys else ''}" for r in keys]  
+   return [f"{get_reserve_name(r)}{' (' + r + ')' if include_keys else ''}" for r in keys]
 
 def get_reserve(reserve_key: str) -> dict:
   return RESERVES[reserve_key]
@@ -472,7 +504,7 @@ def get_species(species_key: str) -> dict:
 
 def get_diamond_gender(species_key: str) -> str:
   species_config = get_species(species_key)["diamonds"]
-  return species_config["gender"] if "gender" in species_config else "male"  
+  return species_config["gender"] if "gender" in species_config else "male"
 
 def _get_fur(furs: dict, seed: int) -> str:
   try:
@@ -512,14 +544,14 @@ def valid_fur_species(species_key: str) -> bool:
 def get_population_file_name(reserve: str):
     index = RESERVES[reserve]["index"]
     return f"animal_population_{index}"
-  
+
 def get_population_reserve_key(filename: str):
   for _reserve, details in RESERVES.items():
     reserve_filename = f"animal_population_{details['index']}"
     if reserve_filename == filename:
       return _reserve
   return None
-  
+
 def get_population_name(filename: str):
   for _reserve, details in RESERVES.items():
     reserve_filename = f"animal_population_{details['index']}"