Skip to content

Commit

Permalink
Add simulator extension doc page (#10219)
Browse files Browse the repository at this point in the history
* support for simulator extensions

* lint

* lint

* n

* restore

* restore

* read

* wording

* simxdevmode

* add test simx

* async componentDidMount

* `e` -> `x`

* update docs
  • Loading branch information
eanders-ms authored Oct 7, 2024
1 parent 24684d5 commit 77bd4b9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions common-docs/extensions/simulator-extensions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Simulator Extensions

A simulator extension is a static web application that complements a traditional MakeCode extension. When you add an extension containing a simulator extension to your MakeCode project, the simulator extension is loaded into a separate iframe within the MakeCode editor. This enables extensions to display custom UI when the project is running.

> [!IMPORTANT]
> Simulator extensions are only supported for [Approved Extensions](./approval.md), and they must go through an additional approval process. The MakeCode team reserves the right to approve or decline simulator extensions at their discretion. We strongly recommend consulting with the MakeCode team before investing time and resources into creating a simulator extension.
## Example simulator extensions

* [pxt-simx-sample](https://github.com/microsoft/pxt-simx-sample)
* [pxt-arcadeshield](https://github.com/microsoft/pxt-arcadeshield)
* [microbit-robot](https://github.com/microsoft/microbit-robot)
* [pxt-jacdac](https://github.com/microsoft/)

## Creating a simulator extension

Refer to the [pxt-simx-sample](https://github.com/microsoft/pxt-simx-sample) project for detailed instructions.

0 comments on commit 77bd4b9

Please sign in to comment.