Merge pull request #7 from FREEWING-JP/feature/mod_multi_merge_master

Merge master Metabolix Update change log and tag v2.1.0 da9909b

Author: FREEWING-JP

CHANGELOG.md

@@ -2,6 +2,29 @@
 
 All notable changes to this project will be documented in this file.
 
+## 2.1.0 - 2023-10-04
+
+### Added
+- Check image size, crop if it's bigger than the screen.
+- Check BitLocker status to avoid unbootable machine.
+
+## 2.0.0 - 2023-09-10
+
+### Added
+- Log to `setup.log`.
+- Image conversion (GIF, EXIF, JPG, PNG, TIFF) to BMP during setup.
+- Quiet (batch) setup.
+- Dry run in setup.
+- EFI boot entry support in setup.
+- Orientation parameter (o=0|90|180|270) for images.
+
+### Changed
+- Configure (edit config and images) before installing.
+- Escalate privileges only when needed (after the menu).
+- Try to detect and avoid some configuration errors.
+- Wait at most 15 seconds for key presses during boot.
+- Image coordinates are now relative to the center.
+
 ## 1.5.1 - 2018-08-11
 
 ### Fixed

README.md

@@ -69,55 +69,67 @@ When booting on a UEFI-based computer, Windows may show a vendor-defined logo wh
 
 * Make sure that your computer is booting with UEFI.
 * Make sure that Secure Boot is disabled, unless you know how to sign EFI applications.
+* Make sure that BitLocker is disabled, or find your recovery key.
 
 ### Windows installation
 
 * Get the latest release from the Releases page.
 * Start `setup.exe` and follow the instructions.
 	* You may need to manually disable Secure Boot and then retry.
-	* The installer will launch Notepad for modifying the configuration.
-		* If you need only one custom image, the defaults are fine.
-		* Otherwise, check out the examples in the configuration file.
-	* The installer will launch Paint for creating the image(s).
-		* You can create multiple images by using Save As.
-		* Be sure to always use the 24-bit BMP/DIB format.
+	* The installer will launch Paint for editing the image.
 	* If Windows later restores the original boot loader, just reinstall.
 	* If you wish to change the image or other configuration, just reinstall.
+	* For advanced settings, edit `config.txt` before installing. No extra support provided!
+
+### Quiet (batch) installation
+
+* Edit the `config.txt` and `splash.bmp` (or any other images) to your needs.
+* Run `setup.exe batch COMMANDS` as administrator, with some of the following commands:
+	* `install` – copy the files but don't enable.
+	* `enable-entry` – create a new EFI boot entry.
+	* `disable-entry` – disable the EFI boot entry.
+	* `enable-bcdedit` – use `bcdedit` to create a new EFI boot entry.
+	* `disable-bootmgr` – use `bcdedit` to disable the EFI boot entry.
+	* `enable-overwrite` – overwrite the MS boot loader.
+	* `disable-overwrite` – restore the MS boot loader.
+	* `allow-secure-boot` – ignore Secure Boot in subsequent commands.
+	* `allow-bitlocker` – ignore BitLocker in subsequent commands.
+	* `allow-bad-loader` – ignore bad boot loader configuration in subsequent commands.
+	* `disable` – run all relevant `disable-*` commands.
+	* `uninstall` – disable and remove completely.
+* For example, run `setup.exe batch install allow-secure-boot enable-overwrite` to copy files and overwrite the MS boot loader regardless of Secure Boot status.
 
 ### Multi-boot configurations
 
 If you only need HackBGRT for Windows:
 
