Skip to main content

installation

Prerequisites​

  • Visual Studio Code version 1.60.0 or higher
  • Server components installed (see Server Setup below)

Installing the Extension​

Direct Method​

To install RigVe via the VS Code Marketplace, navigate to the VS Code Marketplace and search for RigVe in the extensions panel. Click Install to add the extension to your development environment.

Manual Installation (via VSIX)​

If you have obtained RigVe through an external source such as Gumroad, follow the steps below to install the extension manually:

  1. Upon successful purchase, download the provided ZIP file.
  2. Extract the ZIP file to access the folder containing the **/PLUGINS/VS Code/rigve-<Version>.vsix file.
  3. Open Visual Studio Code.
  4. Access the Command Palette by pressing Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (Mac).
  5. Type "Install from VSIX" and select the corresponding command.
  6. Navigate to the extracted .vsix file and select it for installation.
  7. Restart Visual Studio Code if necessary to complete the installation.
  8. For additional guidance, refer to the official VS Code documentation.

Server Setup Guide​

  1. Download the ZIP File
    • Upon successful purchase, download the provided ZIP file to your system.
  2. Extract the Files
    • Locate the downloaded ZIP file and extract its contents to a preferred directory on your computer.
  3. Open Visual Studio Code
    • Launch Visual Studio Code to proceed with the setup.
  4. Access Settings
    • Open the Settings panel in VS Code.
    • In the search bar, type "RigVe" to locate the relevant settings.
  5. Configure the Server Location
    • Find the setting labeled "RigVe: Server Location."
    • Click on it and set the extracted folder path as the server location.

Your RigVe server is now configured and ready to use. 🚀

Verifying Installation​

  1. Open Visual Studio Code
  2. Look for the RigVe icon in the activity bar
  3. Click the icon to verify the extension is properly loaded
  4. Check the status bar for server connection status

Troubleshooting​

If you encounter connection issues, please follow these steps:

  1. Verify Server Paths – Ensure that all server paths are correctly configured.
  2. Check Server Status – Confirm that the server service is running without errors.
  3. Firewall Settings – Make sure your firewall allows connections to localhost.
  4. Mac Security Notice – If you're using macOS, you may see a warning about an "untrusted application." This occurs because the executable is not yet notarized by Apple, as an official developer account is required. While I plan to obtain one in the future, you can still use the tool by following Apple's official steps to open untrusted apps: Apple Support Guide.

I appreciate your understanding and support as I work towards full Apple certification.