Autodesk Creative Platform Library Editor Version 1.1.1
The IDE for Creative Platform Libraries

The Autodesk Creative Platform Library Editor

Welcome to the Autodesk Creative Platform Library Editor. The team at Autodesk is really proud of the new Integrated Development Environment (IDE) we've provided our users and partners to author cutting edge applications on top of our industry proven platform. The new Editor provides several much needed features:
  • Feedback and Ratings

    Developers will get feedback about their Creative Platform Libraries directly from users. A new Rating and Comments capability has been provided so you get the feedback you need.

  • Release Management

    Developers can release updates to their Creative Platform Libraries, so if there's any enhancements users are looking for, or embarrassing bugs that need to be fixed, developers can have full control over their releases.

  • Better Organization

    One of the most common requests from users was the ability to organize their projects better and allow multiple files. Developers can now have as many scripts as they require and more easily include scripts from the Web.

  • Community Driven

    The Creative Platform is not a monolithic API developed by Autodesk. It's a platform, that allows everyone in the community to contribute to the Creative Platform by publishing libraries other members can reference. It's very easy for developers to publish libraries to the community, and it's even easier for other users to reference them and get a boost of creativity!

Settings

The Settings section allows a developer to control the properties for the library, get feedback and publish it to the community when they're ready!

  • Library Name

    The community-visible name of the library that other users will see in the Shape Generators section for example.

  • Library Description

    The community-visible description of the library that appears when a user tries to reference the library from another library if it is published as a Referencable Library.

  • Version

    The community-visible version name of this version. It could be a number like 1.0 or 2.0, or it could be a codename.

  • Version Notes

    Notes about this particular version that users may be interested in - such as improvements, bug fixes, etc.

  • Preview Documentation

    All Libraries get a public URL for documentation. This documentation can describe how to use the feature, contain illustrations, or contain technical documentation for functionality that is exported if it's a Referencable Library. Read more here about the documentation system the Autodesk Creative Platform provides. When you first click on the link from your library, it will provide some boilerplate comments you can add to your library to get started.

  • Publishing Options

    There are two options that affect what happens when a library is published. The Allow Community To View Source Code controls whether other members of the community will be able to view the JavaScript of the library. We encourage users to share their code, so others can learn, but the choice is always up to the developer! The Allow Community To Reference Library controls whether members of the community will see it when they click on the Find More... button on the Libraries section. If there are any functions, classes or utilities you've developed that you think other developers would benefit from leveraging, you should consider checking this option. Only libraries that contain exported functionality will be able to check this option. Read more Library.exports about exporting functionality for other developers.

  • Published Versions

    Shows the versions of the library that have been previously published, so that the feedback and ratings of each version that's been released can be seen.

  • Publish Version

    Publishes a new community-accessible version of the library to the Community. Once approved by the Community Manager, it will appear in the Shape Generators section.

Libraries

This section allows developers to search for other libraries and include them as references, to get additional APIs that the community developed! Each library also contains a link to its documentation, so its easy to learn all about the capabilities the library provides.

Scripts

The Scripts section allows developers to add as many scripts as they need, and remove them when they aren't needed anymore.

One thing developers need to know, is that all of the scripts are combined into a single JavaScript file based on the order they appear. Developers can adjust the ordering by clicking on the Scripts section and reorganizing it. So if you notice errors about variables being undefined, try reorganizing the files so undefined variables are in files appearing towards the top of the list.

Scripts also allow the developer to specify intended Targets for a script:

  • This gives developers the ability to include or exclude a script based on an intended Target.
  • The only way to see the effects of this capability are from the documentation page today, by manually appending ?target=<target name> to the URL.
  • Scripts without any Targets specified, are included for all Targets. By default, newly created files will not have any Targets specified.
  • URLs without a ?target qualifier are treated the same as URLs with ?target=default.


Resources

Developers can add any type of resources they need to their project and include them directly within the documentation. We're also working on a way to allow Libraries to take advantage of these resources at runtime within the code, for now only a URL for the resource can be retrieved.

Resources also allow the developer to specify Targets, see the Scripts section above for more information about Targets.