v3 packaging, PI hooks

.github/workflows/InfinityAutoPackager.yaml

@@ -0,0 +1,35 @@
+# Infinity Auto Packager by AL|EN (alienquake@hotmail.com)
+# A tool that automatically generates Infinity Engine mod packages when you publish a release.
+
+on:
+  release:
+    types: [published]
+jobs:
+  InfinityAutoPackager:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Initial setup
+        run: |
+          git lfs uninstall
+          git config --global core.autocrlf false
+          git config --global core.ignorecase true
+
+      - name: Clone repository using 'github.ref' from release
+        uses: actions/checkout@master
+
+      - name: Create Infinity Engine Mod Packages (.iemod and .zip)
+        uses: ALIENQuake/CreateIEModZipPackage@master
+        id: CreateIEModZipPackage
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Upload iemod package to latest release
+        uses: svenstaro/upload-release-action@v1-release
+        if: github.ref != 'refs/heads/master'
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }}
+          file: ${{ steps.CreateIEModZipPackage.outputs.PackageBaseName }}.iemod
+          asset_name: ${{ steps.CreateIEModZipPackage.outputs.PackageBaseName }}.iemod
+          tag: ${{ github.ref }}
+          overwrite: true

hannah_portraits/hannah_portraits.ini

@@ -0,0 +1,39 @@
+# Never copy this from other mod, always use https://github.com/ALIENQuake/ProjectInfinity/wiki/Adding-metadata-for-mod
+# Filename must be the same as tp2 basename, placed at the same folder where
+# .tp2 file is located, use UTF8 (without BOM) encoding, everything is optional
+
+# ini section header is required to avoid false detection
+[Metadata]
+
+# Full name of the mod, without the version number, without the list of supported games
+Name = Hannah's Portrait Pack
+
+# Author name or nick, don't use an email address
+Author = Hannah Wallace; packaged by DavidW
+
+# Short description of the mod, main goals, features etc
+Description = This is a package to provide additional custom portraits for assignment to your Player Character (PC). It contains no additional content and does not touch your installation.
+
+# Web address of mod readme file (filename is case-sensitive!) You can link to txt, md, html, pdf etc.
+Readme = https://gibberlings3.github.io/Documentation/readmes/readme-hannah_portraits.html, https://gibberlings3.github.io/Documentation/readmes/readme-hannah_portraits-french.html
+
+# Web address of mod dedicated forum or forum thread 
+Forum = https://www.gibberlings3.net/forums/forum/28-miscellaneous-released-mods/
+
+# Web address of mod personal Homepage, no need to duplicate with a mod dedicated forum
+Homepage = https://www.gibberlings3.net/gallery/album/19-hannahs-portrait-pack/
+
+# if you use GitHub.com, simply use https://github.com/AccountOrOrgName/RepositoryName
+# read more about Delta Updates https://github.com/ALIENQuake/ProjectInfinity/wiki/Delta-Updates-for-mods-hosted-at-Github
+Download = https://github.com/Gibberlings3/Hannahs_Portrait_Pack
+
+# Type of LABELs used by the mod, read more here https://www.gibberlings3.net/forums/topic/32516-tutorial-what-is-label
+LabelType = GloballyUnique
+
+# Dynamic Install Order, use mod ID as tp2 name without file extension and `setup-` prefix
+
+# This mod must be installed *before* the mods listed after the keyword
+Before = 
+
+# This mod must be installed *after* the mods listed after the keyword
+After = bg2fixpack

hannah_portraits/readme-hannah_portraits-french.html

@@ -78,7 +78,7 @@ <h2>Installation</h2>
       <p><strong>Note spéciale pour Siege of Dragonspear fourni par Steam/GOG<br />
       </strong>Good Old Games (GOG) et Steam fournissent le contenu de Siege of Dragonspear dans un format que WeiDU, l'outil utilisé pour installer ce mod, ne peut pas reconnaitre. Vous devez donc lancer l'utilitaire <a href="https://github.com/Argent77/A7-DlcMerger/releases">DLC Merger</a> dans votre répertoire de SoD avant d'installer ce mod, ou tout autre mod utilisant WeiDU.</p>
       <p><strong>Note pour les jeux en Édition Améliorée (EE)</strong><br />
