Kumiko is similar to the traditional Dynamo Player, as it enables you to execute your Dynamo scripts within Revit files. However, it goes beyond standard functionalities by offering enhanced portability, Git-based collaboration, and seamless script sharing among team members.
Record_2023_06_26_22_38_33_95.mp4
The app is designed for Windows-based computers and is distributed as a single executable (exe) file. Here are the key requirements:
- Operating System: Windows 10 or newer
- .NET Framework: Version 4.7.2 or newer
- Revit: Version 2013.1 or newer
- Git (Optional)
Visit getkumiko.com to download the latest version of app. Make sure to close all active Revit applications and ensure that no Revit processes are running. After downloading the Kumiko.exe file, run it and follow the verification process.
Enter your email to verify your identity. Once logged in, please check your email for the verification code. Remember to check your junk mail folder if you don't receive any email. Enter or paste the code to access your account. The verification code will expire after 10 minutes.
Record_2023_06_26_22_50_40_139.mp4
Kumiko operates as a webview and is dependent on an internet connection for its functionality.
By default, the recommended location for storing your Dynamo scripts is located at:
%USERPROFILE%\Kumiko
You can also navigate to the root folder by clicking on the Kumiko logo in the sidebar.
Dynamo scripts must be grouped within folders, with the folder name providing a description of the script's purpose. Here's an illustrative example of how you can organize your Dynamo scripts within the root directory.
- 📁 Kumiko
├── 📁 Export Room Areas
│ └── 📄 script.dyn
├── 📁 Create Floor Plans
│ └── 📄 script.dyn
└── 📁 Generate 3D Views
└── 📄 script.dyn
If you utilize packages in your scripts, you can create a folder named .packages and include all the packages you use. Optionally, you can set this folder as the new package download path under your Dynamo preferences, so you can ensure that any new packages are downloaded there.
- 📁 Kumiko
├── 📁 .packages
│ ├── 📁 bimorphNodes
│ ├── 📁 Data-Shapes
│ └── 📁 Rhythm
├── 📁 Export Room Areas
│ └── 📄 script.dyn
├── 📁 Create Floor Plans
│ └── 📄 script.dyn
└── 📁 Generate 3D Views
└── 📄 script.dyn
You can also include multiple scripts within a folder if you want to run them sequentially as a Playlist:
- 📁 Kumiko
├── 📁 .packages
├── 📁 Export Room Areas
│ ├── 📄 01-removeUnplaced.dyn
│ └── 📄 02-saveToExcel.dyn
├── 📁 Create Floor Plans
│ ├── 📄 01-renameViews.dyn
│ └── 📄 02-createFloorPlans.dyn
└── 📁 Generate 3D Views
├── 📄 01-adaptBoundingBox.dyn
└── 📄 02-generateViews.dyn
When running multiple scripts, the execution order will depend on the alphabetical order. So, make sure to keep that in mind while organizing your scripts.
Additionally, you can include a script.json file to provide additional information about the script.
- 📁 Kumiko
├── 📁 .packages
├── 📁 Export Room Areas
│ ├── 📄 01-removeUnplaced.dyn
│ ├── 📄 02-saveToExcel.dyn
│ └── 📝 script.json
├── 📁 Create Floor Plans
│ ├── 📄 01-renameViews.dyn
│ ├── 📄 02-createFloorPlans.dyn
│ └── 📝 script.json
└── 📁 Generate 3D Views
├── 📄 01-adaptBoundingBox.dyn
├── 📄 02-generateViews.dyn
└── 📝 script.json
Here is a sample content of the script.json file:
{
"title":"Export Room Areas",
"description":"Removes all unplaced rooms and saves all room areas to an excel file.",
"author":"John Doe",
"compatibility":"Revit 2022-2023",
"dependencies":[
"Clockwork",
"BimorphNodes"
],
"documentation":"https://github.com/johndoe/dynamo/blob/main/scripts/export_room_areas.md",
"notes":"Please ensure you have the required packages installed: Clockwork and BimorphNodes."
}The content of the script.json file will be displayed as badges inside Kumiko.
Once you have successfully organized all your scripts, you can make them accessible by clicking on the synchronization symbol located in the sidebar. Once the symbol changes to green, your scripts will become ready to be accessed or shared.
Record_2023_06_26_23_17_45_713.mp4
After synchronizing your content, your scripts will be ready to run within Revit. Simply hover the mouse over the script and click the Play button.
Connecting your content to a remote Git repository offers various benefits, including convenient access, collaboration with others, and efficient tracking of modifications.
To interact with your repository using Kumiko, please follow these steps:
- Visit the official Git website: https://git-scm.com/downloads.
- Download the installer for Windows.
- Run the downloaded installer.
- Follow the installation instructions, sticking to the default settings unless you have specific preferences.
- Complete the installation process.
- Close Kumiko.
- Locate the
config.jsonfile at%LOCALAPPDATA%\Kumiko. - Open the file in a text editor.
- Find the
gitUrlkey and replace its value with the URL of your Git repository. - Save the changes.
Example config.json:
{
"rootDirectory": "C:\\Users\\John\\Kumiko",
"gitUrl": "https://github.com/johndoe/dynamo.git",
"windowWidth": 380.0,
"windowHeight": 990.0,
"windowTopPosition": 247.0,
"windowLeftPosition": 1932.0,
"windowTopMost": true
}Now, Kumiko will automatically fetch and apply content changes to the designated Git repository during synchronization.
When synchronizing, you may be prompted to authenticate your Git credentials. Make sure to follow the provided authentication process or instructions to securely verify your Git credentials and enable any interaction between Kumiko and the Git repository.
If you are a BIM Manager within an organization or company, there might be a need to share your scripts with other team members while maintaining control over their access to the content. In such circumstances, you have the option to grant other Members the ability to instantly access your latest content upon synchronising.
To share all your scripts with specific team members, click on the "Team" page in the sidebar and follow the steps demonstrated in this video.
Record_2023_06_26_23_22_12_429.mp4
By leaving the resource input empty, you will be sharing all of your content with that particular user.
To control which resources team members can access, you must first organize your scripts using a more structured approach. Start by creating a main folder for each project or category and put the relevant scripts inside. This way, you can assign team members to specific projects, allowing them access only to the resources within their assigned project.
Here's an example on how organize your scripts based on projects:
- 📁 Kumiko
├── 📁 Project A
│ ├── 📁 Export Room Areas
│ │ ├── 📄 01-removeUnplaced.dyn
│ │ └── 📄 02-saveToExcel.dyn
│ ├── 📁 Create Floor Plans
│ │ ├── 📄 01-renameViews.dyn
│ │ └── 📄 02-createFloorPlans.dyn
│ └── 📁 Generate 3D Views
│ ├── 📄 01-adaptBoundingBox.dyn
│ └── 📄 02-generateViews.dyn
├── 📁 Project B
│ ├── .
│ └── .
└── 📁 Project C
├── .
└── .
In this case, you can add a team member to the resource Project A and share only the scripts within that folder.
Record_2023_06_26_23_22_45_853.mp4
You can also be more specific by using a forward slash. For example: Project A/Export Room Areas.
On the Shared page, you can access all the scripts shared with you by others. As soon as another user adds you to their team, you will gain immediate access. Any changes made by users will be applied and visible to you simultaneously.
Record_2023_06_26_23_59_18_135.mp4
Sharing of scripts is restricted to verified users with an active subscription. To determine the script owner, simply hover over the email icon.
With Kumiko, we strive to share high-quality and dependency-free scripts within our community. You can explore our featured scripts by visiting the Featured page and give them a try. If you would like to feature one of your scripts with Kumiko, please get in touch with us via email.
Record_2023_06_26_23_40_47_344.mp4
Click on the documentation badge to read the documentation and better understand the functionality of each script.
A: Kumiko's main purpose is to simplify the process of developing, sharing, and version-controlling Dynamo scripts.
A: Kumiko refers to a traditional Japanese woodworking technique that involves the creation of intricate geometric patterns. The word symbolizes the app's purpose of nurturing a strong sense of community and collaboration.
A: Yes, absolutely. You can use most of Kumiko's features at no cost. However, you won't be able to add team members or share scripts without a paid subscription.
A: Yes, Kumiko has the ability to detect uninstalled Dynamo packages and will automatically install them. When sharing scripts with other members who may not have the same packages, ensure that used packages are added inside the .packages folder. Your installed packages will be bundled and shared along with each script.
A: Yes, Kumiko detects automatically input nodes and prompts the user to modify the inputs before executing the script. Please notice that there may be some input types that are not yet supported.
A: Kumiko requires Revit 2023.1 or newer. Try to close all running instances of Revit, wait a few seconds, then launch Kumiko before starting Revit. This ensures correct dependency installation. If issues persist, contact us for assistance.
We value your feedback and encourage you to open an issue to dicuss any major changes. Your input is important to us, as it helps us address concerns and incorporate suggestions.
If you enjoy using Kumiko, consider making a donation or support us by subscribing to our premium plans.
This project is released under the terms of the End-User License Agreement (EULA). Please carefully read and understand the terms and conditions outlined in the EULA before using the app. You can find the full text of the EULA here.
© 2023 Kumiko