Skip to content

Commit

Permalink
update readme and copied readme to addon folder
Browse files Browse the repository at this point in the history
  • Loading branch information
3ddelano committed Jan 18, 2022
1 parent 9c8b1f5 commit 0c02222
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 2 deletions.
21 changes: 21 additions & 0 deletions addons/draw_anywhere/LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Delano Lourenco

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
87 changes: 87 additions & 0 deletions addons/draw_anywhere/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
Draw Anywhere (Godot Editor)
=========================================
###### (Get it from Godot Asset Library - Coming soon)


### Draw anyhere in the Godot Editor. Supports multiple pen sizes and colors.

<img alt="Godot3" src="https://img.shields.io/badge/-Godot >= 3.2.2-478CBF?style=for-the-badge&logo=godotengine&logoWidth=20&logoColor=white" />
<br>


<img src="https://cdn.discordapp.com/attachments/360062738615107605/932968729208315955/plugin_icon.png" height="400">


Features
--------------

- Floating, draggable toolbar
- Change pen size and color
- Draw over Popups
- Easy keyboard shortcuts

Automatic Installation
--------------
Simply download and install the plugin from the `AssetLib` in the Godot Editor. Then goto `ProjectSettings` and enable it in the `Plugins` tab.

Manual Installation
--------------

This is a regular plugin for Godot.
Copy the contents of `addons/draw_anywhere/` into the `res://addons/draw_anywhere/` folder which is in your project directory. Then goto `ProjectSettings` and enable it in the `Plugins` tab.

**Optional:** To exclude the plugin when exporting your project, you can add `addons/draw_anywhere/*` to the `Filters to exclude files/folders from project` in the Export settings.

<img src="https://cdn.discordapp.com/attachments/360062738615107605/932954254740717578/unknown.png" height="250">

Usage
--------------

<img src="https://cdn.discordapp.com/attachments/360062738615107605/932968493891084318/unknown.png" height="75">

Once the plugin is enabled, a new floating toolbar will appear. This toolbar has:

| Button | Description |
| ------------ | ------------------------ |
| Help button | Shows keyboard shortcuts |
| Clear button | Clears the drawing |
| Pen button | Chooses the pen tool |
| Size slider | Changes the pen size |
| Color picker | Changes the pen color |

When draw mode is active, an indicator will be shown in the bottom-left of the screen.

Keyboard Shortcuts
--------------

### Global shortcuts

| Shortcut | Description |
| -------------------------------- | ---------------- |
| Ctrl + **`** (Ctrl + left quote) | Toggle draw mode |

### Draw mode shortcuts
These shortcuts will only work when draw mode is active

| Shortcut | Description |
| ----------- | -------------------------- |
| Left Click | Draw line |
| Right Click | Exit draw mode |
| C | Clear all lines |
| Z | Clear last line |
| R | Reset the toolbar position |


Limitations?
--------------
**The global keyboard shortcut will work anywhere**.

The toolbar will work everywhere except when there is a popup open eg. in EditorSettings, in ProjectSettings, etc.
(not really a limitation since you can use the global keyboard shortcut to enable Draw mode)

### Support the project development
<a href="https://www.buymeacoffee.com/3ddelano" target="_blank"><img height="41" width="174" src="https://cdn.buymeacoffee.com/buttons/v2/default-red.png" alt="Buy Me A Coffee" width="150" ></a>
<br>
Want to support in other ways? Contact me on Discord: `@3ddelano#6033`

For bugs / suggestions do join: [3ddelano Cafe](https://discord.gg/FZY9TqW)
3 changes: 2 additions & 1 deletion addons/draw_anywhere/plugin.gd
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Annotate - Draw in Editor
# Draw Anywhere - Godot plugin
# Author: Delano (3ddelano) Lourenco
# https://github.com/3ddelano
# For license: See LICENSE.md


tool
Expand Down
2 changes: 1 addition & 1 deletion addons/draw_anywhere/scenes/Toolbar.tscn
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ margin_top = 2.0
margin_right = 324.0
margin_bottom = 198.0
theme = ExtResource( 4 )
window_title = "Annotate Shortcuts"
window_title = "Draw Anywhere Shortcuts"

[node name="MC" type="MarginContainer" parent="HelpPopup"]
anchor_right = 1.0
Expand Down

0 comments on commit 0c02222

Please sign in to comment.