From 5f89a7692abc73b8a10c294fe38a27fbd6d1d900 Mon Sep 17 00:00:00 2001
From: passivestar <60579014+passivestar@users.noreply.github.com>
Date: Wed, 20 Nov 2024 00:46:34 +0400
Subject: [PATCH] Update README.md
---
README.md | 38 ++++++++++++++++----------------------
1 file changed, 16 insertions(+), 22 deletions(-)
diff --git a/README.md b/README.md
index 5b098b7..5e1191f 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,29 @@
+
+
-# Minimal Godot Theme
-
+# Godot Minimal Theme
-
-
-## Installation
+## Versions
-- Go to [Releases](https://github.com/passivestar/godot-minimal-theme/releases) and download the `.tres` file for your version. Use the high ppi file for high pixel density displays (i.e if you're using a laptop with a high-resolution display and in-engine display scale over 100%)
-- In Godot open `Editor Settings -> Interface -> Theme`, and choose the downloaded theme in the `Custom Theme` field.
-- A message will pop up saying: "The editor must be restarted for the changes to take effect." with a "Save & Restart" button. If desired, the Base Color, Accent Color, etc. in [Recommended settings](https://github.com/passivestar/godot-minimal-theme?tab=readme-ov-file#recommended-settings) can be adjusted before doing so. When ready, click "Save & Restart".
+- For Godot **4.4** and newer use version [1.7.0](https://github.com/passivestar/godot-minimal-theme/releases/tag/1.7.0)
+- 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)
-## Versions
+## Installation
-- For Godot 4.2.x use this version: [1.2.1](https://github.com/passivestar/godot-minimal-theme/releases/tag/1.2.1)
-- For Godot 4.3.x and newer use this version: [1.6.0](https://github.com/passivestar/godot-minimal-theme/releases/tag/1.6.0)
+1. Go to [Releases](https://github.com/passivestar/godot-minimal-theme/releases) and download the `.tres` file for your version. Use the high ppi file 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`
## Recommended settings
-To match the look of the theme in the screenshot use the following settings:
-
`Editor Settings -> Interface -> Theme`:
- Base Color: `#252525`
- Accent Color: `#569eff`
-- Contrast: `0.2`
+- Contrast: `0.3`
- Icon Saturation: `2`
- Corner Radius: `4`
@@ -32,14 +31,9 @@ To match the look of the theme in the screenshot use the following settings:
- Main Font: [Inter](https://rsms.me/inter/)
-## Compatibility
-
-If you're using a different base color rather than the recommended one (non-monochrome), input fields may look wrong. I did my best to support all editor settings, however, as of today, some things in Godot just can't be themed. There's no way to style `LineEdit`s with support for different base colors
+> [!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
-**Gamefromscratch** made a video showing the evolution of Godot UI over the years and explaining how to use this theme
-
-You can watch it on YouTube by clicking this:
-
-
+You can watch a short [overview video](https://youtu.be/WmZq3UgOGKY) of this theme made by **Gamefromscratch**.