Skip to content

Commit

Permalink
Updated "Getting Started" page
Browse files Browse the repository at this point in the history
Updated "Installation" and "Quickstart Demo" sections in the "Getting Started" page.

Renamed transmogrifier.copy_assets to transmogrifier.install presets to more clearly describe the operator's purpose.
  • Loading branch information
SapwoodStudio committed Apr 7, 2024
1 parent 94f6fdb commit 82814e5
Show file tree
Hide file tree
Showing 42 changed files with 481 additions and 186 deletions.
15 changes: 7 additions & 8 deletions Operators.py
Original file line number Diff line number Diff line change
Expand Up @@ -262,16 +262,15 @@ def draw(self, context):



# Copy import/export/transmogrifier presets shipped with Transmogrifier to relevant Blender Preferences directory.
class TRANSMOGRIFIER_OT_copy_assets(Operator):
# Install import/export/transmogrifier presets shipped with Transmogrifier to relevant Blender Preferences directory.
class TRANSMOGRIFIER_OT_install_presets(Operator):
"""Copy example presets shipped with Transmogrifier to User Preferences"""
bl_idname = "transmogrifier.copy_assets"
bl_label = "Copy Assets to Preferences"
bl_idname = "transmogrifier.install_presets"
bl_label = "Install Example Presets"

def execute(self, context):
# Define paths.
assets_dir = Path(__file__).parent / "assets"
presets_dir_src = assets_dir / "presets" / "operator"
presets_dir_src = Path(__file__).parent / "presets" / "operator"
presets_dir_dest = bpy.utils.user_resource('SCRIPTS', path="presets/operator")

# Make list of source paths and destination paths (parents).
Expand All @@ -291,7 +290,7 @@ def execute(self, context):
Path(dir_dest).mkdir(parents=True, exist_ok=True)
shutil.copy(file_src, file_dest)

self.report({'INFO'}, "Copied Assets to Preferences")
self.report({'INFO'}, "Installed Example Presets")

return {'FINISHED'}

Expand Down Expand Up @@ -651,7 +650,7 @@ def execute(self, context):
TRANSMOGRIFIER_OT_help,
TRANSMOGRIFIER_OT_transmogrify,
TRANSMOGRIFIER_OT_forecast,
TRANSMOGRIFIER_OT_copy_assets,
TRANSMOGRIFIER_OT_install_presets,
TRANSMOGRIFIER_OT_add_preset,
TRANSMOGRIFIER_OT_remove_preset,
TRANSMOGRIFIER_OT_load_preset,
Expand Down
5 changes: 3 additions & 2 deletions UI.py
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,10 @@ def draw_settings_general(self, context):
for num in bl_info["version"]:
version = version + "." + str(num)
version = version.lstrip(".")
title = bl_info["name"] + " " + version + "-Dev"
title = bl_info["name"] + " " + version
row = self.layout.row(align=False)
row.label(text=title)
row.prop(settings, 'logging_save_summary', text='', icon="SPREADSHEET")
row.operator('transmogrifier.advanced_ui', text="", icon="OPTIONS", depress=True if settings.advanced_ui else False)
help = row.operator('transmogrifier.help', text="", icon="QUESTION")
help.link = "https://sapwoodstudio.github.io/Transmogrifier"
Expand Down Expand Up @@ -955,7 +956,7 @@ def draw(self, context):
# Display copy assets button
box = layout.box()
col = box.column(align=True)
col.operator("transmogrifier.copy_assets", text="Copy Assets to Preferences", icon="DUPLICATE")
col.operator("transmogrifier.install_presets", icon="DUPLICATE")


# Toggles Advanced UI setting. Registers and unregisters additional panels when the addon's UI is in the 3D Viewport Side Menu.
Expand Down
28 changes: 13 additions & 15 deletions docs/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,7 @@





<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="/transmogrifier/." title="Transmogrifier" class="md-header__button md-logo" aria-label="Transmogrifier" data-md-component="logo">

Expand Down Expand Up @@ -233,8 +231,14 @@

</nav>

</header>

<div class="md-container" data-md-component="container">





<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
Expand Down Expand Up @@ -312,12 +316,12 @@


<li class="md-tabs__item">
<a href="/transmogrifier/contribute/" class="md-tabs__link">
<a href="/transmogrifier/community/" class="md-tabs__link">




Contribute
Community

</a>
</li>
Expand All @@ -344,13 +348,7 @@
</ul>
</div>
</nav>


</header>

<div class="md-container" data-md-component="container">





<main class="md-main" data-md-component="main">
Expand Down Expand Up @@ -475,11 +473,11 @@


<li class="md-nav__item">
<a href="/transmogrifier/contribute/" class="md-nav__link">
<a href="/transmogrifier/community/" class="md-nav__link">


<span class="md-ellipsis">
Contribute
Community
</span>


Expand Down Expand Up @@ -605,7 +603,7 @@ <h1>404 - Not found</h1>
<div class="md-dialog__inner md-typeset"></div>
</div>

