DOCUMENTATION

Sunrise Studio

A Windows editor that browses, edits and builds Destiny 2 content for Sunrise.

Warning

Studio is an alpha, and many of its edits may not work in game. Each guide says which of its steps work in game. A feature known to be broken or only partly working carries a WIP tag in Studio. Hover the tag to see what is wrong.

Sunrise Studio is a Windows editor for the Destiny 2 build that Sunrise runs. It reads the packages of the installed game directly, so the game does not need to run. Studio shows maps, missions and assets, keeps changes in a project, and builds the project into a Sunrise mod.

Start with Getting started, then read The interface.

What Studio can do

areawhat Studio does
Browsebrowse by category, such as items and enemies, each with its own viewer; dress guardians in armor; search any package entry by name or tag
Maps and missionsopen a whole map or mission in 3D with the game’s own shaders
Destinationscopy an installed destination with the bubbles you choose, as a new destination with its own free-roam activity; place a World Import Bundle in it; add it to the Director
Entitiesplace a new or copied animated entity, or a door, in a destination your project made; make a squad spawn a copy of an installed enemy
Placementmove, rotate and scale placed objects and groups of them; copy or remove static objects; edit trigger bounds
Collisionview, export and edit static collision; add new shapes
Assetsread properties, references and bytes; edit every field the tag registry describes
Modelsadd static props from OBJ, glTF or Blender; replace a skinned model on an installed rig
Materials and textureschange texture slots and constants; import PNG and DDS images
Animationplay clips; edit dense control channels through glTF; animate an exotic weapon and its first-person arms in Blender
UIedit CUI screens and bind their values to mod settings
Createstart new content as New or Clone from its category; pick or make each part
Items and vendorsedit stats, perks, perk behavior, sockets and prices; create items, exotic weapons and vendors from installed ones
Mission scriptsbuild and edit mission scripts as a node graph or as Lua
Audioplay, export and audition Wwise audio; replace a weapon’s sounds with WAV files
Livefollow a running game: its camera, map, objects, animation and UI screens
Modsbuild packages, install the project as a Sunrise mod, update a running game

What Studio cannot do

  • Create a map, activity, combatant, audio bank or animation clip from nothing. A new destination starts as a copy of an installed one, and a new enemy as a copy of an installed enemy.
  • Place a new entity or model in an installed map. New entities and bundle models go only into a destination your project made. A new static prop is a standalone model.
  • Author shaders.
  • Write into the game’s packages folder. Inside the installation, Studio writes only into the Sunrise mods folder.
  • Run mission logic or reproduce the game’s lighting exactly.

Author map content shows the closest supported path for map work.

Main ideas

Installation

The installation is the game folder with Sunrise in it. Studio reads its packages, its Sunrise SDK files and the key and decoder files it needs. Studio never changes the installed packages.

Project

A project is a folder with a sunrise.project.json file. All changes live there. Without a project, Studio is view only. A project holds edits, not copies of game data. The exception is a copied destination: its world tags are copies of installed tags, as loose tag files.

Byte delta and object edit

Studio stores a change in one of two ways.

kindholdsmade by
object editnew position, rotation, scale or trigger bounds for one world object, or an added or removed staticthe placement editor, collision moves
byte deltawhich bytes of an asset changed, as copy ranges and XOR masksproperty edits, byte edits, imports, material and texture edits

Both are checked against the installed bytes. If the game files change, Studio refuses to build until the stale edit is reverted. How projects store edits has the detail.

Added asset

An added asset is a new package entry that the project owns, such as a new texture or a new item. Added assets go into new packages with an unused package ID.

Build

A build turns the project into package files and patches. Build packages writes them into the project’s build folder. It never touches the installation.

Install as mod

Build and install builds the project and installs it as a Sunrise mod in bin/x64/Sunrise/mods/<mod id>. Sunrise loads it at the next game start. Mods explains how Sunrise loads it.

Pages in this section

The pages come in three groups:

  • Start here: getting started and the interface.
  • Guides: one task each, as numbered steps.
  • How it works: the formats and the code behind Studio, for readers who want the detail.

Getting started

Start Studio, choose the game installation and create a first project.

Read more →

The interface

The window frame, toolbar, editor areas, menus, panels and status bar of Studio.

Read more →

Arrange the layout

Split, resize, swap, maximize and pop out editor areas, and reset the layout.

Read more →

Open a map or mission

Open a whole map, add a mission's content to it, and choose which states and layers you see.

Read more →

Use the camera

Orbit, pan and zoom, fly through a map like a player, and jump to a spawn point.

Read more →

Find and open assets

Search and filter the asset browser, open an asset, follow its links, and go back and forward.

Read more →

Hide and isolate objects

