You are viewing the documentation for Deformable v0.1.0, an older version. Read the latest, v0.9.0
Deformable
Licensing
The free trial, the Standard license, and how to buy, activate and move a license, in the Blender and Maya plugins and in the C, Rust and Python SDKs.
On this page
Deformable starts as a free 7-day trial. To keep using it, buy a Standard license. The trial and the license cover the Blender plugin, the Maya plugin and the C, Rust and Python SDKs alike: the license check lives in the engine library that all of them load, so the plugins and every SDK on one computer share one trial and one license. One license covers the Blender and Maya plugins: there is no separate license for Maya.
Plans
| License | What you get | Price |
|---|---|---|
| Trial | All features of the Blender and Maya plugins and the SDKs, up to 2,500 tetrahedrons per scene, for 7 days. Then Deformable stops until you activate a license. | Free |
| Standard | The Blender plugin, the Maya plugin and the C, Rust and Python SDKs, every future version and email support. No limit, 1 seat (1 computer), perpetual, no subscription. | $99 one time (USD) |
The Standard license covers all future versions: every update is included. It also includes email support at support@tangerina.io.
In short: download a plugin or an SDK, use the 7-day trial (up to 2,500 tetrahedrons), buy, get the key by email, activate the key, and use Deformable. It works offline between renewals, which need the internet at least once every 7 days of use.
To download the trial, go to tangerina.io/deformable. To buy a license, see the pricing on tangerina.io/deformable.
One license state per computer
The trial and the license belong to your user account on one computer. The plugins, your Python scripts and your own programs on that computer all read the same state:
- The trial starts once, in whichever of them you use first.
- A license you activate in one plugin also licenses the other plugin and the SDKs on that computer, and a license you activate from an SDK also licenses the plugins.
- Deactivating in one of them deactivates it for all of them.
Another user account on the same computer keeps its own state, so it activates the key again. If that activation says the license is active on another device, deactivate it in the first account, then activate it in the second.
Internet access
Deformable needs the internet once to start the trial and once to activate a license. After that it works offline, but a license needs a renewal at least once every 7 days of use: whenever Deformable runs on a computer that is online, it renews the license by itself. A computer that is never online cannot start the trial or keep a license, so Deformable does not support computers without internet access.
1. Download the trial
The Blender plugin or the Maya plugin:
- Go to tangerina.io/deformable, on the Blender plugin or the Maya plugin tab.
- Click Download for your system. The page detects your system. If it guessed wrong, or you want the file for
another computer, pick it under Other platforms: macOS Apple silicon, Linux x64 or Windows x64.
Each
.zipfile works on its own system only. - Save the
.zipfile. Keep the Blender plugin’s file zipped: Blender installs it as it is. Unzip the Maya plugin’s file into a Maya modules folder, as its Getting started with Maya page shows.
The SDKs need no separate trial download. Install one as the SDKs section below shows, and the trial works the same as in the plugins.
2. Start the trial
The trial starts the first time Deformable runs on the computer. The computer must be online that one time: the engine asks our licensing service to start the trial. After that, the trial also works offline.
- In Blender: open Edit > Preferences > Get Extensions > Install from Disk and choose the
.zipfile. The plugin starts the trial and shows Trial: 7 days left. - In Maya: load the deformable plugin in Windows > Settings/Preferences > Plug-in Manager. The plugin starts the trial, and Deformable Help > License… shows Trial: 7 days left.
- In an SDK: the first call that does engine work, such as a mesh tool, adding an object or a simulation step, starts the trial. It waits at most 5 seconds for our licensing service. You can also start it yourself with the SDK’s license refresh call, as in The SDKs.
When the computer is offline at that first run, Deformable shows Go online once to start the trial, and nothing runs until it can reach our licensing service once.
During the trial, every feature works. A scene can hold up to 2,500 tetrahedrons, counting every object in it, floors included, but a disabled one, which takes no part in the simulation. Over the limit, the objects that do not fit stay still (they are not simulated), and the rest of the scene runs. Adding such an object fails with a message that says the limit, such as Trial limit: this would simulate 3,120 tetrahedrons; the trial allows 2,500. In the plugins, the object shows that message, and a scene over the limit says how many tetrahedrons it simulates. To stay under the limit, lower Target Face Count on the object’s Autocage, use a simpler cage, or simulate fewer objects. See Use fewer tetrahedrons.
3. When the trial ends
On day 8, Deformable shows Trial ended — Buy license. The tools and the simulation stop, in the plugins and in every SDK. Your files stay as they are, and a program can still read and free what it already made.
Reinstalling a plugin or an SDK does not restart the trial: the engine keeps the trial’s start in your user folder, outside the plugins and the SDKs, and a reinstall leaves that folder alone. Our licensing service also keeps the date the trial started on this computer, which brings that date back even when the folder is gone.
Deformable tells computers apart by the device id the operating system gives. On a computer that gives none, such as some Linux containers without a machine id, there is no trial, and Deformable shows No trial on this device — Buy license. A license works there as usual.
4. Buy a license
- Click Buy license in the Blender plugin’s preferences, or Buy License in the Maya plugin’s Deformable Preferences window. Your browser opens the pricing on tangerina.io/deformable.
- Click Buy license there. Your browser opens the payment page.
- Pay $99.
- Our licensing service emails you your license key. It looks like
TGDF-XXXX-XXXX-XXXX.
The payment is one time, with no subscription. The license does not expire, and it covers all future versions: every update is included.
5. Activate the license
Activate the key in a plugin or from any SDK. One activation is enough for all of them on that computer.
In Blender:
- Open Edit > Preferences > Add-ons and expand Deformable.
- Paste your license key into the License Key field.
- Make sure the computer is online, and click Activate. This needs internet one time.
- The plugin shows Licensed. The tetrahedron limit is gone.
In Maya:
- Choose Deformable Help > License…. The Deformable Preferences window opens.
- Paste your license key into the key field of its License section.
- Make sure the computer is online, and click Activate. This needs internet one time.
- The window shows Licensed. The tetrahedron limit is gone.
From an SDK, call its activate function once with the key, as in The SDKs.
6. Daily use and offline use
- Deformable works offline between renewals. A renewal needs the internet at least once every 7 days of use.
- While you use Deformable on a computer that is online, the engine renews the license quietly, a few times a day at most. You do not need to do anything. The Blender plugin also checks each time Blender starts, and the Maya plugin each time it loads in Maya’s window.
- Each renewal lets the license run for about 7 days offline. When Deformable was not used for longer than that, the first tool or simulation step renews the license first, waiting a few seconds for our licensing service.
- When the computer stays offline for longer than about 7 days, Deformable shows Go online once to renew the license, and the tools and the simulation stop until you connect. Connect, and it renews the license. A computer that is online while you use Deformable never sees this.
- In Blender, Deformable follows Allow Online Access (Edit > Preferences > System > Network). While it is off, Deformable contacts nothing, the license works only as far as it works offline, and the plugin preferences show Online access is off in Blender’s preferences (System > Network).
- In Maya, the plugin contacts our licensing service whenever the license needs it. Maya has no setting that turns a plugin’s internet access off, so the Maya plugin has none either.
- Deformable trusts the computer’s clock. If the clock is set back, Deformable shows The clock is behind: set the correct time and stops until the clock is right again.
Status messages
Each plugin shows the status line, the Blender plugin in its preferences and the Maya plugin in its Deformable Preferences window, and the SDKs give the same text as the license status’s message.
| Status | What it means |
|---|---|
| Trial: 7 days left | The trial runs. The number counts down each day, to Trial: 1 day left. |
| Trial ended — Buy license | The 7 days are over. The tools and the simulation stop until you activate a license. |
| No trial on this device — Buy license | This computer gives no device id, so it cannot have a trial. A license works. |
| Licensed | A license key is active on this computer. There is no limit. |
| Go online once to start the trial | The trial has not started yet. Connect to the internet once. |
| Go online once to renew the license | The license went about 7 days without a renewal. Connect to the internet once. |
| The clock is behind: set the correct time | The computer’s clock was set back. Correct it. |
Activating, deactivating, Check Now in the plugins and the SDKs’ refresh can also show these messages:
| Message | What to do |
|---|---|
| This is not a license key | Copy the key again from the email. It starts with TGDF. |
| This license key does not exist | Check the key for typos, or find it in the license portal (see Lost license key). |
| This license key is not a Deformable Standard license | The key is for another product or plan. Use your Deformable key. |
| This license is active on another device: deactivate it there or remove that device in the license portal | See Devices. |
| License key not accepted: followed by a reason | Our licensing service refused the key for the reason given. Write to support@tangerina.io if it is unclear. |
| The license was revoked or this device was removed | A renewal found the license refunded, or this computer removed in the license portal. |
| Deactivate the current license first | A different key is already active here. Deactivate it before you activate another. |
| Could not reach the licensing service: check the internet connection | Connect to the internet, and try again. |
| Go online to deactivate, or remove this device in the license portal | Deactivating needs internet. See Devices. |
| The licensing service’s answer did not verify | The answer was not signed by our licensing service, as on a network that rewrites traffic. Try another network. |
| The licensing service refused this copy of Deformable: contact support@tangerina.io | Write to support@tangerina.io. |
| The licensing service cannot take more devices right now: contact support@tangerina.io | Write to support@tangerina.io. |
| The license state could not be written in a folder | Your user folder is full or read-only. Free space or fix its permissions, then try again. |
| Online access is off in this program, so the licensing service was not contacted | The program turned online access off (in Blender, Allow Online Access; the Maya plugin never turns it off). Turn it on. |
Devices
A Standard license is 1 seat: one computer. A second computer needs the license moved to it, or a second license. To move it, deactivate it on the old computer first (see below).
To move your license to a new computer:
- On the old computer, deactivate the license: click Deactivate in a plugin’s license section, or call the SDK’s deactivate function. This needs internet. If you no longer have the old computer, remove it in the license portal instead. The link is in the FAQ at tangerina.io/deformable. A computer removed in the portal stops at its next renewal, and within about 7 days if it stays offline.
- On the new computer, install a plugin or an SDK and activate it with the same key, as in step 5.
Lost license key
- Open the license portal. The link is in the FAQ at tangerina.io/deformable.
- Enter the email address you used to buy the license.
- Open the login link that the portal sends to that email address.
- Copy your license key.
If that does not work, email support@tangerina.io from the address you used to buy the license.
Refunds
You can ask for a refund within 14 days of purchase: email support@tangerina.io from the email address you used to buy the license. After a refund, the license stops working: on its computer at the next renewal, within a day when the computer is online, and within about 7 days when it stays offline.
Who does what
| Step | Who |
|---|---|
| Website and buy button | tangerina.io |
| Payment | Our payment provider |
| Making and emailing the license key | Our licensing service |
| Trial, activation, the tetrahedron limit and the offline check | The engine library, in the plugins and in every SDK |
Tangerina runs no license server of its own: the website is static, a payment provider takes the payment and a licensing service keeps the licenses.
The SDKs
The C, Rust and Python SDKs use the engine in your own application. They come with the same trial as the plugins, and the Standard license covers them.
The trial and the license belong to the computer where the engine runs. A program you build with an SDK and run on other computers, such as your colleagues’, a server or a render farm, starts a separate trial on each of them, and stops on each after 7 days unless that computer has its own seat. A container needs a device id to start a trial, and a seat activated inside a container that is thrown away stays taken until you remove it in the license portal. To ship the engine inside an application you give to others, write to support@tangerina.io first. The C SDK zip comes from the download section of tangerina.io/deformable, the Rust crate from crates.io and the Python package from PyPI:
| SDK | How to get it |
|---|---|
| C | The zip for your platform, from the C SDK tab. See C SDK. |
| Rust | cargo add deformable. The first build downloads the engine library for your system. See Rust SDK. |
| Python | pip install deformable. See Python SDK. |
Each SDK has the same license calls:
| Call | What it does |
|---|---|
| status | Reads the license state of this computer. It never goes online, so it is cheap to call often. |
| refresh | Starts the trial, or renews the license, when that is due. Call it when your program starts, so the trial starts there and not in your first tool call. |
| activate | Activates a license key on this computer. Needs internet. |
| deactivate | Frees this computer’s seat, so you can activate the key on another one. Needs internet. |
| set online access | Keeps your program off the network when its user asked for that: nothing is sent, and the trial and the license work only as far as they work offline. |
Activate, deactivate and refresh wait for our licensing service for at most the timeout you pass, 15 seconds by default. They are safe to call from any thread.
Activate checks the key’s format first. A key in the wrong format is refused before any request, with the message
This is not a license key: the status DEFORMABLE_STATUS_INVALID_ARGUMENT in C, the kind
ErrorKind::InvalidArgument in Rust, and in Python a DeformableError with the status INVALID_ARGUMENT (an empty
or blank key, or one that holds a NUL character, raises ValueError instead). It is not a license error, and the
license state does not change.
When the trial or the license does not allow a call, the call fails with one of the license errors below, and the error’s message is the status line, such as Trial ended — Buy license. Calls that only create, read, set or free data keep working, so your program can always clean up.
| Error | When |
|---|---|
| License required | The trial ended, the computer has no trial, or the license was removed. |
| Trial limit exceeded | More than 2,500 tetrahedrons would take part in the simulation during the trial; a disabled object does not count. The error’s first index is that count, the second the limit. The call that adds the object (add_, or deformable_ in C) adds nothing, and the scene goes on with the objects it holds. |
| License needs online | The trial has not started, the license needs its renewal, or the clock is behind. |
| License service unavailable | Our licensing service could not be reached, or its answer did not verify. |
| License key rejected | Our licensing service refused the key. |
| License storage failed | The license state could not be saved in your user folder. The message names the folder. |
C
#include <stdio.h>
#include "deformable.h"
int main(void) {
DeformableLicenseStatus status;
if (deformable_license_activate("TGDF-XXXX-XXXX-XXXX", 15000, &status) != DEFORMABLE_STATUS_OK) {
fprintf(stderr, "%s\n", deformable_last_error_message());
return 1;
}
printf("%s\n", status.message);
return 0;
}Licenseddeformable_license_status reads the state, deformable_license_refresh brings it up to date,
deformable_license_deactivate frees the seat, and deformable_license_set_online_access(0) keeps the program off
the network. The timeouts are in milliseconds. The license statuses are
DEFORMABLE_STATUS_LICENSE_REQUIRED (44) to DEFORMABLE_STATUS_LICENSE_STORAGE_FAILED (49). See
Memory and errors.
Rust
use deformable::license;
fn main() -> Result<(), deformable::Error> {
let status = license::activate("TGDF-XXXX-XXXX-XXXX", license::DEFAULT_TIMEOUT)?;
println!("{}", status.message);
Ok(())
}Licensedlicense::status() reads the state, license::refresh(timeout) brings it up to date,
license::deactivate(timeout) frees the seat, and license::set_online_access(false) keeps the program off the
network. The license errors are the ErrorKind variants LicenseRequired,
TrialLimitExceeded, LicenseNeedsOnline, LicenseServiceUnavailable, LicenseKeyRejected and
LicenseStorageFailed. See Errors and threads.
Python
import deformable
status = deformable.license.activate("TGDF-XXXX-XXXX-XXXX")
print(status.message)Licenseddeformable.license.status() reads the state, deformable.license.refresh() brings it up to date,
deformable.license.deactivate() frees the seat, and deformable.license.set_online_access(False) keeps the program
off the network. Activate, refresh and deactivate take a timeout in seconds. A refused call raises
deformable.LicenseError, a DeformableError, or one of its subclasses LicenseRequiredError and
TrialLimitExceededError. See Types and errors.