Merge pull request #231 from Ate329/master

Add custom resolution option and fix ImageMagick dependency

README.md

@@ -1,51 +1,46 @@
 ![banner](banner.png?raw=true)
 
 ## Installation:
-
 Usage:  `sudo ./install.sh [OPTIONS...]`
-
 ```
   -t, --theme                 theme variant(s)          [tela|vimix|stylish|whitesur]       (default is tela)
   -i, --icon                  icon variant(s)           [color|white|whitesur]              (default is color)
   -s, --screen                screen display variant(s) [1080p|2k|4k|ultrawide|ultrawide2k] (default is 1080p)
-  -r, --remove    Remove theme              [tela|vimix|stylish|whitesur]       (must add theme name option, default is tela)
+  -c, --custom-resolution     set custom resolution     (e.g., 1600x900)                    (disabled in default)
+  -r, --remove                remove theme              [tela|vimix|stylish|whitesur]       (must add theme name option, default is tela)
 
   -b, --boot                  install theme into '/boot/grub' or '/boot/grub2'
   -g, --generate              do not install but generate theme into chosen directory       (must add your directory)
 
-  -h, --help      Show this help
+  -h, --help                  show this help
 ```
-
+*If no options are used, a user interface *`dialog`* will show up instead*
-_If no options are used, a user interface `dialog` will show up instead_
 
 ### Examples:
  - Install Tela theme on 2k display device:
-
 ```sh
 sudo ./install.sh -t tela -s 2k
 ```
-
+ - Install Tela theme with custom resolution:
+```sh
+sudo ./install.sh -t tela -c 1600x900
+```
  - Install Tela theme into /boot/grub/themes:
-
 ```sh
 sudo ./install.sh -b -t tela
 ```
-
  - Uninstall Tela theme:
