Metadata-Version: 2.1
Name: wagtail_3display
Version: 1.0.1
Summary: A tool to display different 3D GLB models in Wagtail CMS
Home-page: https://github.com/Nigel2392/wagtail_3display
Author: Nigel
Author-email: nigel@goodadvice.it
License: GPL-2.0-only
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Wagtail
Classifier: Framework :: Wagtail :: 5
Classifier: Framework :: Wagtail :: 6
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django>=4.2
Requires-Dist: Wagtail>=5.2

wagtail_3display
=============

Wagtail 3D model viewer block using <https://threejs.org/>.

Installation
------------

1. Install the package using pip:

   ```bash
   pip install wagtail-3display
   ```

2. Add `wagtail_3display` to your `INSTALLED_APPS` in `settings.py`:

   ```python
    INSTALLED_APPS = [
         ...
         'wagtail_3display',
         ...
    ]
    ```

3. Run migrations to create necessary database tables:

    ```bash
    python manage.py migrate wagtail_3display
    ```

4. Collect static files:

    ```bash
    python manage.py collectstatic
    ```

5. Ensure you have the necessary static files in your templates:

    ```django
    <script src="{% static 'wagtail_3display/js/3display.js' %}"></script>
    ```

Usage
-----

1. In your Wagtail admin, add a new block of type "ThreeDisplayBlock" to your StreamField.

2. Upload a 3D model file (e.g., .glb, .gltf) using the block's file chooser.

3. Save the page and view it on the frontend to see the 3D model rendered.