-         Les Éditions améliorées sont des jeux que le développeur fait encore évoluer, notamment par l'ajout de capacités supplémentaires destinées à la création de mods et par l'ajout de contenus. N'oubliez pas que chaque patch de mise à jour effacera les mods que vous avez installés ! Ce mod ne fera pas exception à la règle.<br>
+         Les Éditions améliorées sont des jeux que le développeur fait encore évoluer, notamment par l'ajout de capacités supplémentaires destinées à la création de mods et par l'ajout de contenus. N'oubliez pas que chaque patch de mise à jour effacera les mods que vous avez installés ! Ce mod ne fera pas exception à la règle.<br />
 		 Si vous pouvez retarder la mise à jour du patch en plein milieu d'un partie moddée (si vous en avez la possibilité, notamment chez Beamdog et Good Old Games), n'oubliez pas que même après avoir réinstallé les mods sur un nouveau patch, vous ne pourrez peut-être pas continuer le jeu avec vos anciennes sauvegardes, en particulier à cause de noms de personnages, de lieux, etc, qui pourraient être incorrects. Pour y remédier, copiez tout le dossier du jeu dans un nouveau dossier dans lequel vous installerez vos mods, et qui ne sera pas modifié par les patches de mise à jour. Il est important que vous installiez le mod dans la version linguistique dans laquelle vous jouez. Sinon, les dialogues du mod ne s'afficheront pas et provoqueront des messages d'erreur.</p>
       <p><strong>Windows</strong><br />
         Le Pack de portraits de Hannah pour Windows est livré et installé avec WeiDU, et est diffusé sous forme d'archive auto-extractible. Pour l'installer, il suffit de double-cliquer sur l'archive et de suivre les instructions affichées à l'écran.</p>
@@ -123,7 +123,7 @@ <h2>Historique des versions</h2>
     <div class="section">
       <p>Note du traducteur : l'historique n'est volontairement pas entièrement traduit afin de faciliter la mise à jour continue du mod.</p>
 
-      <p><strong>Version 3 - March nn, 2022</strong></p>
+      <p><strong>Version 3 - March 7, 2022</strong></p>
       <ul>
         <li>Added French translation (Gwendolyne)</li>
         <li>Readme: fixed out-dated links</li>

hannah_portraits/readme-hannah_portraits.html

@@ -67,25 +67,24 @@ <h2>Installation</h2>
     <div class="ribbon_triangle_h2-l"></div>
     <div class="ribbon_triangle_h2-r"></div>
     <div class="section">
+      <p>First time installing a mod? Check out G3's comprehensive tutorial: <a href="https://www.gibberlings3.net/forums/topic/33164-a-new-player&rsquo;s-guide-to-installing-and-playing-mods/">A New Player&rsquo;s Guide to Installing and Playing Mods</a>.</p>
       <p><strong>Special Note for Siege of Dragonspear from Steam/GOG<br />
-      </strong>Good Old Games (GOG) and Steam both package the additional content for Siege of Dragonspear in a method that WeiDU, the tool used to install this mod, cannot access. You must run a program called <a href="https://forums.beamdog.com/discussion/50441/modmerge-merge-your-steam-gog-zip-based-dlc-into-something-weidu-nearinfinity-dltcep-can-use/p1">Modmerge</a> on your SoD installation  before you can install this or any other WeiDU-based mod.</p>
+      </strong>Good Old Games (GOG) and Steam both package the   additional content for Siege of Dragonspear in a method that WeiDU, the   tool used to install this mod, cannot access. You must  run a program   called <a href="https://github.com/Argent77/A7-DlcMerger/releases">DLC Merger</a> on your SoD installation  before you can install this or any other WeiDU-based mod.</p>
       <p><strong>Enhanced Editions Note</strong><br />
-        The Enhanced Editions are actively supported games. Please note that every patch update will wipe your current mod setup! If in the middle of a modded game you might want to delay the patch update (if possible) as even after reinstalling the mods, you might not be able to continue with your old savegames. Alternatively, copy the whole game's folder into a new one that can be modded and will stay untouched by game patches. For BG:EE it is important that you install the mod to the language version you are playing the game in. Otherwise, the dialogues of the mod will not show but give error messages.</p>
+        The Enhanced Editions are actively supported games. Please note   that every patch update will wipe your current mod setup! If in the   middle of a modded game you might want to delay the patch update (if   possible) as even after reinstalling the mods, you might not be able to   continue with your old savegames. Alternatively, copy the whole game's   folder into a new one that can be modded and will stay untouched by game   patches. It is important that you install the mod to the language   version you are playing the game in. Otherwise, the dialogues of the mod   will not show but give error messages.</p>
       <p><strong>Windows</strong><br />
-        Hannah's Portrait Pack for Windows is distributed as a self-extracting archive and includes a WeiDU installer. To install, simply double-click the archive and follow the instructions on screen.</p>
+        Hannah's Portrait Pack for Windows is distributed   as a self-extracting archive and includes a WeiDU   installer. To   install, simply double-click the archive and follow the instructions on   screen.</p>
       <p>Alternatively, the files can be extracted into your game directory using <a href="https://www.7-zip.org/download.html">7zip</a> or <a href="https://www.rarlab.com/download.htm">WinRAR</a>. When properly extracted, your game directory will contain <strong>setup-hannah_portraits.exe</strong> and the folder <strong>hannah_portraits</strong>. To install, double-click <strong>setup-hannah_portraits.exe</strong> and follow the instructions on screen.</p>
       <p>You can run <strong>setup-hannah_portraits.exe</strong> in your game folder to reinstall, uninstall or otherwise change components.</p>
       <p><strong>macOS</strong><br />
