Version 2.1.x • Stable

Hello,
Welcome to VSDactyl.

VSDactyl helps you manage remote game server files and console operations directly in VS Code with a faster workflow and SansCraft-first UX.

Quick installation

1

Open the Extensions Marketplace

Use Ctrl + Shift + X on Windows/Linux or Cmd + Shift + X on macOS.

Search for VSDactyl, click Install, then open the VSDactyl view from the Activity Bar.

First connection

Create an API key

  1. Open your panel dashboard.
  2. Go to Account.
  3. Open API Credentials.
  4. Create a new key and copy it.

Add it in VS Code

  • Display Name: Friendly label for your account.
  • Panel URL: Your panel address.
  • API Key: Paste the key you created.

SSH Auto-Setup

Tip: SSH key authentication is more secure and more reliable than password login.

One-click setup

In the add-account form, choose SSH Key and enable Auto-configure SSH Key.

VSDactyl will:

  • Generate a secure key pair locally.
  • Upload the public key to your panel account.
  • Store the private key path for immediate use.

Manage files like local files

Connect and edit

Right-click a server and choose Connect (SFTP). You can then edit files, save directly to the server, drag and drop uploads, and manage folders from Explorer.

Live Production Auto-Sync

Deployment Syncing

Instead of manually uploading files, you can bind a local folder directly to a remote server. Right-click any Pterodactyl server and choose VSDactyl: Map Local Folder (Auto-Sync). Select your local workspace folder, and then specify the target remote path on the server (e.g. /plugins or /config).

VSDactyl will drop a .vsdactyl-sync.json configuration file there and immediately start watching the folder. Any changes you make (saves, deletes, new plugins) will instantly be tunneled to the server in the background!

Best Practices & Pitfalls

  • Target specific directories: Map local build folders directly to subdirectories like /plugins instead of the server root / to avoid unintended overrides.
  • Edit Configs Live: You can edit the generated .vsdactyl-sync.json at any time to update the target remotePath or modify the ignorePatterns (by default, node_modules and .git are ignored).
  • Auto-Sync vs. Connect: Auto-Sync acts as a one-way pipeline to upload your local compilations to the server automatically. If you want to live-edit server files or browse the remote filesystem dynamically, use the Connect (SFTP) button instead!

Archive-Assisted Bulk Transfers

Lightning Fast Uploads

Drag and drop a massive folder directly onto a server node. VSDactyl automatically intercepts the drop, compresses the files into a single archive, uploads the bundle over SFTP, and instantly extracts it on the remote server.

Tip: Monitor live upload speeds, set active throttles, and view remaining ETAs using the Transfer Manager Dashboard via the Sync icon at the top of the Server View!

Console & Web View

Live Terminal & Telemetry

Monitor your server's live CPU, RAM, and Disk metrics directly in the tree view. Right-click any server to Open Terminal for real-time console streaming within VS Code.

Embedded Web Panel

Choose Open Panel in Web View to seamlessly load the full Pterodactyl interface in a dedicated VS Code tab, enabling full server management without launching an external browser!

Troubleshooting

Authentication or key issues

Regenerate your SSH key via auto-setup and verify your account details in VSDactyl settings.

Need help?

Open an issue in the project repository for direct support.

Visit GitHub