From a444d44bd3e295fe21e178812084cae300d056b5 Mon Sep 17 00:00:00 2001 From: robonen Date: Mon, 1 Sep 2025 03:16:48 +0700 Subject: [PATCH] fix: update README.md to English and improve clarity --- vscode-extension/INSTALL.md | 108 ------------------------------------ vscode-extension/README.md | 74 +++++++++++------------- 2 files changed, 31 insertions(+), 151 deletions(-) delete mode 100644 vscode-extension/INSTALL.md diff --git a/vscode-extension/INSTALL.md b/vscode-extension/INSTALL.md deleted file mode 100644 index 55d7c61..0000000 --- a/vscode-extension/INSTALL.md +++ /dev/null @@ -1,108 +0,0 @@ -# Инструкция по установке и использованию расширения QuestLang - -## Способы установки - -### 1. Установка из исходного кода (для разработки) - -1. Убедитесь, что у вас установлен VS Code и Node.js -2. Установите глобально инструмент для работы с расширениями VS Code: - ```bash - npm install -g @vscode/vsce - ``` -3. Перейдите в директорию расширения: - ```bash - cd /Users/robonen/Projects/questlang/vscode-extension - ``` -4. Упакуйте расширение в файл .vsix: - ```bash - vsce package - ``` -5. Установите расширение в VS Code: - ```bash - code --install-extension questlang-syntax-1.0.0.vsix - ``` - -### 2. Установка для разработки (без упаковки) - -1. Откройте папку расширения в VS Code: - ```bash - code /Users/robonen/Projects/questlang/vscode-extension - ``` -2. Нажмите F5 для запуска Extension Development Host -3. В новом окне VS Code откройте любой файл с расширением .ql - -## Тестирование подсветки синтаксиса - -1. Создайте файл с расширением `.ql` -2. Скопируйте содержимое из `example.ql` или используйте пример из README -3. Проверьте, что синтаксис подсвечивается правильно: - - Ключевые слова должны быть выделены цветом - - Строки в кавычках должны быть одного цвета - - Комментарии должны быть серыми/зелеными - - Имена узлов (перед двоеточием) должны выделяться - -## Элементы подсветки - -- **Ключевые слова структуры**: `квест`, `граф`, `узлы`, `начало`, `конец` -- **Ключевые слова свойств**: `тип`, `описание`, `переходы`, `варианты`, `название` -- **Типы узлов**: `начальный`, `действие`, `концовка` -- **Строки**: текст в двойных кавычках -- **Числа**: целые и десятичные числа -- **Комментарии**: строки, начинающиеся с `//` -- **Имена узлов**: идентификаторы перед двоеточием -- **Имя квеста**: название после ключевого слова `квест` - -## Функции редактора - -- Автоматическое закрытие скобок: `{}`, `[]`, `()` -- Автоматическое закрытие кавычек: `""` -- Автоматические отступы в блоках -- Сворачивание блоков кода -- Поддержка комментариев (Ctrl+/) - -## Настройка цветовой схемы - -Вы можете настроить цвета подсветки в своей теме VS Code, используя следующие селекторы: - -```json -{ - "editor.tokenColorCustomizations": { - "textMateRules": [ - { - "scope": "keyword.control.quest.questlang", - "settings": { - "foreground": "#569cd6", - "fontStyle": "bold" - } - }, - { - "scope": "entity.name.type.quest.questlang", - "settings": { - "foreground": "#4ec9b0" - } - }, - { - "scope": "entity.name.function.node.questlang", - "settings": { - "foreground": "#dcdcaa" - } - } - ] - } -} -``` - -## Устранение неполадок - -### Расширение не активируется -- Проверьте, что файл имеет расширение `.ql` -- Перезапустите VS Code -- Проверьте, что расширение установлено в списке Extensions - -### Подсветка работает неправильно -- Убедитесь, что синтаксис файла корректный -- Попробуйте команду "Reload Window" в VS Code -- Проверьте консоль разработчика (Help > Toggle Developer Tools) - -### Автодополнение не работает -Данная версия расширения предоставляет только подсветку синтаксиса. Автодополнение можно добавить в будущих версиях, создав Language Server Protocol (LSP) сервер. diff --git a/vscode-extension/README.md b/vscode-extension/README.md index 079b2ed..d5ed2a2 100644 --- a/vscode-extension/README.md +++ b/vscode-extension/README.md @@ -1,50 +1,50 @@ # QuestLang Syntax Highlighting -Расширение VS Code для подсветки синтаксиса языка QuestLang - специализированного языка для создания интерактивных текстовых квестов. +VS Code extension for syntax highlighting of QuestLang - a specialized language for creating interactive text quests. -## Возможности +## Features -- ✨ **Подсветка синтаксиса** для файлов `.ql` -- 🔤 **Поддержка русских ключевых слов** -- 💬 **Подсветка комментариев** (`//`) -- 🎨 **Цветовое выделение строк и чисел** -- 🔧 **Автоматическое закрытие скобок** -- 📐 **Автоматические отступы** +- ✨ **Syntax highlighting** for `.ql` files +- 🔤 **Support for Russian keywords** +- 💬 **Comment highlighting** (`//`) +- 🎨 **Color highlighting for strings and numbers** +- 🔧 **Automatic bracket closing** +- 📐 **Automatic indentation** -## Поддерживаемые элементы языка +## Supported Language Elements -### Ключевые слова +### Keywords - `квест`, `цель`, `граф`, `узлы`, `начало`, `конец` - `тип`, `описание`, `переходы`, `варианты`, `название` - `начальный`, `действие`, `концовка` -### Синтаксические элементы -- Строки в двойных кавычках: `"Текст"` -- Числа: `123`, `45.67` -- Комментарии: `// это комментарий` -- Скобки: `{}`, `[]`, `()` -- Разделители: `;`, `:`, `,` +### Syntax Elements +- Strings in double quotes: `"Text"` +- Numbers: `123`, `45.67` +- Comments: `// this is a comment` +- Brackets: `{}`, `[]`, `()` +- Delimiters: `;`, `:`, `,` -## Пример кода +## Code Example ```questlang -квест МойКвест; - цель "Описание цели квеста"; +квест MyQuest; + цель "Quest objective description"; граф { узлы { старт: { тип: начальный; - описание: "Начало приключения"; + описание: "Beginning of the adventure"; переходы: [выбор]; } выбор: { тип: действие; - описание: "Что вы будете делать?"; + описание: "What will you do?"; варианты: [ - ("Идти направо", правый_путь), - ("Идти налево", левый_путь) + ("Go right", правый_путь), + ("Go left", левый_путь) ]; } } @@ -55,29 +55,17 @@ конец; ``` -## Установка +## Installation -1. Откройте VS Code -2. Перейдите в Extensions (Ctrl+Shift+X) -3. Найдите "QuestLang Syntax Highlighting" -4. Нажмите Install +1. Open VS Code +2. Go to Extensions (Ctrl+Shift+X) +3. Search for "QuestLang Syntax Highlighting" +4. Click Install -## Использование +## Usage -После установки расширения все файлы с расширением `.ql` будут автоматически распознаваться как файлы QuestLang с подсветкой синтаксиса. +After installing the extension, all files with `.ql` extension will be automatically recognized as QuestLang files with syntax highlighting. -## Разработка - -Для разработки расширения: - -```bash -git clone -cd vscode-extension -npm install -``` - -Затем нажмите F5 в VS Code для запуска Extension Development Host. - -## Лицензия +## License MIT