-        The Hannah's Portrait Pack for macOS is distributed as a compressed tarball and includes a WeiDU installer.</p>
+        Hannah's Portrait Pack for macOS is distributed as a compressed tarball and includes a WeiDU installer.</p>
       <p>First, extract the files from the tarball into your game directory. When properly extracted, your game directory will contain <strong>setup-hannah_portraits</strong>, <strong>setup-hannah_portraits.command</strong>, and the folder <strong>hannah_portraits</strong>. To install, double-click <strong>setup-hannah_portraits.command</strong> and follow the instructions on screen.</p>
       <p>You can run <strong>setup-hannah_portraits.command</strong> in your game folder to reinstall, uninstall or otherwise change components.</p>
       <p><strong>Linux</strong><br />
-        The Hannah's Portrait Pack for Linux is distributed as a compressed tarball and does not include a WeiDU installer.</p>
-      <p>Extract the contents of the mod to the folder of the game you wish to modify.</p>
-      <p>Download the latest version of WeiDU for Linux from <a href="https://www.weidu.org/%7Ethebigg/">WeiDU.org</a> and copy WeiDU and WeInstall to /usr/bin. Following that, open a terminal, cd to your game installation directory, run tolower and answer Y to both queries. You can avoid running the second option (linux.ini) if you've already ran it once in the same directory. To save time, the archive is already tolowered, so there's no need to run the first option (lowercasing file names) either if you've extracted only this mod since the last time you lowercased file names. If you're unsure, running tolower and choosing both options is the safe bet.</p>
-      <p>To install, run WeInstall hannah_portraits in your game folder. Then run wine BGMain.exe and start playing.</p>
+        Hannah's Portrait Pack for Linux is distributed as a   compressed tarball and does not include a WeiDU installer. Linux users   will need to do a one-time install of <abbr title="Weimer Dialogue Utility">WeiDU</abbr> (and a few other adjustments) as described in <a href="https://moebiusproject.gitlab.io/mods_on_linux" rel="external nofollow noopener" target="_blank">this great writeup</a>.</p>
+      <p>To install, run 'WeInstall hannah_portraits in your game folder.</p>
       <p><strong> Note for Complete Uninstallation</strong><br />
-        In addition to the methods above for removing individual components, you can completely uninstall the mod using setup-hannah_portraits --uninstall at the command line to remove all components without wading through prompts.</p>
+        In addition to the methods above for removing individual   components, you can completely uninstall the mod using   setup-hannah_portraits --uninstall at the command line to remove all   components without wading through prompts. </p>
     </div>
     <div class="ribbon_rectangle_h2"><a id="Contents" name="Contents"></a>
       <h2>Contents</h2>
@@ -109,7 +108,7 @@ <h2>Version History</h2>
     <div class="ribbon_triangle_h2-l"></div>
     <div class="ribbon_triangle_h2-r"></div>
     <div class="section">
-      <p><strong>Version 3 - March nn, 2022</strong></p>
+      <p><strong>Version 3 - March 7, 2022</strong></p>
       <ul>
         <li>Added French translation (Gwendolyne)</li>
         <li>Readme: fixed out-dated links</li>

hannah_portraits/setup-hannah_portraits.tp2

@@ -1,4 +1,4 @@
-BACKUP ~hannah_portraits/backup~
+BACKUP ~weidu_external/hannah_portraits/backup~
 SUPPORT ~https://www.gibberlings3.net/forums/forum/28-miscellaneous-released-mods/~
 
 VERSION ~v3~
@@ -17,9 +17,11 @@ END
 README ~hannah_portraits/readme-hannah_portraits-%LANGUAGE%.html~ ~hannah_portraits/readme-hannah_portraits.html~
 
 LANGUAGE ~English~  ~english~ ~hannah_portraits/lang/english/setup.tra~
-LANGUAGE ~Francais~ ~french~  ~hannah_portraits/lang/french/setup.tra~
+LANGUAGE ~Francais~ ~french~  ~hannah_portraits/lang/english/setup.tra~
+                              ~hannah_portraits/lang/french/setup.tra~
 
 BEGIN @0 DESIGNATED 10
+LABEL ~cd_hannah_portraits~
 
 ACTION_FOR_EACH file IN ~hw#dar1~ ~hw#dar2~ ~hw#drow~ ~hw#elf~ ~hw#fair~ ~hw#man~ BEGIN
 

package_mod.bat

@@ -6,7 +6,7 @@ call "%~dp0..\ModPackaging\utilities\ie_games.bat"
 
 REM /* MODIFY: set the values of the 3 variables below to reflect the current mod version */
 set "mod_name=Hannah's Portrait Pack"
-set mod_version=v2
+set mod_version=v3
 set mod_folder=hannah_portraits
 
 REM /* MODIFY: list here which IE games the mod is compatible with, from this list of possibilities: */