MutigerAffe Wiki - User contributions [en]

MediaWiki:Sidebar

2026-10-20T21:30:08Z

Maintenance script: System

* navigation
** mainpage|mainpage-description
** randompage-url|randompage
** recentchanges-url|recentchanges
* Hytale
** BlockFactory:Main Page|Block Factory
** BetterBiomes:Main Page|Better Biomes
** BetterStorage:Main Page|Better Storage
** AcidGrounds:Main Page|Acid Grounds
** PocketBots:Main Page|Pocket Bots
** AnotherBackpackContent:Main Page|Another Backpack Content
* Libraries
** UtilityBiome:Main Page|Utility Biome
** UtilityConnect:Main Page|Utility Connect
* Minecraft
** TimeChecker:Main Page|Time Checker
* Terraria
** NewRanch:Main Page|New Ranch
* VS Code
** BlockyRenderer:Main Page|Blocky Renderer
** PrefabRenderer:Main Page|Prefab Renderer
** StudioZip:Main Page|Studio ZIP
** TaskDeck:Main Page|Task Deck
** StatLens:Main Page|Stat Lens
** LightweightWhiteboard:Main Page|Lightweight Whiteboard
* Links
** https://mutigeraffe.com/|mutigeraffe.com
* SEARCH
* TOOLBOX
* LANGUAGES

Main Page

2026-10-20T21:30:04Z

Maintenance script: Hauptseiten

{{MA Box start|title=Welcome to the MutigerAffe Wiki}}

