Skip to content

Commit

Permalink
Adding images to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sci-comp committed Apr 5, 2024
1 parent d75b894 commit 96a42f3
Show file tree
Hide file tree
Showing 14 changed files with 224 additions and 2 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[remap]

importer="texture"
type="CompressedTexture2D"
uid="uid://be7f7lbsxyjkj"
path.s3tc="res://.godot/imported/scene_builder_collection_names_resource.png-963ccd0aaf1d337ef2bea67dc80c0c5c.s3tc.ctex"
metadata={
"imported_formats": ["s3tc_bptc"],
"vram_texture": true
}

[deps]

source_file="res://addons/SceneBuilder/Documentation/Image/scene_builder_collection_names_resource.png"
dest_files=["res://.godot/imported/scene_builder_collection_names_resource.png-963ccd0aaf1d337ef2bea67dc80c0c5c.s3tc.ctex"]

[params]

compress/mode=2
compress/high_quality=false
compress/lossy_quality=0.7
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=true
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/fix_alpha_border=false
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=0
Binary file added Documentation/Image/scene_builder_commands.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions Documentation/Image/scene_builder_commands.png.import
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[remap]

importer="texture"
type="CompressedTexture2D"
uid="uid://c4mvhcbkq6nur"
path.s3tc="res://.godot/imported/scene_builder_commands.png-05e433f0d32770f721f9fde3022f37a4.s3tc.ctex"
metadata={
"imported_formats": ["s3tc_bptc"],
"vram_texture": true
}

[deps]

source_file="res://addons/SceneBuilder/Documentation/Image/scene_builder_commands.png"
dest_files=["res://.godot/imported/scene_builder_commands.png-05e433f0d32770f721f9fde3022f37a4.s3tc.ctex"]

[params]

compress/mode=2
compress/high_quality=false
compress/lossy_quality=0.7
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=true
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/fix_alpha_border=false
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=0
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions Documentation/Image/scene_builder_create_items.png.import
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[remap]

importer="texture"
type="CompressedTexture2D"
uid="uid://c08qsw6iqtyjb"
path.s3tc="res://.godot/imported/scene_builder_create_items.png-47df63ee8e378b9cc65a4a2319f79f8a.s3tc.ctex"
metadata={
"imported_formats": ["s3tc_bptc"],
"vram_texture": true
}

[deps]

source_file="res://addons/SceneBuilder/Documentation/Image/scene_builder_create_items.png"
dest_files=["res://.godot/imported/scene_builder_create_items.png-47df63ee8e378b9cc65a4a2319f79f8a.s3tc.ctex"]

[params]

compress/mode=2
compress/high_quality=false
compress/lossy_quality=0.7
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=true
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/fix_alpha_border=false
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=0
Binary file added Documentation/Image/scene_builder_dock.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions Documentation/Image/scene_builder_dock.png.import
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[remap]

importer="texture"
type="CompressedTexture2D"
uid="uid://lg5hqjpyocy1"
path.s3tc="res://.godot/imported/scene_builder_dock.png-3f0c0e1baa8fa3b253691dc394f044be.s3tc.ctex"
metadata={
"imported_formats": ["s3tc_bptc"],
"vram_texture": true
}

[deps]

source_file="res://addons/SceneBuilder/Documentation/Image/scene_builder_dock.png"
dest_files=["res://.godot/imported/scene_builder_dock.png-3f0c0e1baa8fa3b253691dc394f044be.s3tc.ctex"]

[params]

compress/mode=2
compress/high_quality=false
compress/lossy_quality=0.7
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=true
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/fix_alpha_border=false
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=0
Binary file added Documentation/Image/scene_builder_file_system.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions Documentation/Image/scene_builder_file_system.png.import
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[remap]

importer="texture"
type="CompressedTexture2D"
uid="uid://ccxlw7bq34awu"
path.s3tc="res://.godot/imported/scene_builder_file_system.png-ce423c5125dfaae121911f364a3c3048.s3tc.ctex"
metadata={
"imported_formats": ["s3tc_bptc"],
"vram_texture": true
}

[deps]

source_file="res://addons/SceneBuilder/Documentation/Image/scene_builder_file_system.png"
dest_files=["res://.godot/imported/scene_builder_file_system.png-ce423c5125dfaae121911f364a3c3048.s3tc.ctex"]

[params]

compress/mode=2
compress/high_quality=false
compress/lossy_quality=0.7
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=true
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/fix_alpha_border=false
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=0
Binary file added Documentation/Image/scene_builder_item.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
35 changes: 35 additions & 0 deletions Documentation/Image/scene_builder_item.png.import
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
[remap]

