Getting Started

RainSyntax is a powerful VS Code extension designed to enhance your Rainmeter development experience.

Quick Start

Install RainSyntax from the VS Code Marketplace
Open a Rainmeter .ini file in VS Code
Start coding with enhanced features

Installation

Follow these steps to install RainSyntax in VS Code:

Open VS Code.
Go to the Extensions Marketplace (Ctrl+Shift+X).
Search for "RainSyntax" and click Install.
Reload VS Code if required.
Start using the extension on Rainmeter files.

Features

Syntax Highlighting: Advanced highlighting for Rainmeter syntax.
Auto-Refresh Skin: Automatically refreshes Rainmeter skins while coding.
GUI Customization: Allows users to modify UI settings.
Hover Information: Displays helpful tooltips on Rainmeter elements.
Color Picker: Integrated color picker for easy color selection.
Code Formatting: Ensures clean and consistent code styling.

Configuration

Customize RainSyntax settings in VS Code by modifying the settings.json file:

{
  "rainsyntax.autoRefresh": true,
  "rainsyntax.colorPicker": true,
  "rainsyntax.formatOnSave": true
}

These options allow you to enable or disable features according to your workflow.

API Reference

RainSyntax provides an API for advanced integration. Below are some key commands:

rainSyntax.toggleAutoRefresh - Toggles AutoRefresh for Rainmeter skins.
rainSyntax.changeRainmeterPath - Changes the Rainmeter executable path.
rainSyntax.changeRefreshMode - Switches between refreshing all skins or only the active skin.
rainSyntax.openSettings - Opens RainSyntax settings in VS Code.

Configuration Settings

Customize RainSyntax behavior using these settings in settings.json:

rainSyntax.autoRefreshOnSave (boolean, default: true) - Automatically refresh Rainmeter skins when saving an INI or INC file.
rainSyntax.refreshMode (string, default: "all") - Choose between refreshing all skins or only the specific skin being edited.
rainSyntax.rainmeterPath (string, default: "C:\Program Files\Rainmeter\Rainmeter.exe") - Path to the Rainmeter executable.

Examples

Here are some usage examples of RainSyntax:

Example 1: Basic Skin

[Rainmeter]
Update=1000

[MeterText]
Meter=String
Text=Hello, World!

Example 2: Using Variables

[Rainmeter]
Update=1000

[Variables]
Color=255,255,255

[MeterText]
Meter=String
FontColor=#Color#

RainSyntax

Powerful Features for Rainmeter Development

Syntax Highlighting

Auto-Refresh Skin

GUI Customization

Hover Information

Color Picker

Code Formatting

Quick Installation Guide

Open VS Code

Install Extension

Start Coding

See It in Action

Join the Community

GitHub

Discord

Documentation