Installing the Plugin in Unity

Cipher - Unity Asset Integration connects your Unity project with your Cipher account, allowing you to have your AI-generated 3D assets directly into the Unity Editor.

Assets are imported automatically and prepared for immediate use, eliminating manual downloads and file management.


1. Installing the Plugin in Unity

  1. Download the Cipher Unity Plugin package in the Unity Asset Store [link coming soon].

  2. Open your Unity project.

  3. Import the plugin into your project using Unity’s Package Manager.

Screenshot of the Unity “Import Unity Package” dialog showing the cipher-unity-sdk package. The package contents are expanded under Packages/com.ambitionz.cipher, including folders for Editor, Configuration, Models, Network, and Resources. Individual files such as CipherBuildConfig.cs, CipherEnvironment.cs, AssetsModels.cs, CipherHttpClient.cs, and multiple font and icon assets are visible and selected for import. Green “New” labels appear next to each asset, indicating they will be newly added to the project. The Import button is highlighted in the bottom-right corner, with Cancel next to it.

2. Generating an API Key in Cipher

  1. Log in to Cipher.

  2. Open the sidebar → API Keys.

    Screenshot of a sidebar navigation menu in a dark-themed application interface. The menu shows options including New Chat, Guides, API Key, and Unity Plugin. A red arrow points to the API Key option, highlighting it. Both API Key and Unity Plugin have a small “NEW” badge next to them. A close (X) icon appears in the top-right corner of the menu, and a Chat History section label is visible below the menu items.
  3. Click on + Create API Key

    API Keys page showing no existing keys and a highlighted “Create API Key” button for generating a new API key.
  4. Create a new API key and give it a recognizable name.

    Screenshot of a “Create API Key” modal in a dark-themed interface. The modal warns users to copy and securely store their API key, noting it cannot be viewed again later. A Name field is shown with the value “Cipherian”, accompanied by a confirmation label reading “Added!” Below, a section labeled “Your API Key” displays a partially masked key (sk_live_****A93D) with a copy icon to the right for copying the key. A security reminder warns users not to share their API key with others. At the bottom of the modal, a large purple “Done” button is visible to complete the process.
  5. Copy the API key.

⚠️ API keys are sensitive. Keep them secure and never share or expose them in client-side code. API keys are shown only once when generated.


3. Connecting Cipher to Unity

  1. Open your Unity project.

  2. Locate the Cipher – Unity Asset Integration panel inside the Unity Editor.

  3. Paste your API key into the connection field.

  4. Confirm the connection.

Once connected, the plugin will verify your account and prepare for asset syncing.

Screenshot of the Cipher Unity plugin login window in a dark-themed desktop interface. The window displays the Cipher logo and the tagline “The future of game creation” centered near the top. Below is a text input field labeled “Enter your API Key”, followed by a prominent purple “Login” button. Small instructional text beneath the button explains that an API key is required to access the plugin and directs users to chat.ambitionz.ai to obtain a key. The interface uses a minimalist layout with rounded input fields and buttons, designed for entering an API key and signing in.

4. Syncing Assets from Cipher

  • Newly generated 3D assets in Cipher are automatically synced.

  • Assets also sync after each successful generation.

Cipher Asset Library inside Unity showing AI-generated 3D assets with preview thumbnails and download options.
file-download
12MB

5. Where Assets Appear in Unity

  • All synced assets are imported into a dedicated Cipher folder in your Unity project. Assets / Cipher Downloads / …

  • Folder structure is preserved to keep assets organized.

  • Assets are ready to be dragged directly into scenes.

Now you are ready!

Last updated