Skip to content

Commit

Permalink
Add README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
aaronfranke committed Jul 23, 2024
1 parent ee6ac94 commit 9029fa4
Show file tree
Hide file tree
Showing 5 changed files with 38 additions and 2 deletions.
24 changes: 24 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

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 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.

For more information, please refer to <https://unlicense.org>
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Godot glTFX Reference Format

Godot implementation of the [glTFX Reference Format](https://github.com/KhronosGroup/glTF-External-Reference), also known as glTF External Reference, glTF Experience Format, or glXF. The glTFX format allows for referencing external glTF files, and also other glTFX files, allowing for a nested scene hierarchy of arbitrary depth, with its leaf scenes being glTF files.

**Note:** The glTFX Reference Format is still a work in progress and is not yet ratified by the Khronos Group. Until glTFX is finalized, this addon should be considered experimental and subject to change at any time to comply with the latest iteration of the draft specification.

For full functionality, this addon requires Godot 4.4 or later with [this PR](https://github.com/godotengine/godot/pull/94603). It can be used with Godot 4.3, but the export settings will not be available.

The addon is licensed under The Unlicense. Anyone is free to use this without restriction. Credit is appreciated but not required.

Here is an example of exporting a glTFX scene which contains another glTFX scene which contains a cube glTF file. The file hierarchy is preserved both when exporting from Godot and importing into Godot.
![Nested glTFX example](preview_images/nested_gltfx.png)
Empty file added preview_images/.gdignore
Empty file.
Binary file added preview_images/nested_gltfx.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions project.godot
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ config_version=5

[application]

config/name="glTFX Reference Format"
config/features=PackedStringArray("4.3", "GL Compatibility")
config/name="glTFX Reference Format Test Project"
config/features=PackedStringArray("4.4", "GL Compatibility")
config/icon="res://icon.svg"

[editor_plugins]
Expand Down

0 comments on commit 9029fa4

Please sign in to comment.