Testing the Extension

Requirements

To use PixelPilot, ensure you have the following :

• Visual Studio Code installed on your system.
• GitHub CoPilot VS Code Extension installed.
• A GitHub account to access AI-powered features.
• Python 3.11 installed on your system.
• Node.js installed on your system.

Getting Started

1. Clone the repository.
2. Open the repository in VS Code.
3. Use the terminal and install the required dependencies by running: npm install
4. Start the extension by opening src/extension.ts, then going to the 'Run and Debug' tab using the left panel and then clicking Run Extension.
5. Open the chat window in the side panel and interact with PixelPilot using the commands listed below.

Commands

PixelPilot supports the following commands :

@pixel /image

• Description: Generate an image using the PixelPilot extension.
• Usage: Type @pixel /image followed by a description of the image you want to generate.

@pixel changeChatCompletionModel

• Description: Change the chat completion model used by PixelPilot.
• Usage: Type @pixel changeChatCompletionModel and select a model from the list.

@pixel changeCodeGenerationModel

• Description: Change the code generation model used by PixelPilot.
• Usage: Type @pixel changeCodeGenerationModel and select a model from the list.

@pixel mastery

• Description: Set your mastery level to tailor PixelPilot's responses to your skill level.
• Usage: Type @pixel mastery and select a level (NOVICE, INTERMEDIATE, or PRO).

Walkthrough

• Description: Start the interactive walkthrough to create a new game project.
• Usage: Run the command PixelPilot: Start from the Command Palette (Ctrl+Shift+P/Cmd+Shift+P).

Offline Models

PixelPilot supports offline models for image generation and other tasks. Hence before running the extension, follow these instructions :

1. Enter this in the terminal while in the directory of the repository :

   git submodule init

   git submodule update --recursive

2. Navigate to the backend directory :

   cd Backend

3. Create a Python virtual environment (Python 3.11):
   • Windows : py -3.11 -m venv venv
   • Mac/Linux : python3.11 -m venv venv
4. Activate the virtual environment:
   • Windows :
     • PowerShell : venv\Scripts\Activate.ps1
     • Command Prompt : venv\Scripts\activate
   • Mac/Linux : source venv/bin/activate
5. Install dependencies :

   pip install -r requirements.txt

6. Run the python script :

   python runner.py

7. Once done using the extension, interrupt the python script that is running. Then deactivate the virtual environment :

   deactivate

8. To use the extension again reperform steps 4 and 6

Additional Notes

• To break down a game idea into multiple prompts, simply write the game idea in the chat window.
• To generate code based on these prompts, prefix the prompt with G: and input one prompt at a time.

Troubleshooting

If you encounter any issues:

1. Ensure all dependencies are installed.
2. Verify that the GitHub CoPilot extension is active and linked to your GitHub account.
3. Check the output logs in the Output panel for error messages.

Check the output logs in the Output panel for error messages.

Deploying the extension on Visual Studio Marketplace

1. Ensure you have node.js installed
2. Run: npm install -g @vscode/vsce
• (this is the VSCE tool, which is used to publish extensions)
3. Ensure you have an organisation. If not, follow these steps:
• Sign into azure DevOps
• Select New organization
• Enter a name for your organisation, select the hosting geography and then select continue
4. Sign in to your organization by typing “https://dev.azure.com/{yourorganization}”.
5. Open the User settings dropdown menu
6. Select Personal access tokens
7. On the Personal Access Tokens page, select New Token. The website will display this form:
   
8. Select the following details for the token:
• Name: any name you want for the token
• Organization: All accessible organizations
• Expiration (optional): set the desired expiration date for the token
• Scopes - Custom defined: All accessible organizations
• click Show all scopes link below the Scopes section
• in the Scopes list, scroll to Marketplace and select Manage scope
9. Click “Create”
10. Go to the Visual Studio Marketplace publisher management page.
11. Log in with the same Microsoft account you used to create the Personal Access Token
12. Click “Create publisher” in the panel on the left
13. In the new page, specify the mandatory parameters for a new publisher - identifier and name (ID and Name fields respectively):
• ID: the unique identifier for your publisher in the VSCode Marketplace. This will be used in your extension URLs, and the ID cannot be changed once created.
• Name: the unique name of your publisher that will be displayed in the VSCode Marketplace with your extensions. This can be your company or brand name.
14. You can optionally fill out the rest of the fields.
15. Click Create
16. Change your directory to the directory of the extension.
17. Run the following command in your terminal: You will then be asked to type in the Personal Access Token created in the previous step :
    
18. To publish the extension automatically, use the following command:

    vsce publish