Skip to content

Winsert Development Guide Home

Spatchy edited this page Jan 30, 2023 · 3 revisions

| Next: Winsert Structure Overview ⯈


Winserts Explained

Winserts are what makes Winside useful and usable. Imagine a smartphone without apps or a browser without any sites to visit and you have a basically useless tool. Winside is a tool for displaying web content and that content is made compatible with Winside through Winserts. This documentation will provide all the information necessary to create your own Winsert.

When a Winsert is installed on the user's device, it is given a unique ID. This ID (called the Winsert ID from here onwards) is what is used to make the sidebar open and display the specified Winsert's content. You can check the Winsert IDs of all your installed Winserts by looking at the index.json file in the Winside data folder %Appdata%/Winside.

TIP: To make debugging your Winsert easier, enable the Chromium developer tools. Open the settings window, and at the bottom of general settings enable developer options, then under the developer tab check the box "Open Chromium dev tools when sidebar is shown"

Winsert Development Guide Contents

  1. Winsert Structure Overview
  2. The Manifest File
  3. Injectable Content Overview
  4. Winside API Reference
  5. Expose Addons Reference
  6. Bundling, Installation and Running
  7. Distributing and Sharing

| Next: Winsert Structure Overview ⯈

Clone this wiki locally