Update README.md
This commit is contained in:
parent
d985ac70bf
commit
77756efa9d
107
README.md
107
README.md
|
@ -1,107 +1,22 @@
|
||||||
# UI Design Tool
|
# Cliff_Hanger
|
||||||
|
|
||||||
![Toolbar](screenshots/ui_design_tool_preview.gif "Toolbar")
|
This game was made for the Game Endeavours Discord Game Jam!
|
||||||
|
|
||||||
Intuitive UI design workflow in Godot.
|
Traverse the different levels of this huge cave, in less than 12 seconds, or else, you die!
|
||||||
|
|
||||||
Import/manage font source files and styling UI directly in the editor viewport.
|
For some reason tho, time doesnt seem to keep going when you grab on ledges and maybe some other things, idk.
|
||||||
|
|
||||||
## Features
|
Make sure to collect all of those shiny diamond thingies, they surely are important for you, I assure you!
|
||||||
|
|
||||||
- Overlay Text Editor
|
|
||||||
- Toolbar(Support batch edit):
|
|
||||||
- Font:
|
|
||||||
- Import and manage TrueType fonts(.ttf)
|
|
||||||
- Font family
|
|
||||||
- Font weight
|
|
||||||
- Font size
|
|
||||||
- Font color
|
|
||||||
- Highlight
|
|
||||||
- Horizontal/Vertical alignment
|
|
||||||
- Font Style/Formatting(Typography hierarchy)
|
|
||||||
- Utilities:
|
|
||||||
- Clear font
|
|
||||||
- Clear color
|
|
||||||
- Rect size refresh
|
|
||||||
|
|
||||||
> For more detail list, check [CHANGELOG.md](CHANGELOG.md)
|
# Controls:
|
||||||
|
|
||||||
## Installation
|
SPACE to pause
|
||||||
|
|
||||||
- Install directly from Godot Asset Library
|
Z / ENTER to select an option in menus
|
||||||
|
|
||||||
or
|
AD / LR Arrows = Movement (AZERTY Support too)
|
||||||
|
|
||||||
- Download this respository,
|
Z/J = Jumping
|
||||||
1. Move `addons/ui_design_tool` to your `{project_dir}`
|
|
||||||
2. Enable it from Project -> Settings -> Plugins
|
|
||||||
|
|
||||||
## Usage
|
Grab to ledges to stop time
|
||||||
|
|
||||||
### Toolbar
|
|
||||||
|
|
||||||
![Show Overlay Text Editor](screenshots/toolbar_preview.png "Show Overlay Text Editor")
|
|
||||||
|
|
||||||
Select any `Control` node will show the toolbar at the bottom of 2D screen viewport, otherwise, it will stay hidden.
|
|
||||||
Select multiple nodes to edit simultaneously.
|
|
||||||
|
|
||||||
### Overlay Text Editor
|
|
||||||
|
|
||||||
![Show Overlay Text Editor](screenshots/overlay_text_editor_preview.gif "Show Overlay Text Editor")
|
|
||||||
|
|
||||||
Double click on `Control` node with `text` property(`Label`, `Button`, `RichTextLabel`, etc...) will show overlay text editor at mouse position.
|
|
||||||
|
|
||||||
### Import TrueType Font(.ttf)
|
|
||||||
|
|
||||||
Click on ![Open Font Directory](addons/ui_design_tool/assets/icons/folder_open-white-18dp.svg "Open Font Directory Icon") to select the root directory where your font source directories located.
|
|
||||||
|
|
||||||
Make sure the selected directory and filenames are structured as below:
|
|
||||||
- {root_dir}
|
|
||||||
- {font_dir}
|
|
||||||
- {font_filename}{- or _}{weight_name}
|
|
||||||
- ...
|
|
||||||
- ...
|
|
||||||
|
|
||||||
Example:
|
|
||||||
- fonts/
|
|
||||||
- Arial/
|
|
||||||
- Arial-Regular.ttf
|
|
||||||
- Arial-Bold.ttf
|
|
||||||
- Arial-Italic.ttf
|
|
||||||
- Arial-BoldItalic.ttf
|
|
||||||
- Courier/
|
|
||||||
- Courier_Regular.ttf
|
|
||||||
- Courier_Bold.ttf
|
|
||||||
- Courier_Italic.ttf
|
|
||||||
- Courier_BoldItalic.ttf
|
|
||||||
- ...
|
|
||||||
|
|
||||||
> Folder name of the font will be used as the font name in toolbar
|
|
||||||
|
|
||||||
Click on ![Refresh Font Directory](addons/ui_design_tool/assets/icons/refresh-white-18dp.svg "Refresh Font Directory Icon") to refresh the font list upon any changes made to the font sources.
|
|
||||||
|
|
||||||
Supported weight names (non case sensitive)
|
|
||||||
|
|
||||||
- thin
|
|
||||||
- extralight
|
|
||||||
- light
|
|
||||||
- regular
|
|
||||||
- medium
|
|
||||||
- semibold
|
|
||||||
- bold
|
|
||||||
- extrabold
|
|
||||||
- black
|
|
||||||
- extrablack
|
|
||||||
|
|
||||||
Supported italic weight names (non case sensitive):
|
|
||||||
|
|
||||||
- thinitalic
|
|
||||||
- extralightitalic
|
|
||||||
- lightitalic
|
|
||||||
- regularitalic/italic
|
|
||||||
- mediumitalic
|
|
||||||
- semibolditalic
|
|
||||||
- bolditalic
|
|
||||||
- extrabolditalic
|
|
||||||
- blackitalic
|
|
||||||
- extrablackitalic
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user