-
 ```sh
 sudo ./install.sh -r -t tela
 ```
 
 ## Installation with NixOS:
 To use this theme with NixOS you will have to enable [flakes](https://wiki.nixos.org/wiki/flakes). Before you do this, please inform yourself if you really want to, because flakes are still an unstable feature.
-
 First you will have to add grub2 to your `flake.nix` file as a new input.
 ```nix
 # flake.nix
 {
   description = "NixOS configuration";
-
   inputs = {
     nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
     # Add grub2 themes to your inputs ...
@@ -53,13 +48,11 @@ First you will have to add grub2 to your `flake.nix` file as a new input.
       url = "github:vinceliuice/grub2-themes";
     };
   };
-
   outputs = inputs@{ nixpkgs,  grub2-themes, ... }: {
     nixosConfigurations = {
       my_host = nixpkgs.lib.nixosSystem {
         system = "x86_64-linux";
         specialArgs = { inherit inputs; };
-
         # ... and then to your modules
         modules = [
           ./configuration.nix
@@ -70,7 +63,6 @@ First you will have to add grub2 to your `flake.nix` file as a new input.
   };
 }
 ```
-
 After that, you can configure the theme as shown below. In this example it is inside the `configuration.nix` file but it can be any file you choose.
 ```nix
 # configuration.nix
@@ -81,21 +73,19 @@ After that, you can configure the theme as shown below. In this example it is in
     enable = true;
     theme = "stylish";
     footer = true;
+    customResolution = "1600x900";  # Optional: Set a custom resolution
   };
 }
 ```
 
 ## Issues / tweaks:
-
 ### Correcting display resolution:
-
  - On the grub screen, press `c` to enter the command line
  - Enter `vbeinfo` or `videoinfo` to check available resolutions
  - Open `/etc/default/grub`, and edit `GRUB_GFXMODE=[height]x[width]x32` to match your resolution
  - Finally, run `grub-mkconfig -o /boot/grub/grub.cfg` to update your grub config
 
 ### Setting a custom background:
-
  - Make sure you have `imagemagick` installed, or at least something that provides `convert`
  - Find the resolution of your display, and make sure your background matches the resolution
    - 1920x1080 >> 1080p
@@ -106,6 +96,7 @@ After that, you can configure the theme as shown below. In this example it is in
  - Place your custom background inside the root of the project, and name it `background.jpg`
  - Run the installer like normal, but with -s `[YOUR_RESOLUTION]` and -t `[THEME]` and -i `[ICON]`
    - Make sure to replace `[YOUR_RESOLUTION]` with your resolution and `[THEME]` with the theme
+ - Alternatively, use the `-c` option to set a custom resolution
 
 ## Contributing:
  - If you made changes to icons, or added a new one:

flake.nix

@@ -30,13 +30,15 @@
           grub2-theme = pkgs.stdenv.mkDerivation {
             name = "grub2-theme";
             src = "${self}";
+            buildInputs = [ pkgs.imagemagick ];
             installPhase = ''
               mkdir -p $out/grub/themes;
               bash ./install.sh \
                 --generate $out/grub/themes \
                 --screen ${cfg.screen} \
                 --theme ${cfg.theme} \
-                --icon ${cfg.icon};
+                --icon ${cfg.icon} \
+                ${if cfg.customResolution != null then "--custom-resolution ${cfg.customResolution}" else ""}
 
               if [ -n "${splashImage}" ]; then
                 rm $out/grub/themes/${cfg.theme}/background.jpg;
@@ -61,7 +63,9 @@
               fi;
             '';
           };
-          resolution = resolutions."${cfg.screen}";
+          resolution = if cfg.customResolution != null
+            then cfg.customResolution
+            else resolutions."${cfg.screen}";
         in
         rec {
           options = {
@@ -98,6 +102,15 @@
                   The screen resolution to use for grub2.
                 '';
               };
+              customResolution = mkOption {
+                default = null;
+                example = "1600x900";
+                type = types.nullOr (types.strMatching "[0-9]+x[0-9]+");
+                description = ''
+                  Custom resolution for grub2 theme. Should be in the format "WIDTHxHEIGHT".
+                  If set, this will override the 'screen' option.
+                '';
+              };
               splashImage = mkOption {
                 default = null;
                 example = "/my/path/background.jpg";
@@ -138,11 +151,9 @@
             environment.systemPackages = [
               grub2-theme
             ];
-            boot.loader.grub =
+            boot.loader.grub = {
-              {
               theme = "${grub2-theme}/grub/themes/${cfg.theme}";
-                splashImage =
+              splashImage = "${grub2-theme}/grub/themes/${cfg.theme}/background.jpg";
-                  "${grub2-theme}/grub/themes/${cfg.theme}/background.jpg";
               gfxmodeEfi = "${resolution},auto";
               gfxmodeBios = "${resolution},auto";
               extraConfig = ''

install.sh

@@ -14,6 +14,7 @@ REO_DIR="$(cd $(dirname $0) && pwd)"
 THEME_VARIANTS=('tela' 'vimix' 'stylish' 'whitesur')
 ICON_VARIANTS=('color' 'white' 'whitesur')
 SCREEN_VARIANTS=('1080p' '2k' '4k' 'ultrawide' 'ultrawide2k')
+custom_resolution=""
 
 #################################
 #   :::::: C O L O R S ::::::   #
@@ -65,12 +66,13 @@ OPTIONS:
   -t, --theme                 theme variant(s)          [tela|vimix|stylish|whitesur]       (default is tela)
   -i, --icon                  icon variant(s)           [color|white|whitesur]              (default is color)
   -s, --screen                screen display variant(s) [1080p|2k|4k|ultrawide|ultrawide2k] (default is 1080p)
-  -r, --remove    Remove theme              [tela|vimix|stylish|whitesur]       (must add theme name option, default is tela)
+  -c, --custom-resolution     set custom resolution     (e.g., 1600x900)                    (disabled in default)
+  -r, --remove                remove theme              [tela|vimix|stylish|whitesur]       (must add theme name option, default is tela)
 
   -b, --boot                  install theme into '/boot/grub' or '/boot/grub2'
   -g, --generate              do not install but generate theme into chosen directory       (must add your directory)
 
-  -h, --help      Show this help
+  -h, --help                  show this help
 
 EOF
 }
@@ -99,6 +101,33 @@ generate() {
   cp -a --no-preserve=ownership "${REO_DIR}/config/theme-${screen}.txt" "${THEME_DIR}/${theme}/theme.txt"
   cp -a --no-preserve=ownership "${REO_DIR}/backgrounds/${screen}/background-${theme}.jpg" "${THEME_DIR}/${theme}/background.jpg"
 
+  # Function to determine which assets to use based on resolution
+  get_asset_type() {
+    local width=$(echo $1 | cut -d'x' -f1)
+    local height=$(echo $1 | cut -d'x' -f2)
+    if [ $width -le 1920 ] && [ $height -le 1080 ]; then
+      echo "1080p"
+    elif [ $width -le 2560 ] && [ $height -le 1440 ]; then
+      echo "2k"
+    else
+      echo "4k"
+    fi
+  }
+
+  # Determine which configuration file and assets to use
+  if [[ -n "$custom_resolution" ]]; then
+    asset_type=$(get_asset_type "$custom_resolution")
+    cp -a --no-preserve=ownership "${REO_DIR}/config/theme-${asset_type}.txt" "${THEME_DIR}/${theme}/theme.txt"
+    # Replace resolution in theme.txt
+    sed -i "s/[0-9]\+x[0-9]\+/${custom_resolution}/" "${THEME_DIR}/${theme}/theme.txt"
+    # Use appropriate background as base and resize it
+    cp -a --no-preserve=ownership "${REO_DIR}/backgrounds/${asset_type}/background-${theme}.jpg" "${THEME_DIR}/${theme}/background.jpg"
+    convert "${THEME_DIR}/${theme}/background.jpg" -resize ${custom_resolution}^ -gravity center -extent ${custom_resolution} "${THEME_DIR}/${theme}/background.jpg"
+  else
+    cp -a --no-preserve=ownership "${REO_DIR}/config/theme-${screen}.txt" "${THEME_DIR}/${theme}/theme.txt"
+    cp -a --no-preserve=ownership "${REO_DIR}/backgrounds/${screen}/background-${theme}.jpg" "${THEME_DIR}/${theme}/background.jpg"
+  fi
+
   # Use custom background.jpg as grub background image
   if [[ -f "${REO_DIR}/background.jpg" ]]; then
     prompt -w "\n Using custom background.jpg as grub background image..."
@@ -106,7 +135,13 @@ generate() {
     convert -auto-orient "${THEME_DIR}/${theme}/background.jpg" "${THEME_DIR}/${theme}/background.jpg"
   fi
 
-  if [[ ${screen} == 'ultrawide' ]]; then
+  # Determine which assets to use based on custom resolution or screen
+  if [[ -n "$custom_resolution" ]]; then
+    asset_type=$(get_asset_type "$custom_resolution")
+    cp -a --no-preserve=ownership "${REO_DIR}/assets/assets-${icon}/icons-${asset_type}" "${THEME_DIR}/${theme}/icons"
+    cp -a --no-preserve=ownership "${REO_DIR}/assets/assets-select/select-${asset_type}/"*.png "${THEME_DIR}/${theme}"
+    cp -a --no-preserve=ownership "${REO_DIR}/assets/info-${asset_type}.png" "${THEME_DIR}/${theme}/info.png"
+  elif [[ ${screen} == 'ultrawide' ]]; then
     cp -a --no-preserve=ownership "${REO_DIR}/assets/assets-${icon}/icons-1080p" "${THEME_DIR}/${theme}/icons"
     cp -a --no-preserve=ownership "${REO_DIR}/assets/assets-select/select-1080p/"*.png "${THEME_DIR}/${theme}"
     cp -a --no-preserve=ownership "${REO_DIR}/assets/info-1080p.png" "${THEME_DIR}/${theme}/info.png"
@@ -186,7 +221,9 @@ install() {
     fi
 
     # Make sure the right resolution for grub is set
-    if [[ ${screen} == '1080p' ]]; then
+    if [[ -n "$custom_resolution" ]]; then
+      gfxmode="GRUB_GFXMODE=${custom_resolution},auto"
+    elif [[ ${screen} == '1080p' ]]; then
       gfxmode="GRUB_GFXMODE=1920x1080,auto"
     elif [[ ${screen} == 'ultrawide' ]]; then
       gfxmode="GRUB_GFXMODE=2560x1080,auto"
@@ -645,6 +682,11 @@ while [[ $# -gt 0 ]]; do
         esac
       done
       ;;
+    -c|--custom-resolution)
+      shift
+      custom_resolution="$1"
+      shift
+      ;;
     -h|--help)
       usage
       exit 0