Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Video tutorial on how to setup an addon #213

Open
kolibril13 opened this issue Dec 4, 2024 · 5 comments
Open

Video tutorial on how to setup an addon #213

kolibril13 opened this issue Dec 4, 2024 · 5 comments

Comments

@kolibril13
Copy link

kolibril13 commented Dec 4, 2024

Here’s the process I use to set up my extension workflow on Mac to build Blender extensions.

Does this project currently accept contributions? If yes, I can also submit this as a pull request.

  1. Install the Addon
    Install the Blender VSCode Addon.

  2. Enable Reload on Save
    Go to VS Code settings and enable:
    Blender › Addon: Reload On Save

  3. Create a New Addon

    • Ensure the folder is completely empty.
    • Press Command + Shift + P
    • Select Blender: New Addon
    • Choose the "Simple" Template
    • Enter a name for your addon
    • Ensure Blender version is 4.2 or greater.
  4. Add a Minimal Button Script
    Paste a basic script for a button into the generated template.

  5. Build and Start the Addon

    • Press Command + Shift + P
    • Select Blender: Build and Start

Video tutorial about this setup:

extension_vs_code.mp4
@Mateusz-Grzelinski
Copy link
Collaborator

I am relatively active in the project.
So you want to make a "getting started" page? I am not against it, but I would need to review our docs, currently I am on the phone.

@kolibril13
Copy link
Author

Great to hear @Mateusz-Grzelinski !
Yes, that's something I'm planning.
Two question that came into my mind:
In the drop-down menu, what's the difference between "Simple" and "With auto Load"?
I always selected "Simple" but still had auto reload when enabling "Addon: Reload On Save" in the VS Code section.

@Mateusz-Grzelinski
Copy link
Collaborator

Mateusz-Grzelinski commented Dec 4, 2024

hm, that is really not documented? xD

the simple uses this as starting point https://github.com/JacquesLucke/blender_vscode/tree/master/pythonFiles/templates/addons/simple

the auto load uses this as starting point https://github.com/JacquesLucke/blender_vscode/tree/master/pythonFiles/templates/addons/with_auto_load -> it has a bit oh custom code that automatically registers blender related classes so that you do not have to do it manually.

Ensure Blender version is 4.2 or greater.

We try to support 2.8, it more or less works. The classic addons (pre 4.2) are supported.

@kolibril13
Copy link
Author

That's great to hear!
I also thought about rephrasing the overall structure of the README while preserving the content using ChatGPT. Would you have the time for such a contribution as well? Here's a preview for the first paragraph. I've reviewed it and it looks good:
image

@Mateusz-Grzelinski
Copy link
Collaborator

what can I say. Looks reasonable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants