PteroControl - Pterodactyl Server Management for VS Code

A comprehensive Visual Studio Code extension that allows you to manage your Pterodactyl game servers directly from the editor. With real-time WebSocket integration, rich webview interfaces, and secure credential management, PteroControl brings the power of Pterodactyl to your development workflow.

✨ Features

🎮 Server Management

• Real-time Dashboard: Monitor server status, resource usage, and performance metrics
• Power Controls: Start, stop, restart, and kill servers with one click
• Resource Monitoring: Track CPU, memory, and disk usage in real-time
• Multi-server Support: Manage multiple Pterodactyl servers from a single interface

📁 File Management

• Advanced File Editor: Syntax-highlighted editing for 50+ file types
• Directory Navigation: Browse server files with an intuitive interface
• File Operations: Upload, download, rename, delete, and compress files
• Context Menu: Right-click actions for quick file operations
• Search & Filter: Quickly find files and directories

💻 Console & Terminal

• Live Console: Real-time server console output with WebSocket integration
• Command Execution: Send commands directly to your servers
• Console History: Maintain command history and export logs
• Auto-scroll: Intelligent scrolling behavior for console output
• Log Levels: Color-coded output for different log levels

👥 User Administration

• User Management: Create, edit, and delete Pterodactyl users
• Permission Control: Manage administrator privileges
• User Statistics: View user activity and statistics
• Bulk Operations: Efficiently manage multiple users

🔔 Notifications & Alerts

• Push Notifications: Desktop alerts for server events
• Status Changes: Get notified when servers start, stop, or encounter errors
• Resource Warnings: Alerts for high resource usage
• Custom Actions: Quick actions directly from notifications

🔐 Security & Integration

• Secure Credential Storage: Uses VS Code's secure storage for API keys
• Encrypted Communication: HTTPS/WSS protocols for all communications
• Token Management: Automatic token refresh and management
• Multi-factor Support: Full support for 2FA-enabled accounts

🚀 Installation

From VS Code Marketplace

1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "PteroControl"
4. Click Install

From VSIX File

1. Download the latest .vsix file from Releases
2. In VS Code, go to Extensions → Install from VSIX...
3. Select the downloaded file

⚙️ Configuration

Initial Setup

1. Install the Extension: Follow the installation steps above

2. Configure Credentials:

   • Open Command Palette (Ctrl+Shift+P)
   • Type "PteroControl: Configure Credentials"
   • Enter your Pterodactyl panel URL and API key
   • The extension will validate your credentials

3. Access the Interface:

   • Use the Command Palette to open various panels
   • Or use the Activity Bar icon (🦅) for quick access

Settings

You can configure PteroControl through VS Code settings:

{
  "pterocontrol.panelUrl": "https://panel.example.com",
  "pterocontrol.refreshInterval": 30000,
  "pterocontrol.enableNotifications": true,
  "pterocontrol.theme": "auto",
  "pterocontrol.autoStartDashboard": false,
  "pterocontrol.showServerStatusInStatusBar": true,
  "pterocontrol.enableWebSocketReconnect": true,
  "pterocontrol.maxConsoleHistory": 1000,
  "pterocontrol.enableDebugLogging": false
}

Setting Descriptions

📖 Usage Guide

Server Dashboard

1. Open Dashboard: Command Palette → "PteroControl: Open Dashboard"
2. Select Server: Use the dropdown to choose a server
3. Monitor Resources: View real-time CPU, memory, and disk usage
4. Control Server: Use the power buttons to start/stop/restart
5. Send Commands: Enter commands in the console input field

File Management

1. Open File Manager: Command Palette → "PteroControl: Open File Manager"
2. Navigate: Click on folders to browse directories
3. Edit Files: Double-click files to open them in the editor
4. Upload Files: Use the "Upload File" button to create new files
5. File Operations: Right-click on files for context menu options

Console Access

1. Open Console: Command Palette → "PteroControl: Open Server Console"
2. Select Server: Choose a server from the dropdown
3. View Output: Real-time console output appears automatically
4. Send Commands: Type commands and press Enter to execute
5. Power Actions: Use the power buttons for server control

