Skip to content

Commit

Permalink
docs: update to release
Browse files Browse the repository at this point in the history
  • Loading branch information
@AleksVersus
AleksVersus committed Feb 12, 2024
1 parent 8de2c3c commit 49c2190
Show file tree
Hide file tree
Showing 6 changed files with 102 additions and 46 deletions.
35 changes: 31 additions & 4 deletions README.md
View file
Expand Up @@ -96,12 +96,39 @@
Непосредственно сами файлы QSP ("`.qsp`") имеют кодировку **utf-16le**, тогда как билдер работает исключительно с файлами в кодировке **utf-8** (без BOM-символов). Чтобы билдер собирал игру правильно, исключительно важно, чтобы все qsps-файлы вашего проекта имели кодировку **utf-8**. Будьте аккуратны при использовании спецсимволов, проверяйте соответствие в исходном и конечном файле.
## Установка пакета QSP для Sublime Text

Данная инструкция ориентирована на пользователей, которые скачают последний релиз со страницы релизов: [JAD_for_QSP/releases](https://github.com/AleksVersus/JAD_for_QSP/releases). Установка из исходников будет немного отличаться.
0. Прежде всего у вас должен быть установлен Sublime Text, желательно Sublime Text 4. Скачать его можно отсюда https://www.sublimetext.com/download.

0. Скачайте rar-архив из последнего релиза и распакуйте в отдельную папку. В распакованном виде JAD включает в себя папку "`[disdocs]`", и её содержимое, и файл "`install.QSP.sublime-package.exe`", а так же файл текущей инструкции "`README.md`".
### Установка для пользователей Windows

1. Прежде всего у вас должен быть установлен Sublime Text, желательно Sublime Text 4. Скачать его можно отсюда https://www.sublimetext.com/download.
2. Запустите файл "`install.QSP.sublime-package.exe`" и следуйте инструкциям — пакет установится автоматически.
Данная инструкция ориентирована на пользователей, которые скачают последний релиз со страницы релизов: . Установка из исходников будет немного отличаться.

1. Далее скачайте установочный файл из [последнего релиза](https://github.com/AleksVersus/JAD_for_QSP/releases). Файл будет называться "`install.QSP.sublime-package.XX.exe`", где `XX` — номер версии.
2. Запустите установочный файл и следуйте инструкциям — пакет установится автоматически.
3. При желании скачайте и распакуйте в отдельную папку архив "`manual and examples.zip`", в котором содержится текущая инструкция и различные примеры проектов.

### Установка из исходников

1. Скачайте архив "`QSP.sublime-package.src.zip`" из [последнего релиза](https://github.com/AleksVersus/JAD_for_QSP/releases).
2. Откройте SublimeText и откройте папку с установленными пакетами: пункты меню "Preferences → Browse Packages..."
3. В открытую папку извлеките из архива "`QSP.sublime-package.src.zip`" папку QSP. При необходимости замените файлы.

**Перезагрузите Sublime Text после установки пакета!**

## Удаление пакета QSP из Sublime Text

0. Откройте SublimeText и откройте папку с установленными пакетами: пункты меню "Preferences → Browse Packages..."

### для пользователей Windows

1. Откройте папку QSP и запустите программу unins000.exe
2. Следуйте инструкциям.
3. Если папка QSP не удалится, или удалится не полностью, её можно удалить вручную.

### для пользователей, устанавливавших из исходников

1. Удалите папку QSP

**Перезагрузите Sublime Text после удаления пакета!**

## Состав пакета QSP для Sublime Text

Expand Down
10 changes: 10 additions & 0 deletions [disdocs]/[releases]/0.12.md
View file
@@ -0,0 +1,10 @@
# QSP-Package for Sublime Text v.0.12

* Доработаны алгоритмы ведения workspace. В корневой папке создаётся `qsp-project-workspase.json` и в него пишутся все собранные о проекте данные: пути к файлам, расположение локаций, etc.
* При вводе повторяющегося в проекте имени локации, или повторяющейся в текущем файле метки, всплывает системное окошко с сообщением, что такая локация или метка уже существуют. Это не ошибка, это предупреждение на тот случай, если вы вдруг не планировали в проекте двух локаций с одинаковыми названиями.
* При вводе названия локации в кавычках после `gosub`, `func(`, `goto`, `xgoto`, а так же при написании конструкции неявного вызова, будет предложен список автоподстановки. Если хоть одна буква в названии локации совпадает частично с уже созданными в проекте названиями локаций, будет предложен список автоподстановки из названий локаций. Аналогично с метками для `jump`, но список предлагаемых меток подбирается с текущего файла. Поведение полностью исправлено и работает.
* В подсветку синтаксиса добавлена подстветка неизвестных действий. Т.е. если вы ошиблись и написали `showact 1`, Sublime Text подсветит это как ошибку.

Несущественные для пользователя изменения описаны в todo.md

Как всегда, перед установкой рекомендую прочитать [инструкцию](https://github.com/AleksVersus/JAD_for_QSP/blob/master/README.md), а так же удалить старую версию.
5 changes: 5 additions & 0 deletions [disdocs]/to_realese.json
View file
@@ -0,0 +1,5 @@
{
"installer": "QSP.sublime-package.XX.exe",
"manuals and examples": "manuals and examples.zip",
"source of package": "QSP.sublime-package.src.zip"
}
78 changes: 39 additions & 39 deletions qsp-project-workspace.json
View file
Expand Up @@ -459,15 +459,6 @@
]
]
],
"C:\\Program Files\\Sublime Text\\Packages\\\u043d\u0430\u0447\u0430\u043b\u043e \u0438\u0441\u0442\u043e\u0440\u0438\u0438_01.qsps": [
[
"[1.2_story_start]",
[
2,
19
]
]
],
"[examples]\\example_project\\main\\\u0441\u044e\u0436\u0435\u0442\\\u043f\u0440\u043e\u0431\u0440\u043e\u0441_01.qsps": [
[
"[1.1_game_start]",
Expand Down Expand Up @@ -2121,6 +2112,15 @@
]
]
],
"C:\\Program Files\\Sublime Text\\Packages\\\u043d\u0430\u0447\u0430\u043b\u043e \u0438\u0441\u0442\u043e\u0440\u0438\u0438_01.qsps": [
[
"[1.2_story_start]",
[
2,
19
]
]
],
"QSP.sublime-package\\syntax_test_qsp.qsps": [
[
"start",
Expand All @@ -2132,106 +2132,106 @@
[
"[start]",
[
754,
761
723,
730
]
],
[
"[\u043e\u0448\u0438\u0431\u043a\u0438]",
[
3640,
3648
3609,
3617
]
],
[
"\u0444\u0438\u0433\u0443\u0440\u043d\u044b\u0435 \u0441\u043a\u043e\u0431\u043a\u0438 \u0434\u0435\u0439\u0441\u0442\u0432\u0438\u044f \u0443\u0441\u043b\u043e\u0432\u0438\u044f",
[
5780,
5812
5749,
5781
]
],
[
"[0.1_game_info]",
[
7194,
7209
7163,
7178
]
],
[
"newerland",
[
8277,
8286
8246,
8255
]
],
[
"\u043f\u0440\u0438\u0432\u0435\u0442",
[
8381,
8387
8350,
8356
]
],
[
"[\u043c:0]_\u043e\u0431\u0449\u0438\u0439_\u0432\u0438\u0434_\u043b\u043e\u043a\u0430\u0446\u0438\u0438_\u043c\u0435\u0441\u0442\u0430",
[
8421,
8450
8390,
8419
]
],
[
"[\u043c:1]_\u0434\u043e\u043c",
[
10639,
10648
10608,
10617
]
],
[
"[\u043c:2]_\u0443\u043b\u0438\u0446\u0430",
[
17047,
17058
17016,
17027
]
],
[
"\u043c\u0435\u0441\u0442\u043e;\u0441\u0442\u0430\u043d\u0434\u0430\u0440\u0442\u043d\u0430\u044f_\u043a\u0443\u0445\u043d\u044f",
[
18141,
18164
18110,
18133
]
],
[
"[chest]",
[
19159,
19166
19128,
19135
]
],
[
"\u043e\u0448\u0438\u0431\u043a\u0430 \u043a\u043e\u043d\u0446\u0430 \u043b\u043e\u043a\u0430\u0446\u0438\u0438",
[
31054,
31074
31023,
31043
]
],
[
"[death]",
[
31164,
31171
31133,
31140
]
],
[
"[sugar-func]",
[
32833,
32845
32802,
32814
]
],
[
"[help]",
[
33088,
33094
33057,
33063
]
]
]
Expand Down
6 changes: 3 additions & 3 deletions siaiz.md
View file
Expand Up @@ -28,9 +28,9 @@

## Этап 3. Установка пакета QSP в SublimeText

1. Скачайте последний релиз [пакета QSP для Sublime Text](https://github.com/AleksVersus/JAD_for_QSP/releases) в виде rar-архива;
2. Извлеките из архива файл "`install.QSP.sublime-package.exe`"
3. Запустите "`install.QSP.sublime-package.exe`" и следуйте инструкциям. Пакет автоматически установится в SublimeText.
1. Скачайте установочный файл из [последнего релиза](https://github.com/AleksVersus/JAD_for_QSP/releases). Файл будет называться "`install.QSP.sublime-package.XX.exe`", где `XX` — номер версии.
2. Запустите "`install.QSP.sublime-package.XX.exe`" и следуйте инструкциям. Пакет автоматически установится в SublimeText.
3. Перезагрузите Sublime Text, если он был запущен.

## Этап 4. Первая игра в SublimeText

Expand Down
14 changes: 14 additions & 0 deletions todo.md
View file
Expand Up @@ -68,6 +68,20 @@
* [2024.01.14] Добавлена автоподстановка названий локаций при вводе конструкции неявного вызова функций.
* [2024.01.15] Удалены сниппеты для оборачивания текста в HTML-теги.

#### v.0.11
* Добавлены все операторы, функции и системные переменные в списки автоподстановок.
* При создании новой локации редактор подскажет вам, что эта локация уже существует в проекте (пока что полноценно работает только на новых проектах)

#### v.0.12
* [2024.02.12] Доработаны алгоритмы ведения workspace. В корневой папке создаётся `qsp-project-workspase.json` и в него пишутся все собранные о проекте данные: пути к файлам, расположение локаций, etc.
* При вводе повторяющегося в проекте имени локации, или повторяющейся в текущем файле метки, всплывает системное окошко с сообщением, что такая локация или метка уже существуют. Это не ошибка, это предупреждение на тот случай, если вы вдруг не планировали в проекте двух локаций с одинаковыми названиями.
* При вводе названия локации в кавычках после `gosub`, `func(`, `goto`, `xgoto`, а так же при написании конструкции неявного вызова, будет предложен список автоподстановки. Если хоть одна буква в названии локации совпадает частично с уже созданными в проекте названиями локаций, будет предложен список автоподстановки из названий локаций. Аналогично с метками для `jump`, но список предлагаемых меток подбирается с текущего файла. Поведение полностью исправлено и работает.
* В подсветку синтаксиса добавлена подстветка неизвестных действий. Т.е. если вы ошиблись и написали `showact 1`, Sublime Text подсветит это как ошибку.
* [2024.02.12] Для функционала, описанного выше, исправлен файл подсветки синтаксиса, где учтены необходимые scopes. Так же в плагин добавлена асинхронность.
* Разнёсены некоторые части плагина в разные модули и перенесены в библиотечку `qSpy`.
* Исправлена работа с большинством путей, что теоретически должно обеспечить более корректную работу на `linux`.
* Произведён серьёзный рефакторинг кода, но требуется ещё более серьёзный. Пока что там сущий бардак и нет единства.

## предстоящие изменения:

### QSP-Builder:
Expand Down

0 comments on commit 49c2190

Please sign in to comment.