[Bf-docboard-svn] bf-manual: [7505] trunk/blender_docs/manual: BlenderKit add-on manual update

Aaron Carlisle noreply at blender.org
Mon Dec 21 03:53:59 CET 2020 

Revision: 7505
          https://developer.blender.org/rBM7505
Author:   Blendify
Date:     2020-12-21 03:53:59 +0100 (Mon, 21 Dec 2020)
Log Message:
-----------
BlenderKit add-on manual update

I wasn't successfull in attaching a .patch with images included - so the patch is without images, while the correct patch is added as attachment.
I probably have commit rights, but since this is first commit into manual, I wanted to have first patch reviewed.

 - the manual was moved into the 3d view category, because that's where the add-on currently is located
 - complete documentation of the UI with links to tutorials.
 - has several images, thus the patch was created with 'git format' svn option.


Author: @pildanovak

https://developer.blender.org/D9814

Modified Paths:
--------------
    trunk/blender_docs/manual/addons/3d_view/index.rst
    trunk/blender_docs/manual/addons/add_mesh/index.rst

Added Paths:
-----------
    trunk/blender_docs/manual/addons/3d_view/blenderkit.rst
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_assetbar.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_drag-drop.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_preference-open.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_preferences.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_search-sidebar.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_sidebar-search-common.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_sidebar-search-models-importsettings-only.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_sidebar-search_bkprofile.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_sidebar-search_brushes1.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_sidebar-search_login.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_sidebar-selected-model-panel.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_sidebar-upload-material.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_sidebar-upload-model-public-design.jpg
    trunk/blender_docs/manual/images/addons_3d-view_blenderkit_thumbnail-generator.jpg

Removed Paths:
-------------
    trunk/blender_docs/manual/addons/add_mesh/blenderkit.rst

