mirror of
https://github.com/robonen/questlang.git
synced 2026-03-20 02:44:47 +00:00
feat: add QuestLang VS Code extension with syntax highlighting and installation instructions
This commit is contained in:
83
vscode-extension/README.md
Normal file
83
vscode-extension/README.md
Normal file
@@ -0,0 +1,83 @@
|
||||
# QuestLang Syntax Highlighting
|
||||
|
||||
Расширение VS Code для подсветки синтаксиса языка QuestLang - специализированного языка для создания интерактивных текстовых квестов.
|
||||
|
||||
## Возможности
|
||||
|
||||
- ✨ **Подсветка синтаксиса** для файлов `.ql`
|
||||
- 🔤 **Поддержка русских ключевых слов**
|
||||
- 💬 **Подсветка комментариев** (`//`)
|
||||
- 🎨 **Цветовое выделение строк и чисел**
|
||||
- 🔧 **Автоматическое закрытие скобок**
|
||||
- 📐 **Автоматические отступы**
|
||||
|
||||
## Поддерживаемые элементы языка
|
||||
|
||||
### Ключевые слова
|
||||
- `квест`, `цель`, `граф`, `узлы`, `начало`, `конец`
|
||||
- `тип`, `описание`, `переходы`, `варианты`, `название`
|
||||
- `начальный`, `действие`, `концовка`
|
||||
|
||||
### Синтаксические элементы
|
||||
- Строки в двойных кавычках: `"Текст"`
|
||||
- Числа: `123`, `45.67`
|
||||
- Комментарии: `// это комментарий`
|
||||
- Скобки: `{}`, `[]`, `()`
|
||||
- Разделители: `;`, `:`, `,`
|
||||
|
||||
## Пример кода
|
||||
|
||||
```questlang
|
||||
квест МойКвест;
|
||||
цель "Описание цели квеста";
|
||||
|
||||
граф {
|
||||
узлы {
|
||||
старт: {
|
||||
тип: начальный;
|
||||
описание: "Начало приключения";
|
||||
переходы: [выбор];
|
||||
}
|
||||
|
||||
выбор: {
|
||||
тип: действие;
|
||||
описание: "Что вы будете делать?";
|
||||
варианты: [
|
||||
("Идти направо", правый_путь),
|
||||
("Идти налево", левый_путь)
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
начало: старт;
|
||||
}
|
||||
|
||||
конец;
|
||||
```
|
||||
|
||||
## Установка
|
||||
|
||||
1. Откройте VS Code
|
||||
2. Перейдите в Extensions (Ctrl+Shift+X)
|
||||
3. Найдите "QuestLang Syntax Highlighting"
|
||||
4. Нажмите Install
|
||||
|
||||
## Использование
|
||||
|
||||
После установки расширения все файлы с расширением `.ql` будут автоматически распознаваться как файлы QuestLang с подсветкой синтаксиса.
|
||||
|
||||
## Разработка
|
||||
|
||||
Для разработки расширения:
|
||||
|
||||
```bash
|
||||
git clone <repo-url>
|
||||
cd vscode-extension
|
||||
npm install
|
||||
```
|
||||
|
||||
Затем нажмите F5 в VS Code для запуска Extension Development Host.
|
||||
|
||||
## Лицензия
|
||||
|
||||
MIT
|
||||
Reference in New Issue
Block a user