Skip to main content

Components

đź“Ś If you have any questions shoot us an email or join us on Discord! đź’ś

Overview​

A component in Multiplayer is any piece of software that provides or consumes an API—such as a web app, microservice, or third-party SaaS provider.

By listing all your components, you can build a comprehensive, searchable software catalog. Developers can quickly find what they need, and engineering leaders gain full visibility into the systems and services powering their organization.

Screenshot of the Components section

Add New Components​

There are three ways to add components to your Multiplayer project:

(1) Auto-Detected via Auto-Documentation

Auto-Documentation (a feature of the System Dashboard) leverages OpenTelemetry to automatically detect, track, and document system architecture—including components, dependencies, APIs, and more.

If Auto-Documentation detects a new component that’s not yet in your project, you’ll be prompted to review and add it. Once added, it will automatically appear in the Components section.

(2) Manually added via a Platform

When you manually add components to a Platform that component will also appear in the Components section.

To add a component via a Platform:

  • Open your Platform
  • Use the arrow icons or the "+ Add component" buttons in the toolbar or canvas

(3) Manually added to Components

You can also add a component directly from the Components section. These components will be available across the rest of the app—including your Platforms and System Dashboard.

To add a component:

  • Open your project
  • In the left-hand navigation, go to Components
  • Click "Create a component"
  • Enter a name then click "Create a new component"

Adding a new component from the Components section

🔑 Pro Tip: When editing or restructuring your components, consider creating a new design branch. This lets you experiment safely, request reviews, and discard changes if needed—without affecting your live architecture.

Edit a Component​

There are three ways to edit the components of your Multiplayer project. Any edits are instantly propgated to all other areas within the Multiplayer project that list the same component(s).

(1) System Dashboard > Component sidepanel

Double click on the component you want to edit in the System Dashboard, "Components" tab. This will open the component sidepanel where you can edit its information.

(2) Platform > Component sidepanel

Double click on the component you want to edit in your Platform. This will open the component sidepanel where you can edit its information.

(3) Components > individual Component page

  • Open your project
  • In the left-side menu, open “Components”
  • Select the component you want to edit

🔑 Pro Tip: When editing or restructuring your components, consider creating a new design branch. This lets you experiment safely, request reviews, and discard changes if needed—without affecting your live architecture.

Component Diffs and Changes​

When editing a Component consider creating a new design branch.

Any change to a component will appear highlighted when clicking the "✏️" pencil icon in the top navigation menu.

Highlighted change in a component view with diffs and changes

Component Information - About & Variables​

Component tabs

Each component has the following tabs:

(1) About

  • Icon (Upload icon / Choose from Library)
  • Name
  • Type
  • Scope
  • Owner
  • Short description
  • Color
  • Tags
  • Aliases
  • *Used in XYZ platforms
  • **Implementations
  • **APIs
  • Readme

*Used in XYZ platforms: This information is auto-populated as you add a component to a Platform.

**This information is available only when a Git integration is enabled or you have connected to a public Git repository.

(2) Variables

Environment variables help developers set up dynamic parameters at the application component level without hardcoding sensitive information like database passwords or API keys into the codebase.

Here you can:

  • Select/Deselect the Environments from the drop down menu
  • Add/edit/delete a component variable
  • Search component variables

(3) Releases

Releases releated to that component will be auto-populated when a Git integration is enabled or you have connected to a public Git repository.

Add a Component Alias​

The same component might have multiple names in your system.

For example you may:

  • Use shortned component names (e.g. "Authentication" and "Auth")
  • Use specific naming convention (e.g. “(Component name)-(environment)”) to identify the same component in different environments.

To avoid duplication and misunderstandings, you can list all the aliases a component has in your system:

  • Open your project
  • In the left-side menu, open “Components”
  • Select the component you want to edit
  • In the "About" tab scroll down to the "Alias" field and list here all the alternative names for this component.

Delete a Component​

You can delete components from:

(1) Platforms

  • Open your project
  • In the left-side menu, open “Platforms”
  • Open the desired platform
  • Select a component
  • Hit “delete” on your keyboard

ℹ️ Please note that components deleted from a Platform are also deleted from all platform views, but not deleted from the Component section.

(2) Components

  • Open your project
  • In the left-side menu, open “Components”
  • Click on the ellipsis button “…” for the component you want to delete
  • Select “Delete”
  • Confirm your action in the prompt - please note that you can’t undo or recover deleted components.

ℹ️ Please note that components deleted from the Component section are deleted from all places within the project where they were listed.

Next Steps​

You did it! What’s next?