Added: trunk/blender_docs/manual/addons/3d_view/blenderkit.rst
===================================================================
--- trunk/blender_docs/manual/addons/3d_view/blenderkit.rst	                        (rev 0)
+++ trunk/blender_docs/manual/addons/3d_view/blenderkit.rst	2020-12-21 02:53:59 UTC (rev 7505)
@@ -0,0 +1,663 @@
+
+**********
+BlenderKit
+**********
+
+
+BlenderKit is an online database of materials, brushes and 3D models which you can search,
+download, upload and rate directly from the Add-on.
+
+`authors site <https://www.blenderkit.com/>`__
+
+
+Activation
+==========
+
+- Open Blender and go to Preferences then the Add-ons tab.
+- Click 3d View then BlenderKit Asset Library to enable the script.
+
+
+Account and Login
+-----------------
+
+Click on the signup button to create a new account and activate by pressing *Login*
+directly in BlenderKit settings. It will redirect you to logging through our website.
+
+
+Basic Usage
+===========
+
+#. Type a search term into the search field.
+#. Assetbar shows up with the results.
+#. Drag-drop the material or model into your scene.
+
+.. figure:: /images/addons_3d-view_blenderkit_search-sidebar.jpg
+   :align: center
+   :width: 300px
+
+.. figure:: /images/addons_3d-view_blenderkit_assetbar.jpg
+   :align: center
+   :width: 300px
+
+.. figure:: /images/addons_3d-view_blenderkit_drag-drop.jpg
+   :align: center
+   :width: 300px
+
+
+Interface
+=========
+
+.. _bpy.ops.scene.blenderkit_download:
+.. _bpy.ops.view3d.blenderkit_asset_bar:
+
+Assetbar
+--------
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Assetbar`
+
+
+.. figure:: /images/addons_3d-view_blenderkit_assetbar.jpg
+   :align: center
+   :width: 600px
+
+Assetbar shows search results and allows users to interact with them.
+The Assetbar should auto-popup when the search results are retrieved from the server.
+It can be shown or hidden by clicking the eye icon next to the search field.
+
+Actions that can be performed in the Assetbar:
+
+- Drag drop an object or material directly into the scene.
+- Click a result to link/append it to the scene.
+- Right click a result for further interaction:
+
+  Open Authors Website
+     Opens a web browser and goes to the web presentation that the author specified.
+  Show assets by author
+     Shows all assets uploaded by the author of the selected 3d model.
+  Replace Active models
+     You need to select several assets to use this option from the Selected Model panel
+     -- all will be replaced with the last asset selected (active).
+     If you use this option from the Right-click menu, the target asset is downloaded and replaces selected assets.
+
+- Scroll mousewheel to scroll the results.
+-  Click arrows on the side of the Assetbar for a jump to the next/previous page.
+
+
+BlenderKit Profile Panel
+------------------------
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> BlenderKit Profile`
+
+.. figure:: /images/addons_3d-view_blenderkit_sidebar-search_bkprofile.jpg
+   :align: right
+   :width: 300px
+
+
+This panel shows the user's login information and information about the user's public and private remaining storage.
+
+See my uploads
+   Open BlenderKit website and show list of author’s assets.
+
+
+BlenderKit Login Panel
+----------------------
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> BlenderKit Login`
+
+.. figure:: /images/addons_3d-view_blenderkit_sidebar-search_login.jpg
+   :align: right
+   :width: 300px
+
+.. _bpy.ops.wm.blenderkit_login:
+
+Login
+   Login online on BlenderKit webpage.
+
+.. _bpy.ops.wm.blenderkit_logout:
+
+Logout
+   Logout from BlenderKit immediately.
+
+
+Find and Upload Assets Panel
+----------------------------
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> Find and Upload`
+
+.. figure:: /images/addons_3d-view_blenderkit_search-sidebar.jpg
+   :align: right
+   :width: 300px
+
+The main panel enables you to Search or Upload all supported asset types.
+
+Search/Upload
+   Switch the main panel between Search and upload functionality.
+
+
+Search and Download
+-------------------
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> Find and Upload --> Search`
+
+.. figure:: /images/addons_3d-view_blenderkit_sidebar-search-common.jpg
+   :align: right
+   :width: 300px
+
+
+Models/Materials/Brushes
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Switch between asset types available in BlenderKit.
+
+These fields are common for all asset types:
+.. _bpy.ops.view3d.blenderkit_search:
+
+Search field
+   Keyword search. Input text and hit enter to run a search.
+Eye icon
+   Show/Hide Assetbar interface. You can also use semicolon shortcut.
+Style
+   Search filter limiting the results.(realistic, painted , polygonal, other)
+
+Options visible for Models search
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> Find and Upload --> Search --> Models`
+
+
+.. _bpy.data.scenes.blenderkit_models.own_only:
+
+My Assets
+   Search only for your 3d models.
+
+.. _bpy.data.scenes.blenderkit_models.free_only:
+
+Free only
+   Show only free models. This option is available only for models, since all Materials and all Brushes are free.
+
+Search filters subpanel:
+
+.. _bpy.data.scenes.blenderkit_models.search_condition:
+
+Condition
+   Condition of the object: New, Used, Old, Desolate.
+
+.. _bpy.data.scenes.blenderkit_models.search_design_year:
+
+Designed in (min - max)
+   When the object was approximately designed in terms of Year.
+   Can be used for parallel worlds or future scifi dates (search for sci-fi stuff by entering 2100 as minimum year).
+
+.. _bpy.data.scenes.blenderkit_models.search_polycount:
+
+Poly count in (min - max)
+   Use polycount of 3d object for search.
+
+.. _bpy.data.scenes.blenderkit_models.search_texture_resolution:
+
+Texture resolution (min - max)
+   Limit search to texture resolutions in a range.
+
+.. _bpy.data.scenes.blenderkit_models.search_file_size:
+
+File size (min - max)
+   Limit search filesize. This uses basic file size of the original file.
+
+
+Categories
+^^^^^^^^^^
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> Find and Upload --> Search --> Models --> Categories`
+
+
+Category panel enables direct browsing of BlenderKit categories.
+
+.. _bpy.ops.view3d.blenderkit_set_category:
+
+>>
+   Visit subcategory
+↲
+   Return to parent category
+
+
+Import method
+^^^^^^^^^^^^^
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> Find and Upload --> Search --> Models --> Import settings`
+
+.. figure:: /images/addons_3d-view_blenderkit_sidebar-search-models-importsettings-only.jpg
+   :align: right
+   :width: 300px
+
+.. _bpy.data.scenes.blenderkit_models.link_method:
+
+Link
+   Link 3d model into Blender scene. Linked models are saved in original files.
+   To edit them, you need to open the model in the subfolder of your project: -- assets/models.
+   Linking helps to keep file size low.
+
+.. _bpy.data.scenes.blenderkit_models.append_method:
+
+Append
+   Append 3d model into Blender scene. Appended objects are included and editable in your scene.
+
+.. _bpy.data.scenes.blenderkit_models.randomize_rotation:
+
+Randomize rotation
+   Randomize the rotation of the model around the Z axis during placement in the Blender scene.
+
+.. _bpy.data.scenes.blenderkit_models.perpendicular_snap:
+
+Perpendicular snap
+   Limit snapping if the angle is close to perpendicular angles to become exactly perpendicular.
+   Useful for placing lamps on curved ceilings, or placing trees on slopes and similar cases.
+
+.. _bpy.data.scenes.blenderkit_models.perpendicular_snap_treshold:
+
+Threshold
+   Limit perpendicular snap.
+
+
+Options visible for materials search:
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> Find and Upload --> Search --> Materials`
+
+Search filters:
+
+.. _bpy.data.scenes.blenderkit_mat.search_procedural:
+
+Procedural/Texture based/Both
+   Limit search to only procedural or texture based materials.
+
+.. _bpy.data.scenes.blenderkit_mat.search_texture_resolution:
+
+Texture Resolution
+   Limit search with resolution of the texture.
+
+.. _bpy.data.scenes.blenderkit_mat.search_file_size:
+
+File size
+   Limit search with file size.
+
+
+Categories
+^^^^^^^^^^
+
+.. admonition:: Reference
+   :class: refbox
+
+   :Panel:     :menuselection:`Sidebar --> BlenderKit --> Find and Upload --> Search --> Materials --> Categories`
+
+same as the model search
+
+   >>
+      Visit subcategory
+   ↲
+      Return to parent category
+
+
+Import settings
+^^^^^^^^^^^^^^^
+
+.. _bpy.data.scenes.blenderkit_mat.automap:
+
+Auto-Map
+   Add cube mapping UV to the object after drag drop.
+   This allows most materials to be applied instantly to any mesh.
+   BlenderKit generates a new UV map called ‘automap’, and doesn’t replace your previous UV maps.
+   The action also resets texture space of the target object to (1.0, 1.0, 1.0).
+   This enables most procedural materials to have correct scaling.
+
+
+Upload
+------
+
+Models/Materials/Brushes
+   Switch between asset types which are available to upload in BlenderKit.
+
+
+Common options for all assets types
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: /images/addons_3d-view_blenderkit_sidebar-upload-model-public-design.jpg
+   :align: right
+   :width: 300px
+
+Hide asset preview
+   Show/Hide asset preview, which shows how approximately will the asset look for people searching the database.
+
+.. _bpy.ops.wm.url_open:
+
+Read upload instructions
+   Open Upload `manual <https://www.blenderkit.com/docs/upload-tutorials/>`__ on BlenderKit website.
+   Read the manuals for `models <https://www.blenderkit.com/docs/upload/>`__,
+   `materials <https://www.blenderkit.com/docs/uploading-material/>`__,
+   and `brushes <https://www.blenderkit.com/docs/uploading-brush/>`__ on website.
+
+Upload
+   Upload or re-upload the 3d model.
+   In the operator you can choose if you want to update the files.
+   If both file and thumbnail are off, only metadata gets updated.
+Category
+   Main category to place the model into.
+Subcategory

@@ Diff output truncated at 10240 characters. @@

More information about the Bf-docboard-svn mailing list