From 72c780424a2bbad6425ca0f163be9725c6bd2bb1 Mon Sep 17 00:00:00 2001 From: passivestar <60579014+passivestar@users.noreply.github.com> Date: Thu, 26 Dec 2024 23:30:56 +0400 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++----------------------- 1 file changed, 12 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index e6122e4..7140567 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,33 @@ ![minimal-theme](https://github.com/user-attachments/assets/75df90f3-4bf6-464c-b59b-5a8a169cfa7b) ![minimal-theme-window](https://github.com/user-attachments/assets/55f548fc-8942-401a-970b-9869150ca9f8) - -_Demo scene credit: https://github.com/Jamsers/Bistro-Demo-Tweaked_ - ---- - - # Godot Minimal Theme -## Versions - -- For Godot **4.4** and newer use the [latest version](https://github.com/passivestar/godot-minimal-theme/releases/latest) -- For Godot **4.3** use version [1.6.0](https://github.com/passivestar/godot-minimal-theme/releases/tag/1.6.0) -- For Godot **4.2** use version [1.2.1](https://github.com/passivestar/godot-minimal-theme/releases/tag/1.2.1) - ## Installation -1. Download the `.tres` file of the [latest version](https://github.com/passivestar/godot-minimal-theme/releases/latest) of the theme. Use the `_high_ppi.tres` version if you're using in-engine display scale of over **100%** (for example if you're using a laptop with a high pixel density display) -2. In Godot open `Editor Settings -> Interface -> Theme`, and choose the downloaded theme in the `Custom Theme` field -3. Set the theme settings like in the [Recommended settings](https://github.com/passivestar/godot-minimal-theme?tab=readme-ov-file#recommended-settings) below -4. Click `Save & Restart` +1. Download the `minimal_theme.tres` file of the [latest version](https://github.com/passivestar/godot-minimal-theme/releases/latest). +2. Open `Editor Settings -> Interface -> Theme` and choose the downloaded file in the `Custom Theme` field. +3. Click `Save & Restart`. ## Recommended settings +As of **2.0** this theme supports editor settings so you can experiment and choose whatever values you like! + +Here are my personal recommendations: + `Editor Settings -> Interface -> Theme`: -- Base Color: `#252525` +- Base Color: `#252525` or `#22262B` - Accent Color: `#569eff` - Contrast: `0.3` - Icon Saturation: `2` -- Corner Radius: `4` +- Corner Radius: `5` `Editor Settings -> Interface -> Editor`: - Main Font: [Inter](https://rsms.me/inter/) -> [!IMPORTANT] -> You can experiment with different values but keep in mind that some UI elements will look out of place if you use a different `Base Color`, especially a non-monochrome one. `Accent Color`, `Icon Saturation` and `Font` are safe to change to any value. `Corner Radius` needs to be set to `4` for the nested resources to match the corner radius of the theme. It's not customizable. This is a limitation of Godot theming capabilities. - -## Overview +## Credits -You can watch a short [overview video](https://youtu.be/WmZq3UgOGKY) of this theme made by **Gamefromscratch**. +- The idea for embedding theme generation code into the resource to support editor settings was suggested by [Yuri Sizov](https://github.com/YuriSizov). You can read his article about it [here](https://humnom.net/thoughts/6765836d-make-smarter-editor-themes-in-godot.html). +- Demo scene from the screenshot: https://github.com/Jamsers/Bistro-Demo-Tweaked.