-* Extract the latest release to `[EFI System Partition]\EFI\HackBGRT\`.
-* Set `boot=\EFI\Microsoft\Boot\bootmgfw.efi` in `config.txt`.
-* Point your boot loader to `\EFI\HackBGRT\bootx64.efi`.
+* Run `setup.exe`, install files without enabling.
+* Configure your boot loader to start `\EFI\HackBGRT\loader.efi`.
 
 If you need it for other systems as well:
 
-* Extract the latest release to `[EFI System Partition]\EFI\HackBGRT\`.
-* Set `boot=\EFI\your-actual-boot-loader.efi` in `config.txt`.
-* Set `\EFI\HackBGRT\bootx64.efi` as your default boot loader with `efibootmgr` or some other EFI boot manager tool.
+* Configure HackBGRT to start your boot loader (such as systemd-boot): `boot=\EFI\systemd\systemd-bootx64.efi`.
+* Run `setup.exe`, install as a new EFI boot entry.
 
-On 32-bit machines, use `bootia32.efi` instead of `bootx64.efi`.
+To install purely on Linux, you can install with `setup.exe dry-run` and then manually copy files from `dry-run/EFI` to your `[EFI System Partition]/EFI`. For further instructions, consult the documentation of your own Linux system.
 
 ## Configuration
 
-The configuration options are described in `config.txt`, which should be stored in `[EFI System Partition]\EFI\HackBGRT\config.txt`.
+The configuration options are described in `config.txt`, which the installer copies into `[EFI System Partition]\EFI\HackBGRT\config.txt`.
 
 ## Images
 
 The image path can be changed in the configuration file. The default path is `[EFI System Partition]\EFI\HackBGRT\splash.bmp`.
 
-The image must be a 24-bit BMP file with a 54-byte header. That's a TrueColor BMP3 in Imagemagick, or 24-bit BMP/DIB in Microsoft Paint.
+The installer copies and converts files whose `path` starts with `\EFI\HackBGRT\`. For example, to use a file named `my.jpg`, copy it in the installer folder (same folder as `setup.exe`) and set the image path in `config.txt` to `path=\EFI\HackBGFT\my.jpg`.
 
-Multiple images may be specified, in which case one is picked at random.
+If you copy an image file to ESP manually, note that the image must be a 24-bit BMP file with a 54-byte header. That's a TrueColor BMP3 in Imagemagick, or 24-bit BMP/DIB in Microsoft Paint.
 
-## Recovery
+Advanced users may edit the `config.txt` to define multiple images, in which case one is picked at random.
 
-If something breaks and you can't boot to Windows, you have the following options:
+## Recovery
 
-* Windows installation (or recovery) media can fix boot issues.
-* You can copy `[EFI System Partition]\EFI\HackBGRT\bootmgfw-original.efi` into `[EFI System Partition]\EFI\Microsoft\Boot\bootmgfw.efi` by some other means such as Linux or Windows command prompt.
+If something breaks and you can't boot to Windows, you need to use the Windows installation disk (or recovery disk) to fix boot issues.
 
 ## Building
 

Windows_WSL_Debian_2nd.txt

@@ -8,6 +8,9 @@ cd HackBGRT_MULTI
 
 # Download gnu-efi
 wget https://jaist.dl.sourceforge.net/project/gnu-efi/gnu-efi-3.0.12.tar.bz2
+ or
+# ERROR: The certificate of ‘jaist.dl.sourceforge.net’ is not trusted.
+wget --no-check-certificate https://jaist.dl.sourceforge.net/project/gnu-efi/gnu-efi-3.0.12.tar.bz2
 tar xvf gnu-efi-3.0.12.tar.bz2
 
 # Patch Install directory

config.txt

@@ -1,36 +1,39 @@
 # vim: set fileencoding=utf-8
 # The same options may be given also as command line parameters in the EFI Shell, which is useful for debugging.
 
-# Boot loader path. Default: backup of the Windows boot loader.
-boot=\EFI\HackBGRT\bootmgfw-original.efi
+# Boot loader path. MS = either backup or original Windows boot loader.
+boot=MS
 
 # The image is specified with an image line.
 # Multiple image lines may be present, in which case one will be picked by random.
 # The image line may contain the following parts:
 # Any of the following:
-#  - "n=[0-9]+", a weight for this image in the randomization process. Default: n=1.
-#  - "x={auto|native|[0-9]+}", the x coordinate. Default: x=auto.
-#  - "y={auto|native|[0-9]+}", the y coordinate. Default: y=auto.
+#  - "n=(number)", a weight for this image in the randomization process. Default: n=1.
+#  - "x=(number)" or "x=keep", the x offset from the center. Default: x=0.
+#  - "y=(number)" or "y=keep", the y offset from the center. Default: y=0.
+#  - "o=(0|90|180|270|keep)", the screen orientation, degrees anticlockwise. Default: o=keep.
 # One of the following:
-#  - "keep" to keep the firmware logo. Sets also x=native,y=native by default.
+#  - "keep" to keep the firmware logo. Also keeps coordinates by default.
 #  - "remove" to remove the BGRT. Makes x and y meaningless.
 #  - "black" to use only a black image. Makes x and y meaningless.
-#  - "path=..." to read a BMP file. The file must be a 24-bit BMP file with a 54-byte header.
+#  - "path=..." to read a BMP file.
+#    * NOTE: For path=\EFI\HackBGRT\*, the installer will copy and convert the file if necessary.
+#    * NOTE: For other paths, make sure that the file is a 24-bit BMP file with a 54-byte header.
 #    * NOTE: The file must be on the EFI System Partition. Do not add a drive letter!
 # Examples:
 #  - image=remove
 #  - image=black
-#  - image=x=auto,y=0,path=\EFI\HackBGRT\topimage.bmp
-#  - image=n=1,path=\EFI\HackBGRT\splash.bmp
-#  - image=n=50,path=\EFI\HackBGRT\probable.bmp
+#  - image= x=0 y=-200 path=\EFI\HackBGRT\topimage.bmp
+#  - image= n=1 o=90 path=\EFI\HackBGRT\sideways.bmp
+#  - image= n=50 y=999999 o=keep path=\EFI\HackBGRT\probable.bmp
 # The above examples together would produce
 #  - 1/54 chance for the default OS logo
 #  - 1/54 chance for black screen
-#  - 1/54 chance for topimage.bmp, centered at the top of the screen
-#  - 1/54 chance for splash.bmp, automatically positioned
-#  - 50/54 chance for probable.bmp, automatically positioned
+#  - 1/54 chance for topimage.bmp, 200 px above the center of the screen
+#  - 1/54 chance for splash.bmp, centered, orientation set to 90 degrees
+#  - 50/54 chance for probable.bmp, at the bottom edge, explicitly default orientation
 # Default: just one image.
-image=path=\EFI\HackBGRT\splash.bmp
+image= y=-200 path=\EFI\HackBGRT\splash.bmp
 
 # Preferred resolution. Use 0x0 for maximum and -1x-1 for original.
 resolution=0x0