The documentation for the mods and VS Code extensions by MutigerAffe. Every project has its own wiki here, with guides and reference pages checked against the project's code. The wiki currently has '''{{NUMBEROFARTICLES}}''' articles.

All projects and downloads are listed on [https://mutigeraffe.com/ mutigeraffe.com].
{{MA Box end}}
{{MA Box start|title=Hytale}}
<div class="ma-tiles ma-tiles-large">
{{MA Tile|image=BlockFactory_Icon.png|size=x96px|link=BlockFactory:Main Page|label=Block Factory}}
{{MA Tile|image=BetterBiomes_Icon.png|size=x96px|link=BetterBiomes:Main Page|label=Better Biomes}}
{{MA Tile|image=BetterStorage_Icon.png|size=x96px|link=BetterStorage:Main Page|label=Better Storage}}
{{MA Tile|image=AcidGrounds_Icon.png|size=x96px|link=AcidGrounds:Main Page|label=Acid Grounds}}
{{MA Tile|image=PocketBots_Icon.png|size=x96px|link=PocketBots:Main Page|label=Pocket Bots}}
{{MA Tile|image=AnotherBackpackContent_Icon.png|size=x96px|link=AnotherBackpackContent:Main Page|label=Another Backpack Content}}
</div>
<div class="ma-subtitle" style="margin-top:0.9em">Libraries</div>
<div class="ma-tiles ma-tiles-large">
{{MA Tile|image=UtilityBiome_Icon.png|size=x96px|link=UtilityBiome:Main Page|label=Utility Biome}}
{{MA Tile|image=UtilityConnect_Icon.png|size=x96px|link=UtilityConnect:Main Page|label=Utility Connect}}
</div>
{{MA Box end}}
<div class="ma-columns">
<div class="ma-col">
{{MA Box start|title=Minecraft}}
<div class="ma-tiles ma-tiles-large">
{{MA Tile|image=TimeChecker_Icon.png|size=x96px|link=TimeChecker:Main Page|label=Time Checker}}
</div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Terraria|class=ma-pixel}}
<div class="ma-tiles ma-tiles-large">
{{MA Tile|image=NewRanch_Icon.png|size=x96px|link=NewRanch:Main Page|label=New Ranch}}
</div>
{{MA Box end}}
</div>
</div>
{{MA Box start|title=VS Code}}
<div class="ma-tiles ma-tiles-large">
{{MA Tile|image=BlockyRenderer_Icon.png|size=x96px|link=BlockyRenderer:Main Page|label=Blocky Renderer}}
{{MA Tile|image=PrefabRenderer_Icon.png|size=x96px|link=PrefabRenderer:Main Page|label=Prefab Renderer}}
{{MA Tile|image=StudioZip_Icon.png|size=x96px|link=StudioZip:Main Page|label=Studio ZIP}}
{{MA Tile|image=TaskDeck_Icon.png|size=x96px|link=TaskDeck:Main Page|label=Task Deck}}
{{MA Tile|image=StatLens_Icon.png|size=x96px|link=StatLens:Main Page|label=Stat Lens}}
{{MA Tile|image=LightweightWhiteboard_Icon.png|size=x96px|link=LightweightWhiteboard:Main Page|label=Lightweight Whiteboard}}
</div>
{{MA Box end}}
__NOTOC__

LightweightWhiteboard:Zoom and Pan

2026-10-20T21:30:00Z

Maintenance script: LightweightWhiteboard wiki

Zooming and panning only change the view. They do not change the board and are not part of the history.

== Zoom ==
{| class="wikitable"
! Action !! How
|-
| Zoom at the pointer || Hold <code>Ctrl</code> and turn the mouse wheel. The point under the pointer stays in place.
|-
| Zoom in, zoom out || The magnifier buttons in the toolbar. Each click changes the zoom by a factor of 1.25, centered on the middle of the view.
|-
| Back to 100 % || Click the zoom level between the magnifier buttons.
|-
| Fit to window || The ''Fit to window'' button. The whole board fits into the view. Small boards are enlarged.
|}

* The zoom level ranges from 5 % to 1600 %.
* The toolbar shows the current zoom level, for example <code>89 %</code>.
* When a board is opened or reverted, it is fitted into the view. A board that is smaller than the view is shown at 100 % and is not enlarged.
* From 200 % on, pixels are shown as sharp squares, so you can see single pixels.
* All sizes on the board, such as the pen size or the pointer position in the status bar, are in board pixels and do not depend on the zoom level.

== Pan ==
When the board is larger than the view, you can move the view:
* drag with the '''middle mouse button'''
* hold <code>Space</code> and drag with the left mouse button. The pointer turns into a hand.
* use the mouse wheel without <code>Ctrl</code>, or the scroll bars

Panning works everywhere on the board, also over a floating image.

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Version History

2026-10-20T21:30:00Z

Maintenance script: LightweightWhiteboard wiki

== 1.1.0 (2026-10-18) ==
* The extension is now published as '''Lightweight Whiteboard''' by MutigerAffe. The extension ID is <code>MutigerAffe.vsc-whiteboard</code>. Version 1.0.0 was called ''VSC Whiteboard'' and had the publisher name <code>fxbixn03</code>.
* New extension icon.
* The UI is now English only. The German translation was removed.
* The extension is now under a proprietary license.

== 1.0.0 (2026-09-29) ==
The first version, released as ''VSC Whiteboard''.
* Board editor for <code>*.whiteboard</code> files, which are stored as PNG, and the command <code>Whiteboard: New Whiteboard</code>.
* Pen, eraser, line, arrow, rectangle, ellipse and triangle (outline or filled), fill bucket with tolerance, color picker.
* Color palette plus ''My colors'': define colors via RGB or hex and save them in the settings.
* Insert images by drag and drop (desktop, Explorer, browser), paste or file dialog. Move and resize them before placing.
* Undo, redo, save, revert and hot exit through VS Code. Zoom and pan.
* Optional ''Whiteboard (edit PNG)'' editor for regular PNG files.
* English and German UI.

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Main Page

2026-10-20T21:29:59Z

Maintenance script: LightweightWhiteboard wiki

{{DISPLAYTITLE:Lightweight Whiteboard Wiki}}
<div class="ma-columns">
<div class="ma-col-wide">
{{MA Box start|title=Lightweight Whiteboard}}
<div class="ma-intro"><div class="ma-intro-icon">[[File:LightweightWhiteboard_Icon.png|112px|link=|alt=Lightweight Whiteboard]]</div><div class="ma-intro-text">
'''Lightweight Whiteboard''' is a Visual Studio Code extension that opens a simple drawing board inside the editor. You can sketch with a pen, draw lines, arrows and shapes, fill areas with a paint bucket and drop images onto the board.

Each board is a <code>*.whiteboard</code> file that contains a normal PNG image, so it can live in your project like any other file. Saving, undo, redo and revert work like in any other VS Code editor. Existing PNG files can be opened in the board as well.
</div></div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Latest version}}

{| class="ma-facts"
! Extension
| 1.1.0
|-
! VS Code
| 1.90 or newer
|-
! Requires
| No other extensions
|-
! Download
| [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.vsc-whiteboard VS Code Marketplace]
|}
The information in this wiki is taken from version 1.1.0.
{{MA Box end}}
</div>
</div>
{{MA Box start|title=Quick start}}

# Install the extension from the Marketplace. See [[LightweightWhiteboard:Installation|Installation]].
# Open the Command Palette (<code>Ctrl+Shift+P</code>) and run <code>Whiteboard: New Whiteboard</code>. A blank board opens.
# Draw with the pen (<code>P</code>), pick a color from the color bar and try the shapes. See [[LightweightWhiteboard:Drawing Tools|Drawing Tools]].
# Press <code>Ctrl+S</code> and choose a name. The board is saved as a <code>.whiteboard</code> file. See [[LightweightWhiteboard:Files and Saving|Files and Saving]].
{{MA Box end}}
{{MA Box start|title=Screenshot}}
[[File:LightweightWhiteboard_Screenshot_01.png|800px|center|A new board with the toolbar, the color bar and the status bar]]
{{MA Box end}}
<div class="ma-columns">
<div class="ma-col">
{{MA Box start|title=Getting started}}
<div class="ma-tiles">
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Installation|label=Installation}}
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Getting Started|label=Getting Started}}
</div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Features}}
<div class="ma-tiles">
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Drawing Tools|label=Drawing Tools}}
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Colors|label=Colors}}
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Images|label=Images}}
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Zoom and Pan|label=Zoom and Pan}}
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Files and Saving|label=Files and Saving}}
</div>
{{MA Box end}}
</div>
</div>
{{MA Box start|title=Reference}}
<div class="ma-tiles">
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Commands and Settings|label=Commands and Settings}}
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:FAQ and Troubleshooting|label=FAQ and Troubleshooting}}
{{MA Tile|image=LightweightWhiteboard_Icon.png|link=LightweightWhiteboard:Version History|label=Version History}}
</div>
{{MA Box end}}
__NOTOC__
{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Installation

2026-10-20T21:29:59Z

Maintenance script: LightweightWhiteboard wiki

== Requirements ==
{| class="wikitable"
! VS Code
| 1.90 or newer (<code>engines.vscode</code> is <code>^1.90.0</code>)
|-
! Other extensions
| None
|-
! Operating system
| Any system that runs VS Code. The board runs in a VS Code webview and needs no external programs.
|}

== Installing ==
=== From the Marketplace ===
# Open the [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.vsc-whiteboard Lightweight Whiteboard page on the VS Code Marketplace] and click ''Install''.
# Or open the ''Extensions'' view in VS Code (<code>Ctrl+Shift+X</code>), search for ''Lightweight Whiteboard'' and click ''Install''.
# Or open ''Quick Open'' (<code>Ctrl+P</code>) and run:
<pre>
ext install MutigerAffe.vsc-whiteboard
</pre>

The extension ID is <code>MutigerAffe.vsc-whiteboard</code>. The display name is ''Lightweight Whiteboard''.

=== From a .vsix file ===
If you have a <code>.vsix</code> file, install it with ''Extensions → ... → Install from VSIX...'' or on the command line:
<pre>
code --install-extension vsc-whiteboard_1.1.0.vsix
</pre>

== Activation ==
The extension has no startup activation. VS Code loads it the first time you run <code>Whiteboard: New Whiteboard</code> or open a file in one of its editors.

== After installing ==
* Files ending in <code>.whiteboard</code> open in the board automatically.
* PNG files still open in the normal VS Code image preview. To draw on one, use ''View: Reopen Editor With...'' and choose ''Whiteboard (edit PNG)''. See [[LightweightWhiteboard:Files and Saving|Files and Saving]].

== Workspace Trust ==
The extension does not declare support for untrusted workspaces in its <code>package.json</code>. In a workspace opened in Restricted Mode, VS Code may keep it disabled until you trust the workspace.

== Uninstalling ==
Uninstall it in the ''Extensions'' view. Your <code>.whiteboard</code> files stay where they are. They are PNG images and can still be opened with any image viewer after renaming them to <code>.png</code>. The setting <code>vscWhiteboard.customColors</code> stays in your user settings until you remove it.

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Images

2026-10-20T21:29:59Z

Maintenance script: LightweightWhiteboard wiki

You can put images onto the board, for example a screenshot to mark up. An inserted image first floats above the board. You can move and resize it until you place it. Once placed, it is part of the board pixels.

== Supported formats ==
PNG, JPEG (<code>.jpg</code>, <code>.jpeg</code>), GIF, BMP, WebP, SVG, ICO, AVIF and <code>.whiteboard</code> files. An animated GIF is inserted as a still image.

Files and web images that the extension reads for the board may be at most 50 MB.

== Inserting an image ==
=== File dialog ===
Click ''Insert image...'' in the toolbar. A file dialog opens. You can select several files at once. The images appear in the middle of the visible part of the board.

=== Drag and drop ===
Drag an image onto the board. It appears centered on the drop point. If you drop several files, each further image is shifted by 24 pixels so they do not cover each other completely.

You can drop:
* '''files from the desktop or your file manager'''
* '''files from the VS Code Explorer'''
* '''images or image links from a web browser.''' The extension downloads the image. The server must send it with an image content type.

VS Code only passes a drop to the board while you hold <code>Shift</code>. The hint in the status bar reminds you of this. While you drag over the board it is highlighted as a drop target.

=== Paste ===
Copy an image file or a screenshot to the clipboard and press <code>Ctrl+V</code> on the board. The image appears in the middle of the visible part of the board. If the clipboard holds several image files, only the first one is inserted.

== Size of a new image ==
* An image that is larger than 90 % of the board width or height is scaled down to fit. Smaller images keep their size. Images are never enlarged.
* An SVG without its own size is inserted at 300 × 300 pixels.
* The image is moved so that it starts inside the board.

== Moving and resizing ==
While the image floats, it has a dashed outline and a handle in each corner. The status bar shows a hint.
{| class="wikitable"
! Action !! How
|-
| Move || Drag the image.
|-
| Resize || Drag a corner handle. The aspect ratio is kept.
|-
| Resize freely || Hold <code>Shift</code> while you drag a corner handle.
|-
| Place || Press <code>Enter</code>, click on the board next to the image, or choose another tool.
|-
| Discard || Press <code>Esc</code>, <code>Delete</code> or <code>Backspace</code>.
|}

The smallest size is 4 × 4 pixels. Parts of the image that are moved outside the board are cut off when you place it.

A floating image is also placed when you insert another image, clear the board, undo or redo. Undo right after inserting places the image and takes it back in one step.

Panning with the middle mouse button or <code>Space</code> + drag also works while the pointer is over the image. See [[LightweightWhiteboard:Zoom and Pan|Zoom and Pan]].

== Saving with a floating image ==
If you save while an image still floats, the saved file contains the image at its current position. On the board it keeps floating, so you can still move it.

== Errors ==
If an image cannot be inserted, a message appears at the top of the board and disappears after a few seconds. You can also close it with its '''×''' button. Typical messages:
{| class="wikitable"
! Message !! Cause
|-
| ''This is not an image that can be inserted.'' || The file or the dropped data could not be decoded as an image, or the drop contained no image at all.
|-
| ''Not a supported image: <name>'' || A file from the Explorer or the file dialog has an extension that is not in the list above.
|-
| ''Not an image: <address>'' || A web address did not return an image.
|-
| ''Image is too large: <name>'' || The file or download is larger than 50 MB.
|}

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Getting Started

2026-10-20T21:29:58Z

Maintenance script: LightweightWhiteboard wiki

This page shows how to open a board and what the parts of the board are.

== Opening a board ==
There are three ways to get a board:
* '''New board:''' run <code>Whiteboard: New Whiteboard</code> from the Command Palette (<code>Ctrl+Shift+P</code>). An unsaved board named <code>whiteboard-1.whiteboard</code> opens. Each further new board in the same session gets the next number.
* '''Existing board:''' open any <code>.whiteboard</code> file, for example from the Explorer. It opens in the board directly.
* '''PNG image:''' open a <code>.png</code> file, then run ''View: Reopen Editor With...'' and choose ''Whiteboard (edit PNG)''.

A new board is white and has the size from the settings <code>vscWhiteboard.defaultWidth</code> and <code>vscWhiteboard.defaultHeight</code> (default 1920 × 1080 pixels). See [[LightweightWhiteboard:Commands and Settings|Commands and Settings]].

[[File:LightweightWhiteboard_Screenshot_01.png|800px|center|The board with toolbar, color bar and status bar]]

== The parts of the board ==
=== Toolbar ===
The top row holds the tools and actions, from left to right:
{| class="wikitable"
! Group !! Buttons
|-
| Freehand || Pen, Eraser
|-
| Shapes || Line, Arrow, Rectangle, Ellipse, Triangle
|-
| Color tools || Fill bucket, Pick color
|-
| Images || ''Insert image...''
|-
| Tool options || ''Size'' slider, ''Outline'' and ''Filled'' buttons, ''Tolerance'' slider. Only the options that fit the current tool are shown.
|-
| History || Undo, Redo, ''Clear board''
|-
| Zoom || Zoom out, current zoom level, Zoom in, ''Fit to window''
|}

Hover over a button to see its name and its key. See [[LightweightWhiteboard:Drawing Tools|Drawing Tools]] and [[LightweightWhiteboard:Zoom and Pan|Zoom and Pan]].

=== Color bar ===
The second row shows the current color, a fixed palette of 16 colors and your own colors under ''My colors''. See [[LightweightWhiteboard:Colors|Colors]].

=== Board ===
The white area in the middle is the board. Around it is a margin in the background color of your VS Code theme. Transparent areas of an opened PNG are shown with a light gray checkerboard. You can drop images onto the board. See [[LightweightWhiteboard:Images|Images]].

=== Status bar ===
The bottom row shows, from left to right:
* a short hint for the current tool or for an image that is not placed yet
* the pointer position in board pixels, while the pointer is over the board
* the size of the board in pixels, for example <code>1920 × 1080 px</code>

== What the board remembers ==
Each open board remembers its tool, color, size, fill mode and tolerance while the tab is open. A board that you open for the first time starts with:
{| class="wikitable"
! Option !! Start value
|-
| Tool || Pen
|-
| Color || Black (<code>#000000</code>)
|-
| Size || 4 px
|-
| Fill mode || Outline
|-
| Tolerance || 20 %
|}

The color picker tool is never remembered. If it was active, the board comes back with the pen.

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Files and Saving

2026-10-20T21:29:58Z

Maintenance script: LightweightWhiteboard wiki

A board is stored as a single image file. There is no separate project format and no layers. What you see on the board is what is saved.

== The .whiteboard format ==
A <code>.whiteboard</code> file is a normal PNG image with a different file extension. VS Code opens these files in the board automatically.
* To view a board in another program, copy or rename it to <code>.png</code>.
* You can also rename a PNG to <code>.whiteboard</code> to open it in the board by default.
* In version control the file behaves like any other PNG image.

The size of a board is the size of its image. A new board gets the size from <code>vscWhiteboard.defaultWidth</code> and <code>vscWhiteboard.defaultHeight</code> (default 1920 × 1080 pixels). The size of an existing board cannot be changed in the board. See [[LightweightWhiteboard:Commands and Settings|Commands and Settings]].

== Editing PNG files ==
The extension has a second editor, ''Whiteboard (edit PNG)'', for normal <code>.png</code> files. It is not the default, so PNG files still open in the VS Code image preview. To draw on a PNG:
# Open the PNG.
# Run ''View: Reopen Editor With...'' from the Command Palette, or right-click the file in the Explorer and choose ''Open With...''.
# Choose ''Whiteboard (edit PNG)''.

It works exactly like the normal board. Saving overwrites the PNG file.
* Transparent areas are shown with a checkerboard and stay transparent until you draw on them.
* The eraser and ''Clear board'' paint white, they do not restore transparency.
* The board encodes the image again when you save. Extra data stored in the original file, such as text metadata, may not be kept.

Other image formats such as JPEG cannot be opened as a board. You can insert them into a board instead. See [[LightweightWhiteboard:Images|Images]].

== Saving ==
Every change marks the file as modified, like in a text editor.
* ''File → Save'' (<code>Ctrl+S</code>) writes the board to the file.
* ''File → Save As...'' writes it to a new file. The content is always PNG, whatever name you choose.
* A new board from <code>Whiteboard: New Whiteboard</code> has no file yet. Saving it opens the save dialog. If a folder is open, the dialog starts in the first workspace folder with the name <code>whiteboard-1.whiteboard</code> (or the next number).

If the board does not answer within 30 seconds while saving, VS Code shows the error ''The whiteboard did not respond in time.'' and the file is not written.

== Revert ==
''File → Revert File'' reloads the board from disk. All unsaved changes and the undo history are discarded. Reverting a new, unsaved board makes it blank again.

== Unsaved boards and hot exit ==
Unsaved boards take part in the VS Code backup. If you close VS Code with unsaved boards and hot exit is enabled (VS Code setting <code>files.hotExit</code>), the boards come back with their changes on the next start. This also works for new boards that were never saved.

== Tabs ==
* A board can only be open in one editor at a time.
* A board keeps its state while its tab is in the background, including a floating image and the undo history.

== Files that cannot be read ==
If a file is not a valid image, the board shows a blank board with the default size and the message ''The file could not be read as an image. Saving will overwrite it with the board shown here.'' This message stays until you close it. Do not save if you want to keep the original file.

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:FAQ and Troubleshooting

2026-10-20T21:29:58Z

Maintenance script: LightweightWhiteboard wiki

== FAQ ==
;Can I open a board without the extension?
:Yes. A <code>.whiteboard</code> file is a PNG image. Rename it or a copy of it to <code>.png</code> and open it in any image viewer. See [[LightweightWhiteboard:Files and Saving|Files and Saving]].

;Can I move a line or shape after drawing it?
:No. Everything you draw goes straight into the image pixels. There are no objects or layers. Use undo to take a step back. Only an inserted image can be moved and resized, and only until it is placed. See [[LightweightWhiteboard:Images|Images]].

;Can I change the size of a board?
:Not in the board. New boards get their size from <code>vscWhiteboard.defaultWidth</code> and <code>vscWhiteboard.defaultHeight</code>. Change these settings before you create the board. See [[LightweightWhiteboard:Commands and Settings|Commands and Settings]].

;Why does the eraser paint white on my PNG?
:The eraser always paints white. It does not make pixels transparent. The same applies to ''Clear board''. See [[LightweightWhiteboard:Drawing Tools#Eraser|Drawing Tools]].

;Can I write text on the board?
:There is no text tool. You can write with the pen or insert an image that contains text.

;Where are my own colors stored?
:In the user setting <code>vscWhiteboard.customColors</code>. They are not stored in the board file and are the same in every workspace. See [[LightweightWhiteboard:Colors|Colors]].

;Is the UI available in other languages?
:No. Since version 1.1.0 the board is in English only. Version 1.0.0 also had a German UI.

== Troubleshooting ==
;Dropping an image from the Explorer or the desktop does nothing.
:Hold <code>Shift</code> while you drop. Without it VS Code handles the drop itself and opens the file in a new editor instead of passing it to the board. See [[LightweightWhiteboard:Images#Drag and drop|Images]].

;''This is not an image that can be inserted.''
:The dropped or pasted data could not be read as an image. Check the format against the list on the [[LightweightWhiteboard:Images#Supported formats|Images]] page. When dragging from a web browser, try dragging the image itself instead of a link to a page.

;''Not an image'' when dropping from a browser.
:The web server did not return an image for that address, for example because the link points to a web page or a login is required. Save the image to disk first and insert the file.

;''The file could not be read as an image.''
:The file is not a valid PNG. The board shows a blank board instead. Saving would overwrite the file with that blank board. Close the tab without saving if you want to keep the file.

;The keys for the tools do not work.
:Click on the board first. The keys do nothing while a text field, for example the hex field in the color dialog, has the focus.

;A PNG still opens in the normal image preview.
:That is the default. Use ''View: Reopen Editor With...'' and choose ''Whiteboard (edit PNG)'', or set <code>workbench.editorAssociations</code>. See [[LightweightWhiteboard:Commands and Settings#Editors and file types|Commands and Settings]].

;Undo does nothing on a very large board.
:The history keeps up to about 384 MB of image data per board. Older steps are dropped when it gets larger. After ''Revert File'' the history starts empty, so steps from before the revert cannot be undone.

;''The whiteboard did not respond in time.''
:Saving waited 30 seconds for the board to hand over its image and got no answer. The file was not written. Try to save again.

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Drawing Tools

2026-10-20T21:29:58Z

Maintenance script: LightweightWhiteboard wiki

All tools draw with the left mouse button. The right mouse button has no function on the board. Every tool also has a key, shown in the button tooltip.

{| class="wikitable"
! Tool !! Key !! Options
|-
| [[#Pen|Pen]] || <code>P</code> || Size
|-
| [[#Eraser|Eraser]] || <code>E</code> || Size
|-
| [[#Shapes|Line]] || <code>L</code> || Size
|-
| [[#Shapes|Arrow]] || <code>A</code> || Size
|-
| [[#Shapes|Rectangle]] || <code>R</code> || Size, Outline or Filled
|-
| [[#Shapes|Ellipse]] || <code>O</code> || Size, Outline or Filled
|-
| [[#Shapes|Triangle]] || <code>T</code> || Size, Outline or Filled
|-
| [[#Fill bucket|Fill bucket]] || <code>F</code> || Tolerance
|-
| [[#Pick color|Pick color]] || <code>I</code> || None
|}

The keys work in upper and lower case. They do nothing while you type in a text field, for example in the color dialog, or while <code>Ctrl</code>, <code>Alt</code> or <code>Cmd</code> is held.

== Size ==
The ''Size'' slider sets the line width for the pen, the eraser and all shapes. The range is 1 to 100 pixels. The size is measured in board pixels, so it does not change with the zoom level.

Press <code>[</code> to make the size smaller and <code>]</code> to make it larger. Each step changes the size by about 15 % of the current value, but at least by 1 pixel.

The slider is hidden for the fill bucket and the color picker.

== Pen ==
The pen draws a smooth freehand line in the current color. A single click draws a dot. While the pen is active, the mouse pointer is a circle that shows the size of the pen.

== Eraser ==
The eraser works like the pen but paints white (<code>#ffffff</code>). It does not make pixels transparent. On a PNG with transparent areas, erased parts become white.

== Shapes ==
Press the mouse button at the start point, drag and release at the end point. A preview follows the mouse while you drag.
* '''Line''' draws a straight line.
* '''Arrow''' draws a line with a filled arrowhead at the end point. The head grows with the size.
* '''Rectangle''' and '''Ellipse''' fill the box between start and end point.
* '''Triangle''' draws a triangle in the box between start and end point. If you drag downwards, the tip points up. If you drag upwards, the tip points down.

A drag shorter than one pixel draws nothing.

=== Outline or filled ===
For rectangle, ellipse and triangle the toolbar shows the buttons ''Outline'' and ''Filled''. ''Outline'' draws only the border with the current size. ''Filled'' fills the whole shape with the current color. Lines and arrows have no fill mode.

=== Holding Shift ===
Hold <code>Shift</code> while you drag to constrain the shape:
{| class="wikitable"
! Shape !! With Shift
|-
| Line, Arrow || The angle snaps to steps of 45°.
|-
| Rectangle || Square
|-
| Ellipse || Circle
|-
| Triangle || Equilateral triangle
|}
You can press or release <code>Shift</code> during the drag. The preview updates right away.

=== Cancelling ===
Press <code>Esc</code> during a drag to cancel the stroke or shape. Nothing is drawn.

== Fill bucket ==
Click on the board to fill the connected area around that point with the current color. The fill spreads to the left, right, top and bottom, not diagonally.

The ''Tolerance'' slider (0 to 100 %) sets how much a pixel may differ from the clicked pixel and still be filled. At 0 % only pixels with exactly the same color are filled. Higher values also fill similar colors, which helps with anti-aliased edges. The tolerance applies to each color channel and to transparency.

The filled pixels are always fully opaque. Clicking an area that already has the current color changes nothing.

== Pick color ==
Click on the board to take the color of that pixel as the current color. You can also hold the button and drag to pick continuously. When you release the button, the board switches back to the tool you used before.

Transparent pixels are picked as they look on the white board. A fully transparent pixel gives white.

== Clear board ==
The ''Clear board'' button in the toolbar fills the whole board with white. Clearing is one step in the history and can be undone.

== Undo and redo ==
Every stroke, shape, fill, inserted image and clear is one step. Undo and redo use the normal VS Code commands, so the toolbar buttons and the usual keyboard shortcuts (<code>Ctrl+Z</code> for undo) both work. The extension adds no shortcuts of its own for this. Which key does redo depends on your VS Code key bindings.

The history keeps up to about 384 MB of image data per board. When it gets larger, the oldest steps are dropped and can no longer be undone. Reverting the file also clears the history. See [[LightweightWhiteboard:Files and Saving|Files and Saving]].

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Commands and Settings

2026-10-20T21:29:58Z

Maintenance script: LightweightWhiteboard wiki

This page lists everything the extension adds to VS Code, taken from its <code>package.json</code>, and the keys that work on the board.

== Commands ==
{| class="wikitable"
! Command Palette !! Command ID !! What it does
|-
| <code>Whiteboard: New Whiteboard</code> || <code>vscWhiteboard.new</code> || Opens a new, unsaved board named <code>whiteboard-<n>.whiteboard</code>. See [[LightweightWhiteboard:Getting Started|Getting Started]].
|}

The extension adds no menu entries. To open a PNG in the board, use the built-in VS Code command ''View: Reopen Editor With...'' or ''Open With...'' in the Explorer context menu.

== Editors and file types ==
{| class="wikitable"
! Editor !! View type !! Files !! Priority
|-
| ''Whiteboard'' || <code>vscWhiteboard.editor</code> || <code>*.whiteboard</code> || Default. These files open in the board automatically.
|-
| ''Whiteboard (edit PNG)'' || <code>vscWhiteboard.pngEditor</code> || <code>*.png</code> || Option. Only used when you choose it with ''Reopen Editor With...''.
|}

The extension adds no languages. To open all PNG files in the board by default, you can use the VS Code setting <code>workbench.editorAssociations</code>:
<pre>
"workbench.editorAssociations": {
"*.png": "vscWhiteboard.pngEditor"
}
</pre>

== Settings ==
All settings are in the section ''Whiteboard'' of the settings editor.
{| class="wikitable"
! Setting !! Type !! Default !! Values !! What it does
|-
| <code>vscWhiteboard.customColors</code> || list of strings || <code>[]</code> || hex colors like <code>#1e90ff</code> || Your saved colors from the color dialog (''My colors''). Shared by all boards. See [[LightweightWhiteboard:Colors|Colors]].
|-
| <code>vscWhiteboard.defaultWidth</code> || integer || <code>1920</code> || 100 to 8000 || Width in pixels of new boards.
|-
| <code>vscWhiteboard.defaultHeight</code> || integer || <code>1080</code> || 100 to 8000 || Height in pixels of new boards.
|}

* The board writes <code>vscWhiteboard.customColors</code> to your '''user''' settings when you save or remove a color in the color dialog. Changes to the setting reach all open boards at once.
* <code>defaultWidth</code> and <code>defaultHeight</code> are read when a board is opened. They only apply to boards without an image: new boards, reverted new boards and files that could not be read. Existing boards keep the size of their image.
* The ranges are part of the setting definition. The settings editor warns about values outside the range. The board itself does not check them.

Example for <code>settings.json</code>:
<pre>
"vscWhiteboard.defaultWidth": 1280,
"vscWhiteboard.defaultHeight": 720,
"vscWhiteboard.customColors": ["#1e90ff", "#ff8800"]
</pre>

== Keyboard shortcuts ==
The extension adds no VS Code key bindings. The following keys only work while the board has the focus and you are not typing in a text field.

=== Tools ===
{| class="wikitable"
! Key !! Tool
|-
| <code>P</code> || Pen
|-
| <code>E</code> || Eraser
|-
| <code>L</code> || Line
|-
| <code>A</code> || Arrow
|-
| <code>R</code> || Rectangle
|-
| <code>O</code> || Ellipse
|-
| <code>T</code> || Triangle
|-
| <code>F</code> || Fill bucket
|-
| <code>I</code> || Pick color
|}

=== Other keys ===
{| class="wikitable"
! Key !! Action
|-
| <code>[</code> / <code>]</code> || Smaller / larger size
|-
| <code>Shift</code> (while drawing a shape) || Square, circle, equilateral triangle, lines in 45° steps
|-
| <code>Shift</code> (while resizing an image) || Ignore the aspect ratio
|-
| <code>Esc</code> || Cancel the stroke or shape you are drawing, or discard a floating image
|-
| <code>Delete</code>, <code>Backspace</code> || Discard a floating image
|-
| <code>Enter</code> || Place a floating image
|-
| <code>Space</code> + drag || Pan the view
|-
| <code>Ctrl</code> + mouse wheel || Zoom at the pointer
|-
| <code>Ctrl+V</code> || Paste an image from the clipboard
|}

=== Undo, redo and save ===
Undo, redo, save and revert are normal VS Code commands and use your VS Code key bindings, for example <code>Ctrl+Z</code> for undo and <code>Ctrl+S</code> for save.

{{LightweightWhiteboard Nav}}

LightweightWhiteboard:Colors

2026-10-20T21:29:58Z

Maintenance script: LightweightWhiteboard wiki

The color bar below the toolbar sets the color for the pen, the shapes and the fill bucket. The eraser always paints white.

== Color bar ==
From left to right the color bar shows:
* the '''current color'''. Click it to open the [[#Color dialog|color dialog]].
* the '''palette''' with 16 fixed colors
* '''My colors''': your own saved colors, followed by a '''+''' button (''New color...'') that also opens the color dialog

Click a swatch to make it the current color. The swatch that matches the current color is highlighted. Hover over a swatch to see its hex value.

== Palette ==
{| class="wikitable"
! Row !! Colors
|-
| Grays || <code>#000000</code> (black), <code>#595959</code>, <code>#a6a6a6</code>, <code>#ffffff</code> (white)
|-
| Colors || <code>#e53935</code> (red), <code>#fb8c00</code> (orange), <code>#fdd835</code> (yellow), <code>#43a047</code> (green), <code>#00acc1</code> (cyan), <code>#1e88e5</code> (blue), <code>#283593</code> (dark blue), <code>#8e24aa</code> (purple), <code>#d81b60</code> (pink), <code>#6d4c41</code> (brown)
|-
| Light || <code>#fff59d</code> (light yellow), <code>#90caf9</code> (light blue)
|}

The palette cannot be changed. Use ''My colors'' for your own colors.

== Color dialog ==
The dialog ''Choose color'' opens below the swatch or button you clicked. It contains:
* a preview of the color and a color field that opens the standard color picker of the webview
* sliders and number fields for '''R''', '''G''' and '''B''', each from 0 to 255
* a '''Hex''' field

All fields stay in sync. The hex field accepts <code>#rrggbb</code> and the short form <code>#rgb</code>. The <code>#</code> is optional and upper and lower case don't matter. If the value is not valid, the dialog shows ''Enter a hex value like #1e90ff or #19f.'' and the buttons ''Save to my colors'' and ''Use'' are disabled.

{| class="wikitable"
! Button !! What it does
|-
| ''Save to my colors'' || Adds the color to ''My colors'' and makes it the current color
|-
| ''Use'' || Makes it the current color without saving it
|-
| ''Cancel'' || Closes the dialog without changes
|}

<code>Enter</code> works like ''Use''. <code>Esc</code> closes the dialog. Clicking anywhere outside the dialog closes it as well. Keys typed in the dialog don't switch tools on the board.

== My colors ==
Saved colors are stored in the user setting <code>vscWhiteboard.customColors</code>, not in the board file. They are shared by all boards in all workspaces.
* To remove a color, click the small '''×''' on its swatch.
* A color that is already saved is not added a second time.
* When the setting changes, for example because you edit <code>settings.json</code> by hand, all open boards update their list right away.

In <code>settings.json</code> the colors are a list of hex values:
<pre>
"vscWhiteboard.customColors": ["#1e90ff", "#ff8800"]
</pre>
The extension writes values as lowercase <code>#rrggbb</code>. Entries it cannot read are ignored. See [[LightweightWhiteboard:Commands and Settings|Commands and Settings]].

== Picking a color from the board ==
The ''Pick color'' tool (<code>I</code>) takes the color of a pixel on the board. See [[LightweightWhiteboard:Drawing Tools#Pick color|Drawing Tools]].

{{LightweightWhiteboard Nav}}

Category:LightweightWhiteboard

2026-10-20T21:29:57Z

Maintenance script: LightweightWhiteboard wiki

All pages about '''Lightweight Whiteboard''', the Visual Studio Code extension that adds a simple drawing board to the editor. Start at [[LightweightWhiteboard:Main Page]].

Template:LightweightWhiteboard Nav

2026-10-20T21:29:57Z

Maintenance script: LightweightWhiteboard wiki

<includeonly>{| class="wikitable ma-navbox lightweightwhiteboard-nav" style="width:100%; margin-top:2em; text-align:center;"
! colspan="2" | [[LightweightWhiteboard:Main Page|Lightweight Whiteboard]]
|-
! Start
| [[LightweightWhiteboard:Installation|Installation]] · [[LightweightWhiteboard:Getting Started|Getting Started]]
|-
! Features
| [[LightweightWhiteboard:Drawing Tools|Drawing Tools]] · [[LightweightWhiteboard:Colors|Colors]] · [[LightweightWhiteboard:Images|Images]] · [[LightweightWhiteboard:Zoom and Pan|Zoom and Pan]] · [[LightweightWhiteboard:Files and Saving|Files and Saving]]
|-
! Reference
| [[LightweightWhiteboard:Commands and Settings|Commands and Settings]] · [[LightweightWhiteboard:FAQ and Troubleshooting|FAQ and Troubleshooting]] · [[LightweightWhiteboard:Version History|Version History]]
|-
! Links
| [https://mutigeraffe.com/vscode/whiteboard/ Project page on mutigeraffe.com] · [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.vsc-whiteboard Download on the VS Code Marketplace]
|}
[[Category:LightweightWhiteboard]]</includeonly><noinclude>
Navigation box for all Lightweight Whiteboard pages. Add <code><nowiki>{{LightweightWhiteboard Nav}}</nowiki></code> at the bottom of every page in the LightweightWhiteboard namespace. It also adds the page to [[:Category:LightweightWhiteboard]].
</noinclude>

File:LightweightWhiteboard Icon.png

2026-10-20T21:29:57Z

Maintenance script: == Summary == LightweightWhiteboard wiki images

== Summary ==
LightweightWhiteboard wiki images

File:LightweightWhiteboard Screenshot 01.png

2026-10-20T21:29:57Z

Maintenance script: == Summary == LightweightWhiteboard wiki images

== Summary ==
LightweightWhiteboard wiki images

TaskDeck:Version History

2026-10-20T21:29:53Z

Maintenance script: TaskDeck wiki

The version numbers on this page are the ones in the extension's <code>package.json</code>. Versions before 4.0.0 were called '''Quick Tasks''' and had a different extension id.

== 4.0.0 (2026-10-18) ==
* The extension is now published as '''Task Deck''' by MutigerAffe. The extension id is <code>MutigerAffe.task-deck</code>. An earlier version installed under the old id has to be removed by hand. See [[TaskDeck:Installation|Installation]].
* The license is now a proprietary license.

== 1.2.0 (2026-10-18) ==
* New extension icon.
* New monochrome icon in the Activity Bar that follows the current theme.

== 1.1.0 (2026-09-16) ==
* Icon and color of a source are now set only in the Settings editor. <code>quickTasks.sourceIcons</code> and <code>quickTasks.sourceColors</code> offer dropdowns with suggested values. The ''Configure Source'' wizard was removed.
* Hiding a source now removes it and its tasks from the view completely, instead of leaving a dimmed row. New command '''Show Hidden Source…''' in the Command Palette to show it again.

== 1.0.0 (2026-09-11) ==
The first version.
* Sidebar view with all tasks VS Code knows about, grouped by source. Click a task to run it.
* Settings for each source: visibility, icon, color and include and exclude name patterns. Sources that are no longer found keep their settings and are marked in the view.
* The stored task list is shown at once on startup. The current list is collected in the background.
* Clicking a task that is still loading shows a status bar message.
* '''Pinned''' group at the top of the view.
* Run state on the task icons: a spinner while the task runs, a warning triangle with the exit code after a failed run.
* Search across all visible tasks from the view title.
* Setting <code>quickTasks.sourceSaveToUser</code> to save a source's settings to the user settings.
* Hidden sources stayed in the view as dimmed rows and could be shown again from there.
* A ''Configure Source'' wizard for icon, color, filters and save location.

{{TaskDeck Nav}}

TaskDeck:Task View

2026-10-20T21:29:53Z

Maintenance script: TaskDeck wiki

Task Deck adds its own container to the Activity Bar. It holds one view, ''Tasks'', with all tasks VS Code knows about.

[[File:TaskDeck_Screenshot_01.png|frame|none|The Tasks view with two sources and one task each]]

== What is listed ==
The view asks VS Code for all available tasks. These are the tasks from <code>.vscode/tasks.json</code> and the tasks of every installed task provider, for example npm scripts or Gulp and Grunt tasks.

Each task belongs to a '''source'''. The source is the name VS Code gives the task provider, for example <code>Workspace</code> for <code>tasks.json</code> or <code>npm</code>. Tasks without a source are listed under <code>Unknown</code>.

== Layout ==
* Every source is a group that you can expand and collapse. Groups start expanded.
* The groups are sorted alphabetically by source name.
* The number next to a source is the number of tasks of that source. Tasks hidden by a name filter are included in this number.
* Tasks are listed in the order VS Code returns them.
* If you pinned tasks, the '''Pinned''' group comes first. See [[TaskDeck:Pinned Tasks|Pinned Tasks]].
* If there is only one visible source and nothing is pinned, the tasks are shown directly, without a source group above them.

== Running a task ==
Click a task to run it. Task Deck starts the task through VS Code, just like ''Terminal → Run Task''.

The row of a task shows:
* the task name
* the task's detail text next to the name, if the task has one
* the detail text or the name as tooltip

The task icon is tinted in the color of its source. See [[TaskDeck:Sources|Sources]].

== Run state ==
{| class="wikitable"
! Icon !! Text next to the name !! Meaning
|-
| play icon || detail text || Ready to run
|-
| spinning icon || <code>running…</code> || The task is running
|-
| warning triangle || <code>exit 1</code> (the exit code) || The last run ended with an exit code other than 0
|-
| spinning icon || <code>loading…</code> || The entry comes from the stored list and is not confirmed yet (see below)
|}

The warning stays until the task runs again and ends with exit code 0. The exit code is only known for tasks that start a process, for example shell and process tasks. The run state is not saved and is gone after a restart of VS Code.

== Loading and refreshing ==
Collecting all tasks can take a while, for example when task providers scan the workspace. Task Deck therefore stores the last task list for each workspace.
* When you open the view, it shows the stored list at once. These entries show <code>loading…</code> and can't be run yet. Clicking one shows ''Task Deck: still refreshing the task list…'' in the status bar for a few seconds.
* At the same time the current list is collected in the background. Once it is there, the entries become runnable. The view is only redrawn if the list has changed.
* On the very first start in a workspace there is no stored list, so the view stays empty until the list is ready.

The list is collected again when:
* you click the refresh icon in the view title (<code>Refresh</code>)
* a <code>.vscode/tasks.json</code> file in the workspace is created, changed or deleted
* one of the Task Deck settings changes

Other changes, for example a new script in <code>package.json</code>, are only picked up after a refresh.

== View title buttons ==
{| class="wikitable"
! Icon !! Command !! What it does
|-
| search || <code>Task Deck: Find Task…</code> || Opens a search across all visible tasks. See [[TaskDeck:Find Task|Find Task]].
|-
| refresh || <code>Refresh</code> || Collects the task list again.
|-
| gear || <code>Open Settings</code> || Opens the Settings editor filtered to the Task Deck settings. See [[TaskDeck:Sources|Sources]].
|}

{{TaskDeck Nav}}

TaskDeck:Sources

2026-10-20T21:29:53Z

Maintenance script: TaskDeck wiki

A '''source''' is the group a task belongs to, for example <code>Workspace</code> for the tasks in <code>tasks.json</code> or <code>npm</code> for npm scripts. Task Deck lets you set for each source:
* whether it is shown
* its icon
* its color
* which of its tasks are shown

All of this is stored in the regular VS Code settings. Each setting is an object with the source name as key. Click the gear icon in the view title to open the Settings editor with only the Task Deck settings. The full list is on [[TaskDeck:Commands and Settings|Commands and Settings]].

== Hiding and showing a source ==
Hover a source and click the eye icon (''Hide Source''). The source and all its tasks disappear from the view. Task Deck saves this as <code>false</code> in <code>quickTasks.sourceEnabled</code>.

To show a hidden source again, use one of these:
* Run '''Task Deck: Show Hidden Source…''' from the Command Palette and pick the source. If no source is hidden, a message says so.
* Set its entry in <code>quickTasks.sourceEnabled</code> back to <code>true</code>, or remove the entry.

Sources that are not listed in <code>quickTasks.sourceEnabled</code> are shown.

Hidden sources and their tasks are also left out of [[TaskDeck:Find Task|Find Task]]. Pinned tasks of a hidden source stay in the '''Pinned''' group. See [[TaskDeck:Pinned Tasks|Pinned Tasks]].

=== Where the setting is saved ===
''Hide Source'' and ''Show Hidden Source'' write to the '''workspace settings''' by default, so the choice only applies to the current project.

Set <code>quickTasks.sourceSaveToUser</code> to <code>true</code> for a source to save its visibility to your '''user settings''' instead. It then applies to all projects. When Task Deck writes the value, it removes the entry for that source from the other scope, so there is only one value left.

This only affects the two commands above. When you edit a setting yourself in the Settings editor, it is saved to the scope (''User'' or ''Workspace'') you have selected there.

== Icon ==
<code>quickTasks.sourceIcons</code> sets the icon of the source group. Without an entry the source uses <code>folder</code>.

The Settings editor offers these icons in a dropdown:
<code>folder</code>, <code>package</code>, <code>tools</code>, <code>checklist</code>, <code>gear</code>, <code>rocket</code>, <code>beaker</code>, <code>terminal</code>, <code>file-code</code>, <code>database</code>, <code>cloud</code>, <code>symbol-event</code>, <code>briefcase</code>, <code>combine</code>.

Any other id from the [https://microsoft.github.io/vscode-codicons/dist/codicon.html Codicon list] works too. Enter it with ''Edit in settings.json''.

== Color ==
<code>quickTasks.sourceColors</code> tints the source icon and the icons of its tasks. Without an entry the default color of your theme is used.

The Settings editor offers these colors in a dropdown:
<code>charts.blue</code>, <code>charts.green</code>, <code>charts.orange</code>, <code>charts.red</code>, <code>charts.purple</code>, <code>charts.yellow</code>, <code>terminal.ansiBlue</code>, <code>terminal.ansiGreen</code>, <code>terminal.ansiRed</code>, <code>terminal.ansiYellow</code>, <code>terminal.ansiCyan</code>, <code>terminal.ansiMagenta</code>.

Any other id from the [https://code.visualstudio.com/api/references/theme-color Theme Color reference] works too. Enter it with ''Edit in settings.json''.

The warning triangle of a failed task always uses the warning color of the theme.

== Filtering tasks by name ==
Two settings decide which tasks of a source are shown. Both take a list of name patterns and are edited with ''Edit in settings.json''.
* <code>quickTasks.sourceInclude</code>: if the list is not empty, only tasks that match one of the patterns are shown.
* <code>quickTasks.sourceExclude</code>: tasks that match one of the patterns are hidden. This also applies to tasks that match an include pattern.

Pattern rules:
* <code>*</code> stands for any number of characters, <code>?</code> for exactly one character.
* A pattern has to match the '''whole''' task name. <code>build</code> only matches a task named <code>build</code>, <code>build*</code> also matches <code>build:prod</code>.
* Upper and lower case don't matter.

The filters apply to the view and to [[TaskDeck:Find Task|Find Task]], but not to the '''Pinned''' group. The task count next to the source still counts all its tasks.

== Sources that are no longer found ==
A source can have settings even though it no longer exists, for example after you removed a task provider or deleted the last task from <code>tasks.json</code>. Task Deck keeps such a source in the view:
* It shows a warning triangle and the text <code>not found</code>.
* The tooltip explains that its stored settings are kept in case the source comes back.
* It has no tasks and can't be expanded.

This also applies to a hidden source. Once it is no longer found, it is shown again with the warning.

If you don't need the settings any more, right-click the source and choose '''Remove Source Configuration'''. After you confirm, Task Deck deletes the entries for this source from all Task Deck settings, in the user settings and in the workspace settings. An entry in the old <code>quickTasks.sources</code> setting is only removed from the workspace settings. Once no entry is left, the source disappears from the view.

== Example ==
<pre>
"quickTasks.sourceIcons": {
"Workspace": "checklist",
"npm": "package"
},
"quickTasks.sourceColors": {
"Workspace": "charts.blue",
"npm": "charts.green"
},
"quickTasks.sourceExclude": {
"npm": ["pre*", "post*"]
},
"quickTasks.sourceEnabled": {
"Gulp": false
}
</pre>
This gives <code>tasks.json</code> tasks a blue checklist icon and npm scripts a green package icon, hides the npm scripts whose names start with <code>pre</code> or <code>post</code> and hides the Gulp source.

== Old setting ==
Older versions stored all of this in a single setting, <code>quickTasks.sources</code>. It is deprecated, but Task Deck still reads it. A value in the new settings wins. For a source that has no entry in a new setting, the value from <code>quickTasks.sources</code> is used.

{{TaskDeck Nav}}

TaskDeck:Pinned Tasks

2026-10-20T21:29:53Z

Maintenance script: TaskDeck wiki

Pin the tasks you use most to keep them at the top of the view.

== Pinning a task ==
Hover a task and click the pin icon (''Pin Task''). The task now also appears in the '''Pinned''' group at the top of the view. It stays in its own source group as well.

A task that still shows <code>loading…</code> can't be pinned yet. Wait until the task list is refreshed. See [[TaskDeck:Task View|Task View]].

== The Pinned group ==
* It is shown above all sources and starts expanded.
* The number next to it is the number of pinned tasks it shows.
* Pinned tasks have a yellow pin icon. Next to the name the group shows the source the task belongs to.
* Click a pinned task to run it. The run state (running, exit code) is shown here too.
* Pinned tasks stay in the group even if their source is hidden or a name filter hides them in their source group. See [[TaskDeck:Sources|Sources]].
* If none of the pinned tasks is found any more, the group is not shown.

== Unpinning a task ==
Hover the task '''in the Pinned group''' and click the pin icon (''Unpin Task''). The task stays in its source group.

== Where pins are stored ==
Pins are stored for each workspace, so every project has its own pinned tasks. They are not part of your settings and are not shared through <code>settings.json</code>.

A task is recognized by its source, its name and its task type. If you rename a task, pin it again.

{{TaskDeck Nav}}

TaskDeck:Main Page

2026-10-20T21:29:52Z

Maintenance script: TaskDeck wiki

{{DISPLAYTITLE:Task Deck Wiki}}
<div class="ma-columns">
<div class="ma-col-wide">
{{MA Box start|title=Task Deck}}
<div class="ma-intro"><div class="ma-intro-icon">[[File:TaskDeck_Icon.png|112px|link=|alt=Task Deck]]</div><div class="ma-intro-text">
'''Task Deck''' is a VS Code extension that lists every task VS Code knows about in its own sidebar view. This includes the tasks from <code>tasks.json</code> and the tasks that other extensions provide, for example npm scripts, Gulp or Grunt.

The tasks are grouped by their source. Click a task to run it. You can pin tasks to the top, hide sources, give each source its own icon and color and filter its tasks by name.
</div></div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Latest version}}

{| class="ma-facts"
! Extension
| 4.0.0
|-
! VS Code
| 1.85.0 or newer
|-
! Extension id
| <code>MutigerAffe.task-deck</code>
|-
! Requires
| No other extensions
|-
! Download
| [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.task-deck VS Code Marketplace]
|}
The information in this wiki is taken from version 4.0.0.
{{MA Box end}}
</div>
</div>
{{MA Box start|title=Quick start}}

# Install Task Deck from the VS Code Marketplace. See [[TaskDeck:Installation|Installation]].
# Click the Task Deck icon in the Activity Bar. The ''Tasks'' view lists all tasks, grouped by source. See [[TaskDeck:Task View|Task View]].
# Click a task to run it. While it runs, its icon spins.
# Hover a task and click the pin icon to put it into the '''Pinned''' group at the top. See [[TaskDeck:Pinned Tasks|Pinned Tasks]].
# Click the gear icon in the view title to set icons, colors and filters for your sources. See [[TaskDeck:Sources|Sources]].
{{MA Box end}}
<div class="ma-columns">
<div class="ma-col">
{{MA Box start|title=Features}}
<div class="ma-tiles">
{{MA Tile|link=TaskDeck:Task View|label=Task View}}
{{MA Tile|link=TaskDeck:Sources|label=Sources}}
{{MA Tile|link=TaskDeck:Pinned Tasks|label=Pinned Tasks}}
{{MA Tile|link=TaskDeck:Find Task|label=Find Task}}
</div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Reference}}
<div class="ma-tiles">
{{MA Tile|image=TaskDeck_Icon.png|link=TaskDeck:Installation|label=Installation}}
{{MA Tile|link=TaskDeck:Commands and Settings|label=Commands and Settings}}
{{MA Tile|link=TaskDeck:FAQ|label=FAQ}}
{{MA Tile|link=TaskDeck:Version History|label=Version History}}
</div>
{{MA Box end}}
</div>
</div>
__NOTOC__
{{TaskDeck Nav}}

TaskDeck:Installation

2026-10-20T21:29:52Z

Maintenance script: TaskDeck wiki

== Requirements ==
{| class="wikitable"
! Task Deck !! VS Code
|-
| 4.0.0 || 1.85.0 or newer (<code>^1.85.0</code>)
|}

Task Deck needs no other extensions. It shows the tasks that VS Code and your installed extensions already provide. Without a task provider for npm, Gulp or Grunt, those sources do not appear.

== Installing ==
=== From the Marketplace ===
# Open the [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.task-deck Task Deck page on the VS Code Marketplace].
# Click '''Install'''. VS Code opens and installs the extension.

=== From inside VS Code ===
# Open the Extensions view (<code>Ctrl+Shift+X</code>).
# Search for <code>Task Deck</code>.
# Click '''Install''' on the entry by MutigerAffe.

=== With a command ===
Open Quick Open (<code>Ctrl+P</code>), paste the following line and press Enter:
<pre>ext install MutigerAffe.task-deck</pre>

== First start ==
After the installation a new icon appears in the Activity Bar. Click it to open the ''Tasks'' view. The extension starts when you open the view or run one of its commands.

On the first start in a workspace the view stays empty until VS Code has collected the task list. After that Task Deck keeps a copy of the list and shows it right away the next time. See [[TaskDeck:Task View|Task View]].

== Updating from Quick Tasks ==
Before version 4.0.0 the extension was called '''Quick Tasks''' and had a different extension id. VS Code does not update it to Task Deck by itself.
* Uninstall Quick Tasks and install Task Deck. Don't keep both installed, because they use the same command and setting ids.
* Your settings carry over. Both versions use the same <code>quickTasks.*</code> settings.
* Pinned tasks are stored per extension, so pin them again in Task Deck.

== Uninstalling ==
Uninstall Task Deck in the Extensions view. Your <code>quickTasks.*</code> settings stay in your user and workspace <code>settings.json</code> files. Delete them there if you no longer need them.

{{TaskDeck Nav}}

TaskDeck:Find Task

2026-10-20T21:29:52Z

Maintenance script: TaskDeck wiki

In a workspace with many sources and tasks, searching is often faster than scrolling.

== Opening the search ==
* Click the search icon in the view title, or
* run '''Task Deck: Find Task…''' from the Command Palette.

A list titled ''Run Task'' opens. Type part of a task name to narrow it down. The filtering is done by VS Code, the same way as in other quick pick lists. The source name is shown next to each task and is searched as well. Press Enter to run the selected task.

== Which tasks are listed ==
The list contains the same tasks as the source groups in the view:
* Hidden sources and their tasks are left out.
* Tasks hidden by a name filter of their source are left out.
* Sources that are no longer found have no tasks and add nothing.
* Tasks that still show <code>loading…</code> are left out until the task list is refreshed.

The '''Pinned''' group is not searched separately. A pinned task is listed through its source, so a pinned task of a hidden source does not appear.

If no task is left, the message ''Task Deck: no runnable tasks found.'' appears.

{{TaskDeck Nav}}

TaskDeck:FAQ

2026-10-20T21:29:52Z

Maintenance script: TaskDeck wiki

;Where does Task Deck get its tasks from?
:From VS Code. It lists the same tasks as ''Terminal → Run Task'': the tasks from <code>tasks.json</code> and the tasks of all installed task providers. Task Deck does not read <code>package.json</code> or other build files itself.

;My npm scripts or Gulp tasks are missing.
:Task Deck only shows tasks that a task provider returns. Check that the extension for that tool is installed and that its task detection is turned on, for example the VS Code setting <code>npm.autoDetect</code>. Then click the refresh icon.

;I added a script, but it does not show up.
:Task Deck refreshes the list by itself only when a <code>tasks.json</code> file or a Task Deck setting changes. For other changes click the refresh icon in the view title.

;The tasks show "loading…" and do nothing when I click them.
:These entries come from the list stored at the last start. They become runnable once VS Code has collected the current list. Until then, clicking one only shows a message in the status bar. See [[TaskDeck:Task View|Task View]].

;I don't see any source groups, only tasks.
:If there is only one visible source and nothing is pinned, Task Deck lists the tasks directly. The groups come back as soon as a second source is visible or a task is pinned.

;How do I hide the source when there is no source row?
:Without a source row there is no eye icon. Set the source to <code>false</code> in <code>quickTasks.sourceEnabled</code> in the Settings editor. See [[TaskDeck:Sources|Sources]].

;A source disappeared after I clicked the eye icon. How do I get it back?
:Run '''Task Deck: Show Hidden Source…''' from the Command Palette, or set its entry in <code>quickTasks.sourceEnabled</code> back to <code>true</code>.

;I hid a source in one project and it is still shown in another.
:''Hide Source'' saves to the workspace settings by default. Set <code>quickTasks.sourceSaveToUser</code> to <code>true</code> for that source to save its visibility to the user settings, then hide it again.

;A source shows a warning triangle and "not found".
:The source has stored settings but no longer delivers tasks. Right-click it and choose '''Remove Source Configuration''' to delete the settings. See [[TaskDeck:Sources|Sources]].

;A task shows a warning triangle and "exit 1".
:The last run of the task ended with that exit code. Open the terminal of the task to see what went wrong. The warning goes away once the task runs again without an error.

;The number next to a source is higher than the number of tasks I see.
:The number counts all tasks of the source, including the ones hidden by <code>quickTasks.sourceInclude</code> or <code>quickTasks.sourceExclude</code>.

;Why does a filter pattern not match?
:A pattern has to match the whole task name. Use <code>*build*</code> instead of <code>build</code> to match every task that contains "build".

;Are my pinned tasks shared with my team?
:No. Pins are stored in the workspace storage of your VS Code and not in <code>settings.json</code>. Icons, colors, filters and hidden sources are settings, so they can be shared through the workspace <code>.vscode/settings.json</code>.

;I used Quick Tasks before. What do I have to do?
:Uninstall Quick Tasks and install Task Deck. Your settings carry over, pinned tasks have to be pinned again. See [[TaskDeck:Installation|Installation]].

{{TaskDeck Nav}}

TaskDeck:Commands and Settings

2026-10-20T21:29:52Z

Maintenance script: TaskDeck wiki

This page lists everything Task Deck adds to VS Code.

== View ==
{| class="wikitable"
! Item !! Id !! Name
|-
| Activity Bar container || <code>quickTasks</code> || Task Deck
|-
| View || <code>quickTasks.tasksView</code> || Tasks
|}

== Commands ==
{| class="wikitable"
! Command !! Id !! Where !! What it does
|-
| <code>Task Deck: Find Task…</code> || <code>quickTasks.findTask</code> || View title (search icon), Command Palette || Opens a search across all visible tasks and runs the selected one. See [[TaskDeck:Find Task|Find Task]].
|-
| <code>Refresh</code> || <code>quickTasks.refresh</code> || View title (refresh icon), Command Palette || Collects the task list again.
|-
| <code>Open Settings</code> || <code>quickTasks.manageSources</code> || View title (gear icon), Command Palette || Opens the Settings editor filtered to the Task Deck settings (<code>@ext:MutigerAffe.task-deck</code>).
|-
| <code>Task Deck: Show Hidden Source…</code> || <code>quickTasks.showSource</code> || Command Palette || Lets you pick a hidden source and shows it again.
|-
| <code>Hide Source</code> || <code>quickTasks.hideSource</code> || Source row (eye icon) || Hides the source and its tasks. See [[TaskDeck:Sources|Sources]].
|-
| <code>Remove Source Configuration</code> || <code>quickTasks.forgetSource</code> || Right-click on a source shown as <code>not found</code> || Deletes all stored settings of that source after a confirmation.
|-
| <code>Pin Task</code> || <code>quickTasks.pinTask</code> || Task row (pin icon) || Adds the task to the '''Pinned''' group. See [[TaskDeck:Pinned Tasks|Pinned Tasks]].
|-
| <code>Unpin Task</code> || <code>quickTasks.unpinTask</code> || Task row in the Pinned group (pin icon) || Removes the task from the '''Pinned''' group.
|-
| <code>Run Task</code> || <code>quickTasks.runTask</code> || Click on a task || Runs the task.
|-
| <code>Task Deck: Task List Refreshing</code> || <code>quickTasks.taskLoading</code> || Click on a task that shows <code>loading…</code> || Shows a status bar message that the list is still being refreshed.
|}

<code>Hide Source</code>, <code>Remove Source Configuration</code> and <code>Run Task</code> also appear in the Command Palette. They need a row in the view to work on, so started from the Command Palette they do not do anything useful. <code>Pin Task</code>, <code>Unpin Task</code> and <code>Task Deck: Task List Refreshing</code> are hidden from the Command Palette.

<code>Refresh</code> and <code>Open Settings</code> appear in the Command Palette without the <code>Task Deck:</code> prefix.

== Keyboard shortcuts ==
Task Deck does not add keyboard shortcuts. You can assign your own to the commands above under ''File → Preferences → Keyboard Shortcuts''.

== Settings ==
All settings are objects with the source name as key, for example <code>Workspace</code> for <code>tasks.json</code> or <code>npm</code>. The default is always an empty object. A source without an entry uses the value in the column ''Without an entry''. Details and an example are on [[TaskDeck:Sources|Sources]].

{| class="wikitable"
! Setting !! Value per source !! Without an entry !! What it does
|-
| <code>quickTasks.sourceEnabled</code> || <code>true</code>, <code>false</code> || shown || <code>false</code> hides the source and its tasks. Set by ''Hide Source'' and ''Show Hidden Source''.
|-
| <code>quickTasks.sourceIcons</code> || Codicon id || <code>folder</code> || Icon of the source group. The Settings editor offers 14 icons, any other Codicon id works in <code>settings.json</code>.
|-
| <code>quickTasks.sourceColors</code> || Theme color id || theme default || Tints the source icon and its task icons. The Settings editor offers 12 colors, any other theme color id works in <code>settings.json</code>.
|-
| <code>quickTasks.sourceInclude</code> || list of name patterns || all tasks || If not empty, only tasks that match one of the patterns are shown.
|-
| <code>quickTasks.sourceExclude</code> || list of name patterns || no task hidden || Tasks that match one of the patterns are hidden, even if they match an include pattern.
|-
| <code>quickTasks.sourceSaveToUser</code> || <code>true</code>, <code>false</code> || <code>false</code> || <code>true</code> makes ''Hide Source'' and ''Show Hidden Source'' save <code>quickTasks.sourceEnabled</code> for this source to the user settings instead of the workspace settings.
|-
| <code>quickTasks.sources</code> || object with <code>enabled</code>, <code>icon</code>, <code>color</code>, <code>include</code>, <code>exclude</code> || none || '''Deprecated.''' Still read as a fallback for sources that have no entry in the new settings.
|}

Name patterns use <code>*</code> for any number of characters and <code>?</code> for one character. A pattern has to match the whole task name. Upper and lower case don't matter.

=== Suggested icons ===
<code>folder</code>, <code>package</code>, <code>tools</code>, <code>checklist</code>, <code>gear</code>, <code>rocket</code>, <code>beaker</code>, <code>terminal</code>, <code>file-code</code>, <code>database</code>, <code>cloud</code>, <code>symbol-event</code>, <code>briefcase</code>, <code>combine</code>

=== Suggested colors ===
<code>charts.blue</code>, <code>charts.green</code>, <code>charts.orange</code>, <code>charts.red</code>, <code>charts.purple</code>, <code>charts.yellow</code>, <code>terminal.ansiBlue</code>, <code>terminal.ansiGreen</code>, <code>terminal.ansiRed</code>, <code>terminal.ansiYellow</code>, <code>terminal.ansiCyan</code>, <code>terminal.ansiMagenta</code>

== Stored data ==
Besides the settings, Task Deck stores two things for each workspace in the VS Code workspace storage:
* the pinned tasks
* the last task list, which is shown at once on the next start

Neither is written to <code>settings.json</code>.

== File types ==
Task Deck adds no languages, file types or editors. It watches <code>.vscode/tasks.json</code> files in the workspace and refreshes the list when one of them changes.

{{TaskDeck Nav}}

Category:TaskDeck

2026-10-20T21:29:51Z

Maintenance script: TaskDeck wiki

All pages about '''Task Deck''', the VS Code extension that lists all available tasks, grouped by source, in the sidebar. Start at [[TaskDeck:Main Page]].

Template:TaskDeck Nav

2026-10-20T21:29:51Z

Maintenance script: TaskDeck wiki

<includeonly>{| class="wikitable ma-navbox taskdeck-nav" style="width:100%; margin-top:2em; text-align:center;"
! colspan="2" | [[TaskDeck:Main Page|Task Deck]]
|-
! Start
| [[TaskDeck:Installation|Installation]]
|-
! Features
| [[TaskDeck:Task View|Task View]] · [[TaskDeck:Sources|Sources]] · [[TaskDeck:Pinned Tasks|Pinned Tasks]] · [[TaskDeck:Find Task|Find Task]]
|-
! Reference
| [[TaskDeck:Commands and Settings|Commands and Settings]] · [[TaskDeck:FAQ|FAQ]] · [[TaskDeck:Version History|Version History]]
|-
! Links
| [https://mutigeraffe.com/vscode/task-deck/ Project page on mutigeraffe.com] · [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.task-deck Install from the VS Code Marketplace]
|}
[[Category:TaskDeck]]</includeonly><noinclude>
Navigation box for all Task Deck pages. Add <code><nowiki>{{TaskDeck Nav}}</nowiki></code> at the bottom of every page in the TaskDeck namespace. It also adds the page to [[:Category:TaskDeck]].
</noinclude>

File:TaskDeck Icon.png

2026-10-20T21:29:51Z

Maintenance script: == Summary == TaskDeck wiki images

== Summary ==
TaskDeck wiki images

File:TaskDeck Screenshot 01.png

2026-10-20T21:29:50Z

Maintenance script: == Summary == TaskDeck wiki images

== Summary ==
TaskDeck wiki images

StudioZip:Version History

2026-10-20T21:29:47Z

Maintenance script: StudioZip wiki

There are no versions 2.x or 3.x. The version number went from 1.1.0 straight to 4.0.0.

== 4.0.0 (2026-10-18) ==
* The extension is now published as '''Studio ZIP''' by MutigerAffe. Earlier versions were called "Studio-Zip" and used the publisher <code>fxbixn03</code>.
* The extension id changed to <code>MutigerAffe.studio-zip</code>. An earlier version installed under the old id is not updated and has to be uninstalled by hand.
* Commands and the editor title now use the name "Studio ZIP".
* The license changed from GPL 3.0 or later to a proprietary license. Third-party components are listed in <code>THIRD_PARTY_NOTICES.md</code>.

== 1.1.0 (2026-10-18) ==
* New extension icon.

== 1.0.0 (2026-08-29) ==
* Read support for the tar family: <code>.tar</code>, <code>.tar.gz</code>, <code>.tar.xz</code>, <code>.tar.bz2</code>, <code>.tar.zst</code>, <code>.tgz</code> and more.
* Read support for single compressed files: <code>.gz</code>, <code>.xz</code>, <code>.bz2</code>, <code>.zst</code>, <code>.br</code>.
* Read support for packages: <code>.deb</code>, <code>.rpm</code>, <code>.a</code>, <code>.ar</code>, <code>.cpio</code>.
* Read support for <code>.7z</code>, <code>.rar</code>, <code>.cab</code> and <code>.iso</code> through libarchive.
* Read support for <code>.asar</code> (Electron bundles).
* Encrypted ZIP entries (WinZip AES, ZipCrypto) can be read. The extension asks for the password.
* Nested archives such as <code>data.tar.zst</code> inside a <code>.deb</code>.
* Preview in the tab for text (Monaco), images and PDF.
* More file extensions open in Studio ZIP, for example <code>.unitypackage</code>, <code>.crate</code> and <code>.gem</code>, and <code>.msix</code>, <code>.appx</code>, <code>.aab</code>, <code>.love</code> and <code>.xlsm</code> as ZIP archives.

== 0.0.1 (2026-08-28) ==
The first version.
* Read and write the ZIP family (<code>.zip</code>, <code>.jar</code>, <code>.war</code>, <code>.vsix</code>, <code>.epub</code> and more) without unpacking.
* Studio ZIP tab with the archive tree on the left and a file preview on the right.
* <code>zipfs:</code> file system, so every file in an archive can be opened as a regular editor tab.
* Nested archives, such as a <code>.jar</code> inside a <code>.war</code>, can be read and written.
* Saving replaces the archive atomically and keeps compression method, modification time and the executable bit.
* Commands to mount an archive as a workspace folder and to unmount it again.
* Extension icon.

{{StudioZip Nav}}

StudioZip:Supported Formats

2026-10-20T21:29:47Z

Maintenance script: StudioZip wiki

Studio ZIP reads many archive formats. Only the ZIP family can also be written.

== Overview ==
{| class="wikitable"
! Group !! Formats !! Read !! Write
|-
| ZIP family || <code>.zip</code>, <code>.jar</code>, <code>.war</code>, <code>.apk</code>, <code>.vsix</code>, <code>.epub</code> and more, see below || yes || yes
|-
| tar || <code>.tar</code>, <code>.gem</code> || yes || no
|-
| Compressed tar || <code>.tar.gz</code>, <code>.tgz</code>, <code>.taz</code>, <code>.tar.bz2</code>, <code>.tbz</code>, <code>.tbz2</code>, <code>.tar.xz</code>, <code>.txz</code>, <code>.tar.zst</code>, <code>.tzst</code>, <code>.unitypackage</code>, <code>.crate</code> || yes || no
|-
| Single compressed files || <code>.gz</code>, <code>.bz2</code>, <code>.xz</code>, <code>.zst</code>, <code>.br</code> || yes || no
|-
| Packages || <code>.deb</code>, <code>.udeb</code>, <code>.a</code>, <code>.ar</code>, <code>.rpm</code>, <code>.cpio</code> || yes || no
|-
| Other archives || <code>.7z</code>, <code>.rar</code>, <code>.cab</code>, <code>.iso</code> || yes || no
|-
| Electron bundles || <code>.asar</code> || yes || no
|}

Not supported: <code>.msi</code>, <code>.dmg</code>, squashfs and <code>.AppImage</code>, <code>.pkg</code> (xar), lha, <code>.lz4</code>, <code>.lz</code>, <code>.lzo</code> and old Unix <code>.Z</code> files.

== Opens on click ==
Studio ZIP is the default editor for these file name patterns. Clicking such a file in the Explorer opens the [[StudioZip:Archive Tab|Studio ZIP tab]].

{| class="wikitable"
! Group !! Extensions
|-
| ZIP || <code>.zip</code>, <code>.zipx</code>
|-
| Java and Android || <code>.jar</code>, <code>.war</code>, <code>.ear</code>, <code>.aar</code>, <code>.jmod</code>, <code>.apk</code>, <code>.aab</code>, <code>.apks</code>
|-
| Apps and plugins || <code>.ipa</code>, <code>.vsix</code>, <code>.xpi</code>, <code>.crx</code>, <code>.oxt</code>, <code>.msix</code>, <code>.msixbundle</code>, <code>.appx</code>, <code>.appxbundle</code>
|-
| Package managers || <code>.nupkg</code>, <code>.snupkg</code>, <code>.whl</code>, <code>.egg</code>, <code>.pyz</code>, <code>.conda</code>, <code>.crate</code>, <code>.gem</code>, <code>.unitypackage</code>
|-
| Documents || <code>.epub</code>, <code>.docm</code>, <code>.xlsm</code>, <code>.pptm</code>, <code>.dotx</code>, <code>.xltx</code>, <code>.potx</code>, <code>.vsdx</code>
|-
| Games || <code>.love</code>, <code>.mcaddon</code>, <code>.mcworld</code>, <code>.mcpack</code>
|-
| tar and compressed || <code>.tar</code>, <code>.tgz</code>, <code>.taz</code>, <code>.gz</code>, <code>.bz2</code>, <code>.tbz</code>, <code>.tbz2</code>, <code>.xz</code>, <code>.txz</code>, <code>.zst</code>, <code>.tzst</code>, <code>.br</code>
|-
| Packages || <code>.deb</code>, <code>.udeb</code>, <code>.ar</code>, <code>.a</code>, <code>.rpm</code>, <code>.cpio</code>
|-
| Other || <code>.7z</code>, <code>.rar</code>, <code>.iso</code>, <code>.cab</code>, <code>.asar</code>
|}

A <code>.tar.gz</code> matches <code>*.gz</code>, a <code>.tar.xz</code> matches <code>*.xz</code> and so on.

Two exceptions:
* '''<code>.asar</code>''' is in the list, but VS Code itself treats an <code>.asar</code> file as a folder, so a click never reaches Studio ZIP. Use <code>Studio ZIP: Mount Archive as Workspace Folder</code> from the Command Palette instead. An <code>.asar</code> inside another archive opens normally.
* '''Office files''' <code>.docx</code>, <code>.xlsx</code>, <code>.pptx</code>, <code>.odt</code>, <code>.ods</code> and <code>.odp</code> are not in the list, so clicking them in the Explorer does not open Studio ZIP. Studio ZIP still recognizes them as ZIP archives when they are inside another archive. There they get the archive icon and open in their own Studio ZIP tab.

== Format detection ==
File extensions are often wrong, for example a <code>.zip</code> that is really a 7z file. By default Studio ZIP reads the first bytes of the file and picks the format from its signature. Only if no signature matches does it use the file extension.

{| class="wikitable"
! Format !! Signature
|-
| ZIP || <code>PK\x03\x04</code>, also <code>PK\x05\x06</code> (empty archive) and <code>PK\x07\x08</code> (spanned)
|-
| tar || <code>ustar</code> at byte 257
|-
| gzip || <code>1F 8B</code>
|-
| bzip2 || <code>BZh</code>
|-
| xz || <code>FD 37 7A 58 5A</code>
|-
| zstd || <code>28 B5 2F FD</code>
|-
| 7z || <code>37 7A BC AF 27 1C</code>
|-
| RAR || <code>Rar!</code>
|-
| ar (<code>.deb</code>, <code>.a</code>) || <code>!<arch></code>
|-
| RPM || <code>ED AB EE DB</code>
|-
| cpio || <code>070701</code>, <code>070702</code> or <code>070707</code>
|-
| CAB || <code>MSCF</code>
|}

Brotli (<code>.br</code>), ISO and asar files are always detected by their extension.

To trust only the file extension, set <code>studioZip.detection.useMagicBytes</code> to <code>false</code>. See [[StudioZip:Commands and Settings|Commands and Settings]].

== Notes per format ==
=== ZIP family ===
Read with random access, so opening a file does not unpack the rest. Archives larger than 2 GB work. Saving rewrites the archive, see [[StudioZip:Editing Archives|Editing Archives]].

=== Compressed files ===
A <code>.gz</code>, <code>.bz2</code>, <code>.xz</code>, <code>.zst</code> or <code>.br</code> file is unpacked once when it is opened.
* If the content is a tar archive, the tab shows the full tar listing.
* Otherwise the tab shows a single file named after the archive without the compression suffix. <code>notes.txt.gz</code> contains <code>notes.txt</code>. A <code>.tgz</code> or <code>.txz</code> that holds no tar contains <code><name>.tar</code>.

zstd uses the decoder built into newer VS Code versions. Older versions fall back to a decoder bundled with the extension.

=== tar ===
GNU and PAX long file names are supported. A plain <code>.tar</code> on disk is not copied or unpacked, only its headers are read. Links and device files are listed as empty files.

=== Packages ===
* A '''<code>.deb</code>''' shows its three parts as they are: <code>debian-binary</code>, <code>control.tar.*</code> and <code>data.tar.*</code>. Open <code>data.tar.zst</code> or <code>data.tar.xz</code> like any nested archive to see the packaged files.
* An '''<code>.rpm</code>''' shows the files of its cpio payload. The payload may be compressed with gzip, xz, zstd or bzip2, or not at all.
* '''<code>.cpio</code>''' archives in the <code>newc</code>, <code>crc</code> and portable ASCII (<code>odc</code>) formats are supported.

=== 7z, RAR, CAB and ISO ===
These are read with a WebAssembly build of libarchive that ships with the extension. It is loaded only when you open such a file. RAR and RAR5 are supported. Password protected 7z and RAR archives cannot be read.

=== asar ===
Read with random access. Files that the app keeps outside the bundle (<code>.unpacked</code>) and symbolic links are listed, but they have no content inside the archive and show as empty.

=== Memory use ===
Formats that must be unpacked as a whole (compressed tar, single compressed files, RPM, 7z, RAR, CAB, ISO) are unpacked once into memory when they are opened. Above 64 MB the unpacked data goes to a temporary file in the extension's storage folder instead. The file is deleted when the archive is closed.

== Nested archives ==
A file inside an archive that has one of the archive extensions is treated as a nested archive. It gets an archive icon in the tree, and ''Open in editor'' opens it in its own Studio ZIP tab. Nesting has no depth limit, for example <code>data.tar.zst</code> inside a <code>.deb</code>, or a <code>.jar</code> inside a <code>.war</code> inside a <code>.zip</code>.

The bytes of a nested archive are taken from the outer archive and kept in memory while it is open. Writing works when every archive in the chain is a ZIP. See [[StudioZip:Editing Archives#Which archives can be written|Which archives can be written]].

== Encrypted archives ==
Encrypted ZIP entries can be read. Both WinZip AES (128, 192 and 256 bit) and the older ZipCrypto method are supported.
* Encrypted files have a lock icon in the tree. The archive listing itself is never encrypted, so the tree always opens without a password.
* The preview does not show encrypted files. Use ''Open in editor'' or ''Extract…''.
* The first time an encrypted file is read, Studio ZIP asks for the password in an input box titled <code>Password for <archive></code>.
* The password is kept in memory for this VS Code window only. It is not saved anywhere. After a reload you are asked again.
* A wrong password shows <code>Wrong password.</code> The next attempt asks again.
* An archive with encrypted entries cannot be written. See [[StudioZip:Editing Archives|Editing Archives]].

Encrypted entries in 7z and RAR archives are listed with a lock icon, but their content cannot be read.

{{StudioZip Nav}}

StudioZip:Preview

2026-10-20T21:29:46Z

Maintenance script: StudioZip wiki

The right pane of the [[StudioZip:Archive Tab|Studio ZIP tab]] shows the file you selected in the tree. The header above it shows the path of the file inside the archive.

== What is shown ==
Studio ZIP decides in this order:
{| class="wikitable"
! File !! How it is detected !! Shown as
|-
| Image || File extension <code>.png</code>, <code>.jpg</code>, <code>.jpeg</code>, <code>.gif</code>, <code>.webp</code>, <code>.bmp</code>, <code>.ico</code>, <code>.svg</code> or <code>.avif</code> || The image
|-
| PDF || Extension <code>.pdf</code>, or the file starts with <code>%PDF-</code> || PDF viewer, see below
|-
| Text || Valid UTF-8 and no zero bytes in the first 8 KB || Read-only text editor, see below
|-
| Anything else || || <code>Binary file · <size></code>
|}

The preview never changes the archive. To edit a file, use ''Open in editor''. See [[StudioZip:Editing Archives|Editing Archives]].

== Text files ==
Text is shown in Monaco, the editor engine that VS Code itself uses, bundled into the extension. The editor in the preview is read-only.
* Syntax highlighting, chosen from the file extension or name (for example <code>.java</code>, <code>.json</code>, <code>.py</code>, <code>Dockerfile</code>, <code>MANIFEST.MF</code>). Unknown types are shown as plain text.
* Code folding, the find widget (<code>Ctrl+F</code>) and a minimap.
* Light or dark colors to match the current VS Code theme. The colors change when you switch the theme.

There is no IntelliSense, no error checking and no link detection in the preview. Open the file in an editor tab to get the language features of VS Code.

== Images ==
Images are shown at their own size. Images wider than the pane are scaled down to fit its width. Scaled images are not smoothed, so pixel art stays sharp.

== PDF files ==
PDF files are rendered with pdf.js, bundled into the extension. It works offline.
* A toolbar shows the current page and the zoom level.
* ''Zoom out'' and ''Zoom in'' step through 25, 50, 75, 100, 125, 150, 200, 300 and 400 %.
* ''Fit width'' scales the pages to the width of the pane. This is the default. It follows when the pane is resized.
* Pages are rendered only near the visible area, so long documents stay fast.
* The text in a PDF cannot be selected.

== Large files ==
Files larger than <code>studioZip.preview.maxFileSizeBytes</code> (default 5 MB) are not loaded automatically. The pane shows a message such as <code>12.0 MB exceeds the 5.0 MB preview limit.</code> and a ''Show anyway'' button. Click it to load the file.

The size check uses the uncompressed size and happens before anything is unpacked. Set the value to <code>0</code> to turn the limit off. See [[StudioZip:Commands and Settings|Commands and Settings]].

== Encrypted files ==
Encrypted files are not previewed. The pane shows <code>This entry is encrypted.</code> To read an encrypted ZIP entry, use ''Open in editor'' or ''Extract…''. Studio ZIP then asks for the password. See [[StudioZip:Supported Formats#Encrypted archives|Encrypted archives]].

== Errors ==
If a file cannot be read, the pane shows the error message in place of the preview, for example when the archive is damaged.

{{StudioZip Nav}}

StudioZip:Main Page

2026-10-20T21:29:46Z

Maintenance script: StudioZip wiki

{{DISPLAYTITLE:Studio ZIP Wiki}}
<div class="ma-columns">
<div class="ma-col-wide">
{{MA Box start|title=Studio ZIP}}
<div class="ma-intro"><div class="ma-intro-icon">[[File:StudioZip_Icon.png|112px|link=|alt=Studio ZIP]]</div><div class="ma-intro-text">
'''Studio ZIP''' is a Visual Studio Code extension for archives. When you click a <code>.zip</code>, <code>.jar</code>, <code>.tar.gz</code>, <code>.7z</code> or one of many other archive files, VS Code opens a Studio ZIP tab instead of the "binary file" message. The tab shows the file tree on the left and a preview of the selected file on the right.

Every file in an archive can also be opened as a regular editor tab. Archives of the ZIP family can be edited and saved this way without unpacking them. All other formats are read-only.
</div></div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Latest version}}

{| class="ma-facts"
! Extension
| 4.0.0
|-
! VS Code
| 1.90 or newer
|-
! Requires
| No other extensions
|-
! Download
| [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.studio-zip VS Code Marketplace]
|}
The information in this wiki is taken from version 4.0.0.
{{MA Box end}}
</div>
</div>
{{MA Box start|title=Quick start}}

# Install the extension from the Marketplace. See [[StudioZip:Installation|Installation]].
# Click an archive in the Explorer, for example a <code>.zip</code>. A Studio ZIP tab opens. See [[StudioZip:Archive Tab|Archive Tab]].
# Click a file in the tree to see it on the right. Text, images and PDF files are shown directly. See [[StudioZip:Preview|Preview]].
# Hover a file and click ''Open in editor'' to edit it in a normal tab. Press <code>Ctrl+S</code> to write the change into the archive. See [[StudioZip:Editing Archives|Editing Archives]].
{{MA Box end}}
{{MA Box start|title=Screenshot}}
[[File:StudioZip_Screenshot_01.png|800px|center|A ZIP archive in the Studio ZIP tab, with the file tree on the left and the preview on the right]]
{{MA Box end}}
<div class="ma-columns">
<div class="ma-col">
{{MA Box start|title=Getting started}}
<div class="ma-tiles">
{{MA Tile|image=StudioZip_Icon.png|link=StudioZip:Installation|label=Installation}}
{{MA Tile|link=StudioZip:Archive Tab|label=Archive Tab}}
{{MA Tile|link=StudioZip:Preview|label=Preview}}
</div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Working with archives}}
<div class="ma-tiles">
{{MA Tile|link=StudioZip:Editing Archives|label=Editing Archives}}
{{MA Tile|link=StudioZip:Supported Formats|label=Supported Formats}}
</div>
{{MA Box end}}
</div>
</div>
{{MA Box start|title=Reference}}
<div class="ma-tiles">
{{MA Tile|link=StudioZip:Commands and Settings|label=Commands and Settings}}
{{MA Tile|link=StudioZip:FAQ|label=FAQ}}
{{MA Tile|link=StudioZip:Version History|label=Version History}}
</div>
{{MA Box end}}
__NOTOC__
{{StudioZip Nav}}

StudioZip:Installation

2026-10-20T21:29:46Z

Maintenance script: StudioZip wiki

== Requirements ==
{| class="wikitable"
! VS Code
| 1.90 or newer (<code>engines.vscode</code> is <code>^1.90.0</code>)
|-
! Other extensions
| None
|-
! Platforms
| One package for all platforms. The extension has no native modules. Its decoders are plain JavaScript or WebAssembly.
|}

== Installing ==
=== From the Marketplace ===
# Open the Extensions view in VS Code (<code>Ctrl+Shift+X</code>).
# Search for '''Studio ZIP''' by MutigerAffe.
# Click ''Install''.

You can also open the [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.studio-zip Marketplace page] in the browser and click ''Install'' there.

=== From the Quick Open box ===
Press <code>Ctrl+P</code>, paste the following line and press <code>Enter</code>:
<pre>ext install MutigerAffe.studio-zip</pre>

== After installing ==
Nothing has to be set up. Click an archive in the Explorer and it opens in a Studio ZIP tab. See [[StudioZip:Archive Tab|Archive Tab]].

Whether one click or a double click opens a file depends on the VS Code setting <code>workbench.list.openMode</code>, not on Studio ZIP.

== Updating from an older version ==
Versions before 4.0.0 used a different extension id. VS Code does not replace the old extension with 4.0.0 on its own. If you have an older version installed, uninstall it in the Extensions view and install the current one. See [[StudioZip:Version History|Version History]].

== Uninstalling ==
Open the Extensions view, click the gear icon next to Studio ZIP and choose ''Uninstall''. Mounted archives are workspace folders, so remove them first with <code>Studio ZIP: Unmount Archive Workspace Folder</code> or by removing the folder from the workspace.

{{StudioZip Nav}}

StudioZip:FAQ

2026-10-20T21:29:46Z

Maintenance script: StudioZip wiki

== Opening archives ==
;Clicking an archive still shows the "binary file" message.
:Check that the file extension is in the list on [[StudioZip:Supported Formats#Opens on click|Supported Formats]]. If another extension or <code>workbench.editorAssociations</code> assigns a different editor, right-click the file, choose ''Open With…'' and pick ''Studio ZIP''. In that menu you can also make it the default.

;A <code>.docx</code> or <code>.xlsx</code> does not open in Studio ZIP.
:These Office types are not registered for the Studio ZIP tab. Studio ZIP only opens them when they are inside another archive. See [[StudioZip:Supported Formats#Opens on click|Supported Formats]].

;Clicking an <code>.asar</code> file does nothing useful.
:VS Code treats <code>.asar</code> files as folders. Run <code>Studio ZIP: Mount Archive as Workspace Folder</code> from the Command Palette and choose the file there.

;The tab shows <code>Not a recognised archive: <name></code>.
:Neither the first bytes nor the file extension match a known format. The file may be damaged or of a format Studio ZIP does not support.

;A file with the wrong extension opens as the wrong format.
:With <code>studioZip.detection.useMagicBytes</code> turned on (the default), the signature of the file decides, not the extension. If you turned it off, only the extension counts. See [[StudioZip:Commands and Settings#Settings|Settings]].

;A ZIP opens, but one file shows an error such as "unsupported compression method".
:Studio ZIP reads ZIP entries that are stored or compressed with deflate. Entries that use other methods, for example LZMA or bzip2 inside a ZIP, cannot be read.

== Preview ==
;The preview shows <code>Binary file</code> for a text file.
:Text is only detected if the file is valid UTF-8 and has no zero bytes in its first 8 KB. Files in other encodings, such as UTF-16 or Latin-1 with special characters, count as binary. Open them with ''Open in editor'' to let VS Code pick the encoding.

;The preview asks me to click ''Show anyway''.
:The file is larger than <code>studioZip.preview.maxFileSizeBytes</code>. Click the button, or raise or turn off the limit. See [[StudioZip:Preview#Large files|Large files]].

;Encrypted files show <code>This entry is encrypted.</code>
:The preview does not read encrypted files. Use ''Open in editor'' or ''Extract…'' and enter the password.

== Editing ==
;I cannot save a file from a <code>.tar.gz</code>, <code>.7z</code> or <code>.deb</code>.
:Only the ZIP family can be written. Files from other formats open read-only. See [[StudioZip:Editing Archives#Which archives can be written|Which archives can be written]].

;Saving fails in a ZIP with encrypted files.
:Saving rewrites every file in the archive, and encrypted files cannot be rewritten. Archives with encrypted entries are therefore read-only in practice.

;I saved a change, but the Studio ZIP tab still shows the old content.
:The tab loads the file list once when it opens. Close the tab and open the archive again.

;I changed the archive with another program, but VS Code still shows the old content.
:Studio ZIP keeps an archive open while a tab, an editor or a mounted folder uses it, and for about one minute after the last use. Changes made by other programs during that time are not picked up. Close all Studio ZIP tabs and editors of that archive, unmount it, wait a minute and open it again.

;Saving a large archive is slow.
:ZIP cannot change a file in place, so every save writes the whole archive again. The time grows with the size of the archive, not with the size of your change.

;Where do the <code>.studio-zip-….tmp</code> files come from?
:Studio ZIP writes the new archive to such a file next to the original and then puts it in place. Normally the file is gone when the save is finished. A file left over after a crash can be deleted.

== Passwords ==
;Is my archive password saved?
:No. It is kept in memory for the current VS Code window only. Reload the window to forget it.

;I entered a wrong password.
:Reading fails with <code>Wrong password.</code> The next attempt to read an encrypted file asks again.

;Can Studio ZIP open password protected 7z or RAR archives?
:No. Their entries are listed, but the content cannot be read.

== Other ==
;Does Studio ZIP need an internet connection?
:No. All decoders, the text editor and the PDF viewer are bundled with the extension.

;Can I search inside a mounted archive?
:Studio ZIP provides no search for its file system, so ''Search'' (<code>Ctrl+Shift+F</code>) does not find text in mounted archives. Open the file and use <code>Ctrl+F</code> in the editor instead.

{{StudioZip Nav}}

StudioZip:Editing Archives

2026-10-20T21:29:46Z

Maintenance script: StudioZip wiki

Studio ZIP adds a file system with the scheme <code>zipfs:</code> to VS Code. Files inside an archive can be opened through it like normal files: in editor tabs, with syntax highlighting, find and replace and the other editor features of VS Code.

== Opening a file in an editor tab ==
In the [[StudioZip:Archive Tab|Studio ZIP tab]], hover a file and click ''Open in editor''.
* A normal file opens in a regular VS Code editor tab.
* A nested archive, for example a <code>.jar</code> inside a <code>.war</code>, opens in its own Studio ZIP tab. From there you can go one level deeper in the same way.

Files from archives that cannot be written open as read-only editors.

== Mounting an archive ==
You can also add an archive to the workspace as an extra folder. It then appears in the Explorer like any other folder, and you can browse, open, create, rename and delete files there.

* '''From the Explorer:''' right-click the archive and choose ''Mount Archive as Workspace Folder''. This menu entry is shown for <code>.zip</code>, <code>.jar</code>, <code>.war</code>, <code>.ear</code>, <code>.aar</code>, <code>.apk</code>, <code>.ipa</code>, <code>.vsix</code>, <code>.nupkg</code>, <code>.whl</code>, <code>.xpi</code>, <code>.crx</code> and <code>.epub</code>.
* '''From the Command Palette:''' run <code>Studio ZIP: Mount Archive as Workspace Folder</code> and choose the archive in the file dialog. This works for the other formats too, including <code>.asar</code>.

The folder is added at the end of the workspace and named after the archive. VS Code cannot show the content under the archive file itself, so it is a separate folder at the bottom of the Explorer. If the archive is already mounted, you get the message <code><name> is already mounted.</code>

To remove it again, run <code>Studio ZIP: Unmount Archive Workspace Folder</code> and pick the archive from the list, or remove the folder from the workspace as usual. Unmounting does not change the archive.

Searching across files (<code>Ctrl+Shift+F</code>) does not cover mounted archives. Studio ZIP provides no search for its file system.

== Which archives can be written ==
Only the '''ZIP family''' can be written: <code>.zip</code>, <code>.jar</code>, <code>.war</code>, <code>.apk</code>, <code>.vsix</code>, <code>.epub</code> and every other format that is a ZIP inside. See [[StudioZip:Supported Formats|Supported Formats]].

All other formats are read-only. Changing a single file in a <code>.tar.xz</code> would mean compressing the whole archive again on every save. Their files open as read-only editors, and the summary line of the Studio ZIP tab shows <code>read-only</code>.

A nested archive can be written if every archive in the chain is a ZIP, for example a <code>.jar</code> inside a <code>.war</code>. Saving it writes the inner archive back into the outer one. A ZIP inside a <code>.tar.gz</code> is read-only, because the outer archive cannot be written.

An archive that contains encrypted files cannot be written at all. Saving fails with <code>Cannot write to an archive with encrypted entries (<name>).</code>

== What you can change ==
In a writable archive, the following work from an editor tab or a mounted folder:
* Save changes to a file (<code>Ctrl+S</code>).
* Create new files and folders. Missing parent folders are created with them.
* Delete files and folders. Deleting a folder removes everything in it.
* Rename and move files and folders inside the same archive.

Moving a file from one archive into another is not possible in one step. Studio ZIP refuses it with <code>Studio ZIP cannot move entries between archives.</code> Copy the file and delete the original instead.

== How saving works ==
ZIP has no way to change one file in place, so every save writes the whole archive again.
* The new archive is written to a temporary file next to the original (<code><archive>.studio-zip-<random>.tmp</code>). Only when it is complete does it replace the original. If VS Code crashes while writing, the original stays as it was.
* The file permissions of the archive itself are kept.
* Files you did not change are copied over one at a time with their compression method, modification time and Unix permissions, including the executable bit. A stored (uncompressed) file stays stored. This matters for <code>.epub</code>, where the <code>mimetype</code> file must not be compressed.
* The order of the files is kept. New files are added at the end.
* Files you changed or added are compressed and get the current time.
* Saves to the same archive run one after another, so two quick saves cannot overwrite each other.

Large archives are written in a stream, so saving a file in an archive of several gigabytes does not load the whole archive into memory. Saving still takes longer the larger the archive is.

{{StudioZip Nav}}

StudioZip:Commands and Settings

2026-10-20T21:29:46Z

Maintenance script: StudioZip wiki

== Commands ==
All commands are in the category ''Studio ZIP''. Open the Command Palette with <code>Ctrl+Shift+P</code> and type "Studio ZIP".

{| class="wikitable"
! Command !! ID !! What it does
|-
| <code>Studio ZIP: Mount Archive as Workspace Folder</code> || <code>studioZip.mountArchive</code> || Adds an archive to the workspace as an extra folder. From the Command Palette a file dialog asks for the archive. From the Explorer context menu it uses the file you right-clicked. See [[StudioZip:Editing Archives#Mounting an archive|Mounting an archive]].
|-
| <code>Studio ZIP: Unmount Archive Workspace Folder</code> || <code>studioZip.unmountArchive</code> || Shows a list of the mounted archives and removes the one you pick from the workspace. If nothing is mounted, it shows <code>No archives are mounted.</code>
|-
| <code>Studio ZIP: Open in Studio ZIP</code> || <code>studioZip.openArchiveEditor</code> || Opens an archive in the Studio ZIP tab. Without an argument a file dialog asks for the archive. This command is hidden from the Command Palette. You can still bind it to a key.
|}

=== File dialog ===
The file dialog of the commands above lists these types under ''Archives'': <code>zip</code>, <code>jar</code>, <code>war</code>, <code>ear</code>, <code>aar</code>, <code>apk</code>, <code>ipa</code>, <code>vsix</code>, <code>nupkg</code>, <code>whl</code>, <code>xpi</code>, <code>crx</code>, <code>epub</code>, <code>tar</code>, <code>tgz</code>, <code>taz</code>, <code>gz</code>, <code>bz2</code>, <code>tbz</code>, <code>tbz2</code>, <code>xz</code>, <code>txz</code>, <code>zst</code>, <code>tzst</code>, <code>br</code>, <code>7z</code>, <code>rar</code>, <code>deb</code>, <code>udeb</code>, <code>ar</code>, <code>a</code>, <code>rpm</code>, <code>cpio</code>, <code>iso</code>, <code>cab</code>, <code>asar</code>, <code>unitypackage</code>, <code>crate</code>, <code>gem</code>, <code>msix</code>, <code>appx</code>, <code>aab</code> and <code>love</code>.

== Menus ==
{| class="wikitable"
! Menu !! Entry !! Shown for
|-
| Explorer context menu || ''Mount Archive as Workspace Folder'' || <code>.zip</code>, <code>.jar</code>, <code>.war</code>, <code>.ear</code>, <code>.aar</code>, <code>.apk</code>, <code>.ipa</code>, <code>.vsix</code>, <code>.nupkg</code>, <code>.whl</code>, <code>.xpi</code>, <code>.crx</code>, <code>.epub</code>
|}

Other archive types can be mounted from the Command Palette.

== Keybindings ==
Studio ZIP adds no keybindings of its own. To add one, open ''File → Preferences → Keyboard Shortcuts'' and search for the command ID. For example, in <code>keybindings.json</code>:
<pre>
{ "key": "ctrl+alt+m", "command": "studioZip.mountArchive" }
</pre>

== Settings ==
Open ''File → Preferences → Settings'' and search for "Studio ZIP", or edit <code>settings.json</code>.

{| class="wikitable"
! Setting !! Type !! Default !! What it does
|-
| <code>studioZip.preview.maxFileSizeBytes</code> || number, 0 or more || <code>5242880</code> (5 MB) || Files larger than this (uncompressed) are not previewed automatically in the Studio ZIP tab. The pane shows a ''Show anyway'' button instead. <code>0</code> turns the limit off. See [[StudioZip:Preview#Large files|Large files]].
|-
| <code>studioZip.detection.useMagicBytes</code> || boolean || <code>true</code> || Detects the archive format from the first bytes of the file. If no signature matches, the file extension is used. With <code>false</code> only the file extension counts. See [[StudioZip:Supported Formats#Format detection|Format detection]].
|}

Both settings are read when they are needed. <code>studioZip.preview.maxFileSizeBytes</code> applies to the next file you select. <code>studioZip.detection.useMagicBytes</code> applies to archives opened after the change. An archive that is already open keeps its format until it is closed.

Example:
<pre>
{
"studioZip.preview.maxFileSizeBytes": 20971520,
"studioZip.detection.useMagicBytes": true
}
</pre>

== Editor ==
{| class="wikitable"
! View type !! Name !! Priority
|-
| <code>studioZip.archive</code> || Studio ZIP || default
|}

Studio ZIP is the default editor for all patterns listed on [[StudioZip:Supported Formats#Opens on click|Supported Formats]]. To open such a file with a different editor, right-click it and choose ''Open With…''. To change the default for a pattern, use the VS Code setting <code>workbench.editorAssociations</code>.

== File system ==
Studio ZIP registers the URI scheme <code>zipfs:</code>. Files opened with ''Open in editor'' and mounted archives use it. The extension is activated when VS Code first needs this scheme or the Studio ZIP editor.

{{StudioZip Nav}}

StudioZip:Archive Tab

2026-10-20T21:29:45Z

Maintenance script: StudioZip wiki

The Studio ZIP tab is the main view of the extension. It opens when you click an archive in the Explorer, and it is the default editor for all file types listed under ''Opens on click'' on the [[StudioZip:Supported Formats|Supported Formats]] page.

[[File:StudioZip_Screenshot_01.png|800px|center|The Studio ZIP tab with the tree on the left and the preview on the right]]

== Layout ==
The tab has two panes with a splitter between them.
* '''Left:''' the file tree of the archive.
* '''Right:''' the preview of the selected file. See [[StudioZip:Preview|Preview]].

Drag the splitter to change the width of the tree. Each pane keeps at least 160 pixels.

The tab follows the VS Code color theme, light or dark. It keeps its state while it is in the background, so the tree is not rebuilt and the scroll position stays when you switch tabs.

== Summary line ==
The header above the tree shows the archive name, the number of files and the total size, for example <code>Hytale.zip · 406 files · 7.6 GB</code>.
* The size is the sum of the '''uncompressed''' sizes of all files, not the size of the archive on disk.
* Archives that cannot be written show <code>· read-only</code> at the end. Only the ZIP family is writable. See [[StudioZip:Editing Archives|Editing Archives]].
* For an archive inside another archive the name is the name of the inner archive.

== File tree ==
* Folders come first, then files. Both are sorted by name, ignoring case, with numbers in natural order (<code>2.jpeg</code> before <code>10.jpeg</code>).
* Folders on the top level are expanded when the tab opens. Click a folder to expand or collapse it.
* Click a file to select it and show its preview on the right.
* Files show their uncompressed size on the right side of the row.
* Many archives store no entries for folders. Studio ZIP adds the missing folders from the file paths, so the tree is complete anyway.

=== Icons ===
{| class="wikitable"
! Icon !! Meaning
|-
| Folder || A folder. The icon changes to an open folder when it is expanded.
|-
| Zip file || A nested archive, for example a <code>.jar</code> inside a <code>.war</code>. It can be opened in its own Studio ZIP tab.
|-
| Lock || An encrypted file.
|-
| PDF file || A <code>.pdf</code> file.
|-
| File || Any other file.
|}

=== Actions on a file ===
When you hover a file row, two buttons appear on the right:
{| class="wikitable"
! Button !! What it does
|-
| ''Open in editor'' || Opens the file in a regular VS Code editor tab. A nested archive opens in a new Studio ZIP tab instead. See [[StudioZip:Editing Archives|Editing Archives]].
|-
| ''Extract…'' || Opens a save dialog and writes a copy of the file to the place you choose. The archive is not changed. A message <code>Extracted <name>.</code> confirms it.
|}
Folders have no buttons. To extract a whole folder, mount the archive as a workspace folder and copy the folder in the Explorer. See [[StudioZip:Editing Archives#Mounting an archive|Mounting an archive]].

== What the tab cannot do ==
* The tab itself is a viewer. Editing happens in a regular editor tab or in a mounted workspace folder.
* The tree is loaded once when the tab opens. After you change the archive, close the tab and open it again to see the new content. See [[StudioZip:FAQ|FAQ]].
* An archive can only have one Studio ZIP tab at a time.

{{StudioZip Nav}}

Category:StudioZip

2026-10-20T21:29:44Z

Maintenance script: StudioZip wiki

All pages about '''Studio ZIP''', the Visual Studio Code extension that opens archives in a tab of their own and lets you read and edit them without unpacking. Start at [[StudioZip:Main Page]].

Template:StudioZip Nav

2026-10-20T21:29:44Z

Maintenance script: StudioZip wiki

<includeonly>{| class="wikitable ma-navbox studiozip-nav" style="width:100%; margin-top:2em; text-align:center;"
! colspan="2" | [[StudioZip:Main Page|Studio ZIP]]
|-
! Start
| [[StudioZip:Installation|Installation]]
|-
! Features
| [[StudioZip:Archive Tab|Archive Tab]] · [[StudioZip:Preview|Preview]] · [[StudioZip:Editing Archives|Editing Archives]] · [[StudioZip:Supported Formats|Supported Formats]]
|-
! Reference
| [[StudioZip:Commands and Settings|Commands and Settings]] · [[StudioZip:FAQ|FAQ]] · [[StudioZip:Version History|Version History]]
|-
! Links
| [https://mutigeraffe.com/vscode/studio-zip/ Project page on mutigeraffe.com] · [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.studio-zip Download on the VS Code Marketplace]
|}
[[Category:StudioZip]]</includeonly><noinclude>
Navigation box for all Studio ZIP pages. Add <code><nowiki>{{StudioZip Nav}}</nowiki></code> at the bottom of every page in the StudioZip namespace. It also adds the page to [[:Category:StudioZip]].
</noinclude>

File:StudioZip Screenshot 01.png

2026-10-20T21:29:44Z

Maintenance script: == Summary == StudioZip wiki images

== Summary ==
StudioZip wiki images

File:StudioZip Icon.png

2026-10-20T21:29:43Z

Maintenance script: == Summary == StudioZip wiki images

== Summary ==
StudioZip wiki images

StatLens:Version History

2026-10-20T21:29:39Z

Maintenance script: StatLens wiki

== 4.0.0 (2026-10-18) ==
* The extension is now published as '''Stat Lens''' by MutigerAffe. The extension id is now <code>MutigerAffe.stat-lens</code>. A version installed under an older id is not replaced and has to be uninstalled by hand. See [[StatLens:Installation#Updating from an earlier version|Updating from an earlier version]].
* New license: the extension is now proprietary. Third-party components are listed in the file <code>THIRD_PARTY_NOTICES.md</code>.
* The extension is bundled into a single file. It loads faster and the package is smaller.
* README and changelog are in English.

The ids of the command, the view and the settings did not change. They still start with <code>projectStats</code>.

== 1.1.0 (2026-10-18) ==
* The whole user interface is in English: the view, messages, progress, the command title and the setting descriptions.
* New vector icon.

== 1.0.0 (2026-09-11) ==
Listed as 0.2.0 in the changelog of the extension. A reworked view.
* Expanded and collapsed sections such as ''Languages'' and ''Git'' stay as they are when the view is refreshed or rescanned.
* The total lines of code are shown in the ''Languages'' row instead of a separate row.
* Each language shows a text bar of ten blocks next to its percentage.
* ''Project Age'' and ''Last Change'' show their source (Git commit or file timestamp) in the row itself.
* Changing <code>projectStats.ignoreComments</code> or <code>projectStats.excludeFolders</code> starts a new scan on its own.
* Warning icons use the warning color of the current theme.
* An empty view shows ''No data for this project yet.'' with a ''Scan now'' link.
* The files under ''Dependencies'' can be clicked to open them, like ''Largest File''.

== 0.1.0 (2026-09-09) ==
The first version.
* A view in the Explorer with lines of code, languages, files and size, project age, Git history and dependencies.
* Language colors from GitHub Linguist.
* Automatic rescan after file changes and a saved result per workspace.

{{StatLens Nav}}

StatLens:Sidebar View

2026-10-20T21:29:39Z

Maintenance script: StatLens wiki

Stat Lens adds one view to the Explorer, called '''Stat Lens'''. It is a tree with one row per figure. Some rows can be expanded. Expanded and collapsed sections stay as they are when the view is refreshed.

[[File:StatLens_Screenshot_01.png|475px|The Stat Lens view with the Languages section expanded]]

== Rows ==
The rows appear in this order. A row is left out when there is no value for it.

{| class="wikitable"
! Row !! Shows
|-
| ''Languages'' || Total lines of code and the number of languages, for example <code>162,687 lines · 9 languages</code>. Expand it to see each language.
|-
| ''Files'' || Number of files and folders that were scanned.
|-
| ''Size'' || Total size of all scanned files, in B, KB, MB, GB or TB (steps of 1024).
|-
| ''Largest File'' || The file with the most lines of code, with its path and line count. Click it to open the file.
|-
| ''Project Age'' || Date of the first commit, how long ago that was, and the source.
|-
| ''Last Change'' || Date of the last commit, how long ago that was, and the source.
|-
| ''Git'' || Number of commits. Expand it for more. See [[#Git|Git]].
|-
| ''Dependencies'' || Total number of dependencies in all manifest files. Expand it to see each file. See [[StatLens:Dependencies|Dependencies]].
|-
| ''Warnings'' || Only shown when the scan had problems. Expand it to see them. See [[#Warnings|Warnings]].
|-
| ''Last Scan'' || Date and time of the scan the view is showing.
|}

== Languages ==
Each language has its own row under ''Languages'', sorted by lines of code, the largest first. A row shows:
* a colored dot in the language color used by GitHub Linguist. Languages without such a color get one from a fixed palette, always the same for the same language.
* a text bar of ten blocks, for example <code>████░░░░░░</code>, as a quick visual of the share
* the share of all lines of code in percent, with one decimal
* the lines of code and the number of files in that language

The list includes programming languages and also markup, data and prose formats, for example HTML, JSON, YAML or Markdown. How lines are counted is explained on [[StatLens:Scanning|Scanning]].

== Project Age and Last Change ==
Both rows prefer Git:
{| class="wikitable"
! Row !! With Git !! Without Git
|-
| ''Project Age'' || date of the first commit (<code>source: first commit</code>) || oldest creation time of a scanned file (<code>source: oldest file</code>)
|-
| ''Last Change'' || date of the last commit (<code>source: last commit</code>) || newest modification time of a scanned file (<code>source: most recent file change</code>)
|}

The relative age is rounded down: <code>today</code>, then days, then months (30 days each), then years (365 days each).

== Git ==
Expand ''Git'' to see:
{| class="wikitable"
! Row !! Shows
|-
| ''Commits'' || Number of commits reachable from the current <code>HEAD</code>, so the history of the branch you have checked out.
|-
| ''Contributors'' || Number of different author e-mail addresses in that history. Upper and lower case are ignored.
|-
| ''First Commit'' || Date of the oldest commit. If the history has more than one root commit, the oldest one counts.
|-
| ''Last Commit'' || Date of the newest commit on <code>HEAD</code>.
|}

If the folder is not a Git repository, the ''Git'' row says <code>not a Git repository</code> and cannot be expanded. Other notes that can appear:
* <code>git is not installed or not in PATH</code>
* <code>no commits yet</code>, for a repository without commits
* <code>git log failed: ...</code>, if Git returned an error

Only the first folder of the workspace is used, so Git data comes from the repository that contains that folder.

== Warnings ==
''Warnings'' lists problems that did not stop the scan:
* <code>Folder not readable: ...</code>, for a folder the extension could not open. Its contents are skipped.
* <code>Language detection failed: ...</code>. In this case no lines of code are counted, but files, size, dates and dependencies are still shown.

If the whole scan fails, a row with <code>Scan failed: ...</code> and a warning icon appears at the top. An older result stays visible below it.

== Other states ==
{| class="wikitable"
! What you see !! Meaning
|-
| ''No data for this project yet.'' with a ''Scan now'' link || There is no result yet. Click ''Scan now'' to start a scan.
|-
| ''Scanning …'' with a spinning icon || A scan is running. The status bar shows the current step, for example <code>Counting lines … 120/497</code>.
|-
| <code>No files found</code> || The folder is empty or every file in it is excluded.
|-
| <code>No workspace folder open</code> || Open a folder to use the view.
|}

== Number and date format ==
Numbers, dates and times follow the display language of VS Code. With English, a number looks like <code>69,833</code> and a date like <code>Oct 16, 2026</code>.

{{StatLens Nav}}

StatLens:Scanning

2026-10-20T21:29:39Z

Maintenance script: StatLens wiki

This page explains what Stat Lens scans, how it counts lines and when it scans again.

== What is scanned ==
Only the '''first folder''' of the workspace is scanned. In a multi-root workspace the other folders are ignored.

The scan walks through every folder below it and skips:
* every folder whose name is in <code>projectStats.excludeFolders</code>, on any level. By default these are <code>node_modules</code>, <code>bin</code>, <code>obj</code>, <code>.git</code>, <code>dist</code>, <code>out</code>, <code>.vs</code> and <code>.vscode</code>. See [[StatLens:Commands and Settings|Commands and Settings]].
* everything excluded by the <code>.gitignore</code> file in the root of the folder. Other <code>.gitignore</code> files further down are not used for this step.
* symbolic links, both to files and to folders

Every file that is left counts towards ''Files'' and ''Size''. Every folder that is left counts towards ''Files'' as a folder. The root folder itself is not counted.

== Lines of code ==
=== Which files count ===
Lines are only counted in files that have a language. The language comes from linguist-js, which uses the rules of GitHub Linguist. It works offline with the language data that ships with the extension.

Files without a language add to ''Files'' and ''Size'', but not to the lines of code. This includes:
* binary files, such as images or archives
* files that Linguist treats as vendored, for example bundled third-party libraries
* files Linguist leaves out for other reasons, including files marked with <code>linguist-vendored</code>, <code>linguist-generated</code> or <code>linguist-documentation</code> in <code>.gitattributes</code>, and files excluded by a <code>.gitignore</code> in a subfolder
* files larger than 20 MB. They are never read line by line.

Programming languages, markup, data and prose formats all count. JSON, YAML, XML or Markdown files therefore add to the lines of code.

=== How lines are counted ===
* A line counts if it contains anything other than spaces or tabs. Blank lines never count.
* Files are read as UTF-8.
* ''Largest File'' is the file with the most counted lines, not the file with the most bytes.

=== Ignoring comment lines ===
With <code>projectStats.ignoreComments</code> set to <code>true</code>, a line also does not count if it starts with one of these, after leading spaces:

<code>//</code> · <code>#</code> · <code>/*</code> · <code>*</code> · <code>--</code> · <code><!--</code> · <code>;</code> · <code>'</code>

This is a simple check that is the same for every language. It does not understand the language itself:
* A line such as <code>x = 1; // note</code> still counts, because it does not start with a comment.
* Lines that start with one of these characters but are code also stop counting, for example <code>#include</code> in C, a Markdown heading with <code>#</code>, a list item starting with <code>*</code> or a line starting with a string in single quotes.
* The inner lines of a block comment only stop counting if they start with <code>*</code>, <code>/*</code> or one of the other prefixes.

== When it scans ==
{| class="wikitable"
! Event !! What happens
|-
| You open a folder for the first time || A scan starts on its own.
|-
| You open a folder that was scanned before || The saved result is shown at once, with its date in ''Last Scan''. No new scan starts.
|-
| You click the refresh icon or run ''Stat Lens: Rescan'' || A scan starts.
|-
| Files are created, changed or deleted || A scan starts 15 seconds after the last change. Each new change restarts the 15 seconds.
|-
| You change <code>projectStats.ignoreComments</code> or <code>projectStats.excludeFolders</code> || A scan starts at once.
|}

Changes inside an excluded folder, for example in <code>node_modules</code>, do not trigger a scan. Changes to files that are only excluded by <code>.gitignore</code> do.

While a scan is running, a second scan is not started. Clicking refresh again simply waits for the running scan.

== Progress ==
During a scan the view shows ''Scanning …'' and the status bar shows the current step:
# <code>Searching files …</code>, with <code>... files found …</code> every 500 files
# <code>Detecting languages …</code>
# <code>Counting lines … done/total</code>
# <code>Reading dependencies …</code>

The Git figures are read at the same time as the file scan.

== Saved results ==
After each scan the result is saved in the VS Code storage for this workspace. It is shown again the next time you open the same folder. Nothing is written into the project folder.

{{StatLens Nav}}

StatLens:Main Page

2026-10-20T21:29:38Z

Maintenance script: StatLens wiki

{{DISPLAYTITLE:Stat Lens Wiki}}
<div class="ma-columns">
<div class="ma-col-wide">
{{MA Box start|title=Stat Lens}}
<div class="ma-intro"><div class="ma-intro-icon">[[File:StatLens_Icon.png|112px|link=|alt=Stat Lens]]</div><div class="ma-intro-text">
'''Stat Lens''' is an extension for Visual Studio Code. It adds a '''Stat Lens''' view to the Explorer with key figures for the open workspace: lines of code per language, files, folders and size, project age, Git history and dependencies.

Languages are detected with linguist-js, which uses the same rules as GitHub Linguist. The result is saved per workspace and shown right away the next time you open the folder. The view rescans on its own when files change.
</div></div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Latest version}}

{| class="ma-facts"
! Extension
| 4.0.0
|-
! VS Code
| 1.100 or newer
|-
! Requires
| A local, trusted folder. Git in the PATH for the Git figures.
|-
! Download
| [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.stat-lens VS Code Marketplace]
|}
The values in this wiki are taken from version 4.0.0.
{{MA Box end}}
</div>
</div>
{{MA Box start|title=The view}}
[[File:StatLens_Screenshot_01.png|475px|The Stat Lens view in the Explorer]]

The Stat Lens view with the ''Languages'' section expanded. See [[StatLens:Sidebar View|Sidebar View]] for what every row means.
{{MA Box end}}
{{MA Box start|title=Quick start}}

# Install the extension from the VS Code Marketplace. See [[StatLens:Installation|Installation]].
# Open a folder in VS Code.
# Open the Explorer and expand the '''Stat Lens''' view. The first scan starts on its own.
# Click the refresh icon in the title bar of the view to scan again. See [[StatLens:Scanning|Scanning]].
{{MA Box end}}
<div class="ma-columns">
<div class="ma-col">
{{MA Box start|title=Getting started}}
<div class="ma-tiles">
{{MA Tile|image=StatLens_Icon.png|link=StatLens:Installation|label=Installation}}
{{MA Tile|link=StatLens:Sidebar View|label=Sidebar View}}
</div>
{{MA Box end}}
</div>
<div class="ma-col">
{{MA Box start|title=Features}}
<div class="ma-tiles">
{{MA Tile|link=StatLens:Scanning|label=Scanning}}
{{MA Tile|link=StatLens:Dependencies|label=Dependencies}}
</div>
{{MA Box end}}
</div>
</div>
{{MA Box start|title=Reference}}
<div class="ma-tiles">
{{MA Tile|link=StatLens:Commands and Settings|label=Commands and Settings}}
{{MA Tile|link=StatLens:FAQ|label=FAQ}}
{{MA Tile|link=StatLens:Version History|label=Version History}}
</div>
{{MA Box end}}
__NOTOC__
{{StatLens Nav}}

StatLens:Installation

2026-10-20T21:29:38Z

Maintenance script: StatLens wiki

Stat Lens is a regular VS Code extension. It needs no other extensions.

== Requirements ==
{| class="wikitable"
! Stat Lens !! VS Code
|-
| 4.0.0 || 1.100 or newer (<code>^1.100.0</code>)
|}

* '''A folder on the local file system.''' The extension does not run in virtual workspaces, for example a repository opened directly from GitHub in the browser.
* '''A trusted workspace.''' The extension runs <code>git</code> in the workspace and reads all files, so it is disabled in Restricted Mode. Trust the folder with ''Manage Workspace Trust'' to use it.
* '''Git''' (optional). The Git figures need the <code>git</code> program in the PATH. Without it, everything else still works and the view shows <code>git is not installed or not in PATH</code>.

== Installing ==
=== From the Marketplace ===
# Open the Extensions view in VS Code (<code>Ctrl+Shift+X</code>).
# Search for '''Stat Lens''' by MutigerAffe.
# Click ''Install''.

You can also open [https://marketplace.visualstudio.com/items?itemName=MutigerAffe.stat-lens Stat Lens on the VS Code Marketplace] and install it from there.

=== From the command line or Quick Open ===
Press <code>Ctrl+P</code> and enter:
<pre>
ext install MutigerAffe.stat-lens
</pre>

Or install it from a terminal with the VS Code command line tool:
<pre>
code --install-extension MutigerAffe.stat-lens
</pre>

== First start ==
The extension starts shortly after VS Code has finished loading. Open the Explorer. The '''Stat Lens''' view appears as its own section there. The first scan of a folder starts on its own, see [[StatLens:Scanning|Scanning]].

If no folder is open, the view shows <code>No workspace folder open</code>.

== Updating from an earlier version ==
Version 4.0.0 is published under the extension id <code>MutigerAffe.stat-lens</code>. Earlier versions were published under the name Project Stats with a different id. VS Code treats them as separate extensions, so an old version is not replaced. Uninstall it by hand.

== Uninstalling ==
Uninstall the extension in the Extensions view. Stat Lens writes nothing into your project folder. It only keeps the last scan result in the VS Code workspace storage and small color icons for the languages in its own global storage folder.

{{StatLens Nav}}

StatLens:FAQ

2026-10-20T21:29:38Z

Maintenance script: StatLens wiki

;I don't see the Stat Lens view.
:Open the Explorer and look for the ''Stat Lens'' section. If it is missing, right-click the title of the Explorer and check that ''Stat Lens'' is enabled. The extension is also disabled in Restricted Mode and in virtual workspaces. Trust the folder or open it from the local disk. See [[StatLens:Installation|Installation]].

;The view still shows old numbers.
:When you open a folder that was scanned before, Stat Lens shows the saved result and does not scan again on its own. The date in ''Last Scan'' tells you how old it is. Click the refresh icon to scan now. See [[StatLens:Scanning#When it scans|When it scans]].

;Why does a scan start while I am typing?
:Stat Lens scans again 15 seconds after the last file change. Saving a file counts as a change. Changes in excluded folders do not.

;Why are my JSON or Markdown files in the language list?
:Stat Lens counts markup, data and prose formats as well as programming languages, like GitHub Linguist does. To leave out a whole folder, add its name to <code>projectStats.excludeFolders</code>.

;Why do the lines of code differ from GitHub?
:Both use the Linguist rules, but GitHub shows the share by file size in bytes. Stat Lens shows the share by lines of code. Stat Lens also only uses the <code>.gitignore</code> in the root folder for its file list.

;A file is counted in Files and Size, but not in the lines of code.
:Lines are only counted for files with a language. Binary files, vendored files, files larger than 20 MB and files that Linguist leaves out are not counted. See [[StatLens:Scanning#Which files count|Which files count]].

;''Largest File'' is not the biggest file on disk.
:''Largest File'' is the file with the most lines of code, not the one with the most bytes.

;With <code>ignoreComments</code> some code lines are missing.
:The comment check only looks at how a line starts. Lines such as <code>#include</code>, Markdown headings or lines starting with <code>'</code> are left out as well. See [[StatLens:Scanning#Ignoring comment lines|Ignoring comment lines]].

;The Git row says <code>git is not installed or not in PATH</code>.
:Install Git and make sure the <code>git</code> command works in a terminal. Restart VS Code and click the refresh icon.

;The commit count is lower than expected.
:Only commits on the branch you have checked out are counted, not those on other branches.

;Two contributors are counted for the same person.
:Contributors are counted by author e-mail address. If one person committed with two addresses, they count twice.

;I have a multi-root workspace. Why is only one folder shown?
:Stat Lens only scans the first folder of the workspace.

;Does Stat Lens send data anywhere?
:No. Language detection works offline with the data that ships with the extension. Git is only run locally.

{{StatLens Nav}}

StatLens:Dependencies

2026-10-20T21:29:38Z

Maintenance script: StatLens wiki

The ''Dependencies'' row counts the entries in the manifest files of the project. Its value is the total over all manifest files. Expand it to see one row per file, with its path and its count. Click a file to open it.

If no manifest file is found, the row says <code>no manifest file found</code>.

== Supported files ==
Stat Lens looks at every scanned file with one of these names. Upper and lower case in the file name do not matter. Files in excluded folders, for example in <code>node_modules</code>, are not read. See [[StatLens:Scanning|Scanning]].

{| class="wikitable"
! File !! What is counted
|-
| <code>package.json</code> || The keys in <code>dependencies</code> and <code>devDependencies</code>. Other sections such as <code>peerDependencies</code> or <code>optionalDependencies</code> are not counted.
|-
| <code>requirements.txt</code> || Every line that is not empty and does not start with <code>#</code> or <code>-</code>. Lines with options such as <code>-r other.txt</code> or <code>-e .</code> are therefore not counted.
|-
| <code>pyproject.toml</code> || See [[#pyproject.toml|pyproject.toml]] below.
|-
| <code>*.csproj</code> || Every <code><PackageReference></code> element.
|}

A project with several manifest files, for example a monorepo with one <code>package.json</code> per package, gets one row per file. The rows are sorted by path.

== pyproject.toml ==
The file is read line by line without a full TOML parser. These entries are counted:
* PEP 621: the strings in <code>dependencies = [...]</code> in the <code>[project]</code> table, and in every group in <code>[project.optional-dependencies]</code>. Arrays on one line and arrays over several lines both work.
* Poetry: every key in <code>[tool.poetry.dependencies]</code>, <code>[tool.poetry.dev-dependencies]</code> and <code>[tool.poetry.group.<name>.dependencies]</code>. The <code>python</code> entry is not counted.

== When a file is skipped ==
A manifest file that cannot be read is left out of the list without a warning. This also happens when a <code>package.json</code> is not valid JSON.

{{StatLens Nav}}