Hide objects and branches of the object tree, isolate a selection, and show everything again.

Read more →

Move, rotate and scale objects

Move, rotate and scale placed objects and groups in a map, then undo or revert the change.

Read more →

Edit trigger bounds

Resize a mission trigger volume by changing its minimum and maximum corners, or move it.

Read more →

Convert placement deltas

Turn byte deltas that only move objects into object edits.

Read more →

Edit properties and bytes

Change any asset through its decoded fields, its bytes or an exported file.

Read more →

Create from a category

Start new content as New or Clone from its category, pick or make each part, and edit an existing asset in a workflow.

Read more →

Add a static prop

Create a new standalone static model from an OBJ, glTF or GLB file.

Read more →

Import an original Blender asset

Export a model you made in Blender and import it with its materials and textures.

Read more →

Edit an asset in Blender

Install the Blender add-on, edit a full asset bundle in Blender and import the edits.

Read more →

Import and edit textures

Create a texture from a PNG, or replace the pixels of an installed texture.

Read more →

Edit materials

Read, change and copy a material, in Studio or in Blender.

Read more →

Edit collision

Show collision, edit parts of a collision mesh, and move, change and add collision shapes.

Read more →

Replace a skinned model

Put new skinned geometry on an installed rig, or create a new entity on the Hob profile.

Read more →

Edit animation controls

Export a clip's control channels to glTF, edit them in Blender and import them back.

Read more →

Export a map to Blender

Write the open map or mission as a shared world scene and open it in Blender.

Read more →

Author map content

Copy an installed destination as a new one, place content in it, change maps and missions, and ship the changes as a mod.

Read more →

Place a World Import Bundle

Place bubbles made in Blender into a new destination: statics, collision, lights, entities, triggers, doors, squads, creatures and sounds.

Read more →

Edit CUI screens

Move, resize, add and remove UI widgets, change their text and bitmaps, and preview bindings.

Read more →

Bind CUI values to mod settings

Let players change a CUI layout value or comparison through a mod config setting.

Read more →

Edit items and vendors

Browse the item and vendor catalog and change rarity, stats, perks, sockets, sales and prices.

Read more →

Create items and vendors

Clone items of any category and vendors, create exotic weapons, and edit items later.

Read more →

Edit perk behavior

Build a new perk graph, or open an installed perk and save a patch.

Read more →

Create an exotic weapon

Model a weapon in Blender, export it with the add-on, and build an exotic weapon from it.

Read more →

Guardians

View the Titan, Hunter and Warlock bodies with a face, armor and a weapon, and export the whole guardian to Blender.

Read more →

Enemies and NPCs

Find enemies and NPCs, see their model and components, edit their configs, and copy an enemy into a squad.

Read more →

Script a mission

Create and edit mission scripts in the Mission Graph, as nodes or as Lua.

Read more →

Play and export audio

Play and export game audio, and preview music compositions, playlists and transitions.

Read more →

Connect to a running game

Attach Studio to a running game to follow its camera, map, objects, animation and UI screens.

Read more →

Wide-hash aliases

Give a new native asset the 64-bit keys the game uses to find it.

Read more →

Build and install a mod

Build a project, install it as a Sunrise mod, and update a running game.

Read more →

Cache settings

Turn the loading cache on or off, set its size limit and clear it.

Read more →

Shortcuts and presets

Every shortcut, its binding in each preset, and how to change a binding.

Read more →

How Studio is built

The libraries that make up Studio, what each one owns, its threads, and how to extend it.

Read more →

How projects store edits

How a project stores its changes as differences from the installed game.

Read more →

How a build works

How a build writes packages and patches, updates dependency records and manifests, and installs a mod.

Read more →

Interchange formats

What each export and import format holds, including Blender asset bundles and world scenes.

Read more →

Native authoring profiles

The exact game layouts Studio writes new geometry, materials, skins and animation controls for.

Read more →

Static collision internals

How Studio reads, draws, moves and writes baked Havok collision.

Read more →

How Studio names assets

Where asset, object and bubble names come from, how sure each one is, and how naming loads.

Read more →

CUI layout internals

How the CUI page composes screens, writes layout and content edits, evaluates bindings, draws text and matches game widgets.

Read more →

Investment editing internals

How item and vendor edits are written, and what new items, vendors, perks and string banks add to the game data.

Read more →

Rendering and lighting

How Studio draws game materials, decals, foliage and particles, and how it lights them.

Read more →

Viewport performance

What the viewport keeps between frames and edits, so large maps stay fast to draw and edit.

Read more →

The live link

How Studio and a running game share camera, world, object, animation and UI screen data, the command link and the investment link.

Read more →

Audio internals

How Studio reads Wwise banks, mixes music timelines, times transitions and builds new sound and music banks.

Read more →