<script id="__config" type="application/json">{"base": "/transmogrifier/", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "navigation.top", "navigation.path", "navigation.indexes", "navigation.footer", "toc.integrate", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "/transmogrifier/assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "/transmogrifier/", "features": ["navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "navigation.path", "navigation.indexes", "navigation.footer", "toc.integrate", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "/transmogrifier/assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="/transmogrifier/assets/javascripts/bundle.dff1b7c8.min.js"></script>
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/Getting_started_Install_4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/Getting_started_Install_5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 41 additions & 19 deletions docs/contribute/index.html → docs/community/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@



<link rel="canonical" href="https://sapwoodstudio.github.io/transmogrifier/contribute/">
<link rel="canonical" href="https://sapwoodstudio.github.io/transmogrifier/community/">


<link rel="prev" href="../faq/">
Expand All @@ -22,7 +22,7 @@



<title>Contribute - Transmogrifier</title>
<title>Community - Transmogrifier</title>



Expand Down Expand Up @@ -120,7 +120,7 @@
<div data-md-component="skip">


<a href="#credits" class="md-skip">
<a href="#join-the-conversation" class="md-skip">
Skip to content
</a>

Expand All @@ -132,9 +132,7 @@





<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Transmogrifier" class="md-header__button md-logo" aria-label="Transmogrifier" data-md-component="logo">

Expand All @@ -155,7 +153,7 @@
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">

Contribute
Community

</span>
</div>
Expand Down Expand Up @@ -244,8 +242,14 @@

</nav>

</header>

<div class="md-container" data-md-component="container">





<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
Expand Down Expand Up @@ -330,7 +334,7 @@



Contribute
Community

</a>
</li>
Expand All @@ -357,13 +361,7 @@
</ul>
</div>
</nav>


</header>

<div class="md-container" data-md-component="container">





<main class="md-main" data-md-component="main">
Expand Down Expand Up @@ -499,7 +497,7 @@


<span class="md-ellipsis">
Contribute
Community
</span>


Expand All @@ -510,7 +508,7 @@


<span class="md-ellipsis">
Contribute
Community
</span>


Expand All @@ -529,6 +527,27 @@
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>

<li class="md-nav__item">
<a href="#join-the-conversation" class="md-nav__link">
Join the Conversation
</a>

</li>

<li class="md-nav__item">
<a href="#report-a-bug" class="md-nav__link">
Report a Bug
</a>

</li>

<li class="md-nav__item">
<a href="#contribute" class="md-nav__link">
Contribute
</a>

</li>

<li class="md-nav__item">
<a href="#credits" class="md-nav__link">
Credits 🙏
Expand Down Expand Up @@ -581,8 +600,11 @@



<h1>Contribute</h1>
<h1>Community</h1>

<h2 id="join-the-conversation">Join the Conversation<a class="headerlink" href="#join-the-conversation" title="Permanent link">#</a></h2>
<h2 id="report-a-bug">Report a Bug<a class="headerlink" href="#report-a-bug" title="Permanent link">#</a></h2>
<h2 id="contribute">Contribute<a class="headerlink" href="#contribute" title="Permanent link">#</a></h2>
<h2 id="credits">Credits 🙏<a class="headerlink" href="#credits" title="Permanent link">#</a></h2>
<p>Many thanks to the <a href="https://www.blender.org/about/people/">people</a> who develop Blender, without whom this addon would have no foundation to exist!</p>
<p>Transmogrifier used code from the following repositories in the following ways. If you give a star to this repository, please also do the same for theirs!</p>
Expand Down Expand Up @@ -727,7 +749,7 @@ <h2 id="credits">Credits 🙏<a class="headerlink" href="#credits" title="Perman
<div class="md-dialog__inner md-typeset"></div>
</div>

<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "navigation.top", "navigation.path", "navigation.indexes", "navigation.footer", "toc.integrate", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "navigation.path", "navigation.indexes", "navigation.footer", "toc.integrate", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.dff1b7c8.min.js"></script>
Expand Down
34 changes: 16 additions & 18 deletions docs/faq/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<link rel="prev" href="../features/">


<link rel="next" href="../contribute/">
<link rel="next" href="../community/">


<link rel="icon" href="../assets/images/Transmogrifier_Logo_64.png">
Expand Down Expand Up @@ -127,9 +127,7 @@





<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Transmogrifier" class="md-header__button md-logo" aria-label="Transmogrifier" data-md-component="logo">

Expand Down Expand Up @@ -239,8 +237,14 @@

</nav>

</header>

<div class="md-container" data-md-component="container">





<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
Expand Down Expand Up @@ -320,12 +324,12 @@


<li class="md-tabs__item">
<a href="../contribute/" class="md-tabs__link">
<a href="../community/" class="md-tabs__link">




Contribute
Community

</a>
</li>
Expand All @@ -352,13 +356,7 @@
</ul>
</div>
</nav>


</header>

<div class="md-container" data-md-component="container">





<main class="md-main" data-md-component="main">
Expand Down Expand Up @@ -491,11 +489,11 @@


<li class="md-nav__item">
<a href="../contribute/" class="md-nav__link">
<a href="../community/" class="md-nav__link">


<span class="md-ellipsis">
Contribute
Community
</span>


Expand Down Expand Up @@ -590,13 +588,13 @@ <h1>FAQ</h1>



<a href="../contribute/" class="md-footer__link md-footer__link--next" aria-label="Next: Contribute" rel="next">
<a href="../community/" class="md-footer__link md-footer__link--next" aria-label="Next: Community" rel="next">
<div class="md-footer__title">
<span class="md-footer__direction">
Next
</span>
<div class="md-ellipsis">
Contribute
Community
</div>
</div>
<div class="md-footer__button md-icon">
Expand Down Expand Up @@ -672,7 +670,7 @@ <h1>FAQ</h1>
<div class="md-dialog__inner md-typeset"></div>
</div>

<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "navigation.top", "navigation.path", "navigation.indexes", "navigation.footer", "toc.integrate", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "navigation.path", "navigation.indexes", "navigation.footer", "toc.integrate", "search.suggest", "search.highlight", "content.tabs.link", "content.code.annotation", "content.code.copy"], "search": "../assets/javascripts/workers/search.dfff1995.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>


<script src="../assets/javascripts/bundle.dff1b7c8.min.js"></script>
Expand Down
Loading

0 comments on commit 82814e5

Please sign in to comment.