From 1e29f113b23d34121c65504b6659b8b963123811 Mon Sep 17 00:00:00 2001 From: Banyapon Poolsawas Date: Mon, 5 Aug 2024 23:31:34 +0700 Subject: [PATCH] Create README.md --- README.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..5c54f58 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# Blender A-Frame Exporter + +[![Blender Version](https://img.shields.io/badge/Blender-3.0+-orange.svg)](https://www.blender.org/) [![Blender Version](https://img.shields.io/badge/Blender-4.0+-orange.svg)](https://www.blender.org/) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) + +This Blender add-on simplifies the process of exporting your 3D scenes into interactive web experiences using A-Frame, a popular web framework for building virtual reality (VR) and augmented reality (AR) experiences. + +## Features + +* **Seamless Export:** Quickly export your entire Blender scene, including models, materials, and animations, to A-Frame HTML and GLB (binary glTF) files. +* **Collision Detection:** Automatically add collision detection to your exported models using A-Frame's physics system, enabling interactive experiences. +* **Camera Controls:** Easily set up basic WASD controls for navigating your A-Frame scene with the camera. +* **Customization:** Customize the generated A-Frame code to add additional features, components, or interactions. + +## Installation + +1. Download the latest release of the add-on (`.zip` file) from the [Releases](https://github.com/your-username/blender-aframe-exporter/releases) page. +2. In Blender, go to `Edit` > `Preferences` > `Add-ons` > `Install...` +3. Select the downloaded `.zip` file and click `Install Add-on`. +4. Enable the "A-Frame Exporter" add-on in the list. + +## Usage + +1. Create your 3D scene in Blender. +2. Go to `File` > `Export` > `A-Frame (.html)`. +3. Choose a location to save the files and click `Export A-Frame`. +4. The add-on will generate an HTML file (`your_scene_name.html`) and a GLB file (`your_scene_name.glb`). +5. Open the HTML file in a web browser to view your interactive A-Frame scene. + +## Additional Notes + +* Make sure you have a web server running to view the exported HTML file correctly. +* For more advanced A-Frame features and customization, refer to the [A-Frame documentation](https://aframe.io/docs/). + +## Contributing + +Contributions are welcome! Feel free to submit issues, feature requests, or pull requests. + +## License + +This add-on is released under the MIT License.