importer="texture"
type="CompressedTexture2D"
uid="uid://di3vylrigcx0r"
path.s3tc="res://.godot/imported/scene_builder_item.png-069916576226006c4959b3c54bbd3824.s3tc.ctex"
metadata={
"imported_formats": ["s3tc_bptc"],
"vram_texture": true
}

[deps]

source_file="res://addons/SceneBuilder/Documentation/Image/scene_builder_item.png"
dest_files=["res://.godot/imported/scene_builder_item.png-069916576226006c4959b3c54bbd3824.s3tc.ctex"]

[params]

compress/mode=2
compress/high_quality=false
compress/lossy_quality=0.7
compress/hdr_compression=1
compress/normal_map=0
compress/channel_pack=0
mipmaps/generate=true
mipmaps/limit=-1
roughness/mode=0
roughness/src_normal=""
process/fix_alpha_border=false
process/premult_alpha=false
process/normal_map_invert_y=false
process/hdr_as_srgb=false
process/hdr_clamp_exposure=false
process/size_limit=0
detect_3d/compress_to=0
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,17 @@ If you would like to know more about how these commands work, please see the com

`res://addons/SceneBuilder/Commands/`

![scene_builder_commands](./Documentation/Image/scene_builder_commands.png)

Implementation details: The script `scene_builder_commands.gd` is loaded by `scene_builder_plugin.gd`, which is the class registered to EditorPlugin via `plugin.cfg`. The script `scene_builder_commands.gd` adds commands to the Godot toolbar and also listens for keyboard shortcuts. Each command's implementation is contained within the command's respective GDScript file.


## The scene builder dock

The scene builder dock requires manual setup. This isn't an ideal user experience, but doing things this way leads to very simple and stable solutions, please bear with us!

![scene_builder_dock](./Documentation/Image/scene_builder_dock.png)

In order to set-up the scene builder dock, follow these steps,

### Initialize your data folder
Expand All @@ -34,6 +38,8 @@ Note: This folder path is hard coded into the scene builder dock.

`res://Data/SceneBuilderCollections/collection_names.tres`

![scene_builder_collection_names_resource](./Documentation/Image/scene_builder_collection_names_resource.png)

This resource path is hard coded into the scene builder dock.

3. Enter your desired collection names into the CollectionNames resource, then create empty folders with matching names.
Expand All @@ -42,6 +48,8 @@ For example, if you would like a collection named "Furniture," then write "Furni

`res://Data/SceneBuilderCollections/Furniture/`

![scene_builder_file_system](./Documentation/Image/scene_builder_file_system.png)

Your data folder is now initialized.

If you have a folder in `res://Data/SceneBuilderCollections/` that is not listed in the CollectionNames resource, then it will simply be ignored. Conversely, if a collection name is written in CollectionNames, then an error will occur if a matching folder is not found.
Expand Down Expand Up @@ -86,6 +94,8 @@ by convention, a png file with a name matching the item name should be placed in
- Scene path is the path to Chair.glb (or Chair.tscn).
- Do not edit fields in the Hidden group. (Todo: does Godot have @export_hidden yet?)

![scene_builder_item](./Documentation/Image/scene_builder_item.png)

Our chair item is now ready!

Note that the result of scene path being a field of a given SceneBuilderItem instance is that if the item PackedScene is moved around in FileSystem, then the PackedScene will no longer be found by SceneBuilder. Todo: How can we update paths when moving PackedScene files? For now, we should manually update scene path fields, or simply delete then recreate SceneBuilderItem resources in bulk.
Expand All @@ -100,6 +110,8 @@ Although we demonstrate how to automatically generate items and icons in the nex
4. When the command "Create scene builder items" is run, the scene icon_studio will be opened. Please close the scene when it's done without saving any changes to icon_studio.tscn
5. In the scene builder dock, click the button "Reload all items"

![scene_builder_create_items](./Documentation/Image/scene_builder_create_items.png)

### Update the scene builder dock

#### World3D
Expand Down
4 changes: 2 additions & 2 deletions scene_builder_create_items.tscn
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
anchors_preset = 15
anchor_right = 1.0
anchor_bottom = 1.0
offset_right = -834.0
offset_bottom = -392.0
offset_right = -818.0
offset_bottom = -424.0
grow_horizontal = 2
grow_vertical = 2
theme = ExtResource("1_vnax4")
Expand Down

0 comments on commit 96a42f3

Please sign in to comment.