Skip to content

Commit 51c0f3a

Browse files
committed
Refactor the plugin demos to be inside of a project for convenience
1 parent 8464543 commit 51c0f3a

29 files changed

+158
-22
lines changed

plugins/README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,35 @@
1-
# Plugin demos
1+
# Plugin Demos
22

3-
To use these plugins, copy any of these folders to the `addons/` folder in a Godot project.
3+
This contains multiple plugin demos, all placed in a project for convenience.
4+
5+
Please see the documentation for editor plugins:
6+
https://docs.godotengine.org/en/latest/tutorials/plugins/editor/index.html
7+
8+
Language: GDScript
9+
10+
Renderer: GLES 2
11+
12+
# How does it work?
13+
14+
This project contains 3 plugins:
15+
16+
* The custom node plugin shows how to create a custom node type
17+
using `add_custom_type`. [More info](addons/custom_node).
18+
19+
* The material import plugin shows how to make a plugin handle importing
20+
a custom file type (mtxt). [More info](addons/material_import_plugin).
21+
22+
* The material creator plugin shows how to add a custom dock with some
23+
simple functionality. [More info](addons/material_creator).
24+
25+
To use these plugins in another project, copy any of these
26+
folders to the `addons/` folder in a Godot project, and then
27+
enable them in the project settings menu.
428

529
For example, the path would look like: `addons/custom_node`
630

7-
Plugins can be distributed and installed from the UI. If you make a zip that contains the folder, Godot will recognize it as a plugin and will allow you to install it.
31+
Plugins can be distributed and installed from the UI.
32+
If you make a zip that contains the folder, Godot will recognize
33+
it as a plugin and will allow you to install it.
834

935
This can be done via the terminal: `zip -r custom_node.zip custom_node/*`

plugins/addons/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# How to use
2+
3+
To use these plugins in another project, copy any of these
4+
folders to the `addons/` folder in a Godot project.
5+
6+
For example, the path would look like: `addons/custom_node`
7+
8+
Plugins can be distributed and installed from the UI.
9+
If you make a zip that contains the folder, Godot will recognize
10+
it as a plugin and will allow you to install it.
11+
12+
This can be done via the terminal: `zip -r custom_node.zip custom_node/*`
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)