User Administration

1. Open User Admin: Command Palette → "PteroControl: Open User Administration"
2. View Users: See all users with their roles and status
3. Create User: Click "Create User" to add a new user
4. Edit User: Click "Edit" on any user to modify their details
5. Delete User: Click "Delete" to remove a user (with confirmation)

🔧 Commands

PteroControl provides the following commands:

🎯 Keyboard Shortcuts

Global Shortcuts

• Ctrl+Shift+P → Type "PteroControl" to access all commands

In-Console Shortcuts

• Enter - Send command
• Ctrl+L - Clear console
• Ctrl+E - Export logs
• Escape - Close modal dialogs

In-File Editor Shortcuts

• Ctrl+S - Save file
• Ctrl+N - Create new folder
• Ctrl+O - Open file
• Delete - Delete selected file

🔌 API Integration

Pterodactyl API Compatibility

PteroControl integrates with the Pterodactyl Panel API:

• Client API: For server management and file operations
• Application API: For user administration (admin access required)
• WebSocket API: For real-time console and resource monitoring

Required Permissions

Your API key needs the following permissions:

For Basic Usage:

• read-servers - View server information
• control-servers - Start/stop/restart servers
• read-console - View console output
• send-command - Send console commands
• read-files - Browse server files
• write-files - Edit and upload files
• delete-files - Delete files and folders

For User Administration (Admin):

• admin-users - Create, edit, and delete users

API Rate Limits

PteroControl respects Pterodactyl's rate limits:

• Client API: 60 requests per minute
• Application API: 120 requests per minute

🐛 Troubleshooting

Common Issues

"Connection Failed" Error

• Verify your panel URL is correct and accessible
• Check that your API key is valid and has required permissions
• Ensure your firewall allows VS Code to access the panel

"WebSocket Connection Failed"

• Check that WebSocket is enabled on your Pterodactyl panel
• Verify your panel URL uses HTTPS/WSS
• Check for proxy or firewall blocking WebSocket connections

"Permission Denied" Error

• Ensure your API key has the required permissions
• Check that you have access to the specific server
• For user admin, ensure you have admin privileges

File Editor Issues

• Large files (>10MB) may not load in the editor
• Binary files cannot be edited in the text editor
• Some file types may not have syntax highlighting

Debug Mode

Enable debug logging to troubleshoot issues:

1. Open VS Code settings
2. Search for "pterocontrol.enableDebugLogging"
3. Set it to true
4. Check the "PteroControl" output channel for logs

Getting Help

If you encounter issues:

1. Check the Logs: View the PteroControl output channel
2. Verify Credentials: Ensure your API key and panel URL are correct
3. Check Permissions: Verify your API key has required permissions
4. Network Issues: Check your internet connection and firewall settings
5. Report Issues: Create an issue on GitHub

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Setup

1. Clone the repository
2. Install dependencies: npm install
3. Compile TypeScript: npm run compile
4. Run tests: npm test
5. Start development: npm run watch

Project Structure

pterocontrol-extension/
├── src/
│   ├── client/           # API and WebSocket clients
│   ├── webviews/         # WebView panel providers
│   ├── utils/            # Utility functions
│   ├── types/            # TypeScript type definitions
│   └── extension.ts      # Main extension entry point
├── media/                # Icons and images
├── resources/            # Additional resources
└── package.json          # Extension manifest

📄 License

This extension is licensed under the MIT License. See LICENSE for details.

🙏 Acknowledgments

• Pterodactyl Panel - The amazing game server management panel
• VS Code API - For providing the extension framework
• CodeMirror - For the syntax-highlighted file editor
• The open-source community for inspiration and feedback

📞 Support

• 📧 Email: support@pterocontrol.com
• 💬 Discord: Join our Discord
• 🐛 Issues: GitHub Issues
• 📖 Documentation: Wiki

Made with ❤️ for the Pterodactyl community