Getting Started

This section provides a step-by-step guide to help you get started with the Raylib VScode Extension. Follow these instructions to set up your development environment and begin creating games using Raylib.

Installation

To Install the Raylib VScode Extension you can follow these steps:

  1. Open Visual Studio Code.
  2. Go to the Extensions view by clicking on the Extensions icon in the Activity Bar on the side of the window or by pressing Ctrl+Shift+X.
  3. In the search bar, type "Raylib" and press Enter.
  4. Locate the "Raylib VScode Extension" in the search results and click on the "Install" button.

Manual Installation

If you prefer to install the extension manually, you can download the extension package from the Raylib VScode Extension Codeberg Repository and follow these steps:

  1. Download the latest release of the extension from the repository.
  2. Open Visual Studio Code.
  3. Go to the Extensions view by clicking on the Extensions icon in the Activity Bar or by pressing Ctrl+Shift+X.
  4. Click on the three-dot menu in the top-right corner of the Extensions view and select "Install from VSIX...".
  5. Navigate to the location of the downloaded .vsix file and select it to install the extension.

NOTE: Make sure to have the latest version of Visual Studio Code installed to ensure compatibility with the extension.

NOTE2: If you preffer to use the Commands Palette, you can open it by pressing Ctrl+Shift+P and then typing "install" to see the install from VSIX option. Select it and navigate to the location of the downloaded .vsix file to install the extension.

Initial Configuration

Raylib VScode Extension requires some initial configuration to work properly. You need the next prerequisites installed in your system:

  1. Raylib Project Creator (RPC): This tool helps you create new Raylib projects quickly. You can download it from the Raylib Project Creator From Itch io.
  2. Raylib Library: Make sure you have the Raylib library installed on your system. You can find installation instructions on the Raylib Official Website. If you are using windows, you can also use the Raylib Windows Installer. This installer will set up the Raylib library and its dependencies for you, making it easier to get started with Raylib development on Windows.
  3. C/C++ Compiler: Ensure you have a compatible C/C++ compiler installed on your system. For Windows, you can use MinGW or Visual Studio (If you have install Raylib from installer its already included). For macOS, you can use Xcode Command Line Tools. For Linux, you can use GCC or Clang.

RPC Path Configuration

The first step is to configure the path to the Raylib Project Creator (RPC) in the extension settings. Follow these steps:

  1. Open Visual Studio Code.
  2. Got to Settings by clicking on the gear icon in the lower-left corner and selecting "Settings" or by pressing Ctrl+,.
  3. In the search bar, type "Raylib" to filter the settings related to the extension.
  4. Locate the "Raylib: Rpc Path" setting and add the path to the Raylib Project Creator executable. For example, if you installed RPC in C:\RaylibProjectCreator, you would enter that path in the setting.

MinGW Path Configuration (Windows Only)

If you are using Windows and have installed the Raylib library using the Raylib Windows Installer, you may need to configure the path to the MinGW compiler in the extension settings. Follow these steps:

  1. Open Visual Studio Code.
  2. Go to Settings by clicking on the gear icon in the lower-left corner and selecting "Settings" or by pressing Ctrl+,.
  3. In the search bar, type "Raylib" to filter the settings related to the extension.
  4. Locate the "Raylib: Mingw Path" setting and add the path to the MinGW compiler executable. For example, if you installed MinGW in C:\raylib\MinGW\bin\, you would enter that path in the setting.