JSO x
- 2nd Lieutenant -
 | | 1406 |
Doom Rate: 2.27
Posts quality: +790 |
 Отправлено: 08.02.26 13:53:46 | |
|
Доброго времени суток!
ZScript — не самый элементарный язык, и большинство хороших руководств, документаций и статей по нему есть только на английском языке. Существующие русскоязычные ресурсы либо покрывают какую-то небольшую часть, либо, к сожалению, остались доступны только в архивах.
Устойчивый спрос на ZScript в русскоязычной среде есть, и поэтому такое положение дел — с минимумом информации — необходимо исправлять. Итак, объявляю анонс первой публичной версии наиболее полного руководства по ZScript на русском языке!
Сайт руководства:
https://zscript-rus-manual.readthedocs.io/latest/
Там же "Быстрый старт" и страница оглавления.
Репозиторий проекта:
https://github.com/LLDM-Doom-Modding/zscript_rus_manual
Что ещё важно, данное руководство никуда не денется, даже если куда-то денутся все авторы — работу на данный момент обеспечивают два известных хостинга.
Внимание! Проект на данный момент находится в глубокой разработке, поэтому часть статей или разделов пока что отсутствует, в остальных же могут попадаться ошибки.
Просьба относиться с пониманием и по возможности о них сообщать или сразу исправлять. Конструктивная критика приветствуется, а отзывы и помощь дают огромный приток мотивации.
В руководство включается:
- Непосредственно раздел руководства — глава "Первый мод";
- Документация с дружелюбными примерами использования (главы от 3 до 6), а также полноценные примеры готового кода в отдельном разделе;
- Ссылки на ресурсы, где могут помочь разобраться с ZScript;
- Советы и решения, полученные из опыта (встречаются повсеместно и иногда в отдельных статьях);
- Как на самом деле работает движок — разбор внутренней работы движков семейства *ZDoom и языка ZScript;
- Списки частых ошибок, списки действительно неординарных багов, список ошибок компилятора — и, конечно, как их всех отслеживать и решать.
На данный момент написаны не все статьи — к примеру, глава 2 "Первый мод" включает в себя 7-8 статей, но готовы из них пока только 3.5. Прогресс можно отслеживать в репозитории проекта и в канале "#zscript-rus-manual-commits" Discord-сервера Russian Doom Discord Community. Пока что основная ветка разработки также находится на RDDC, в форум-канале "#Русскоязычный мануал по ZScript. Канал разработки". Новости в первую очередь будут публиковаться там и в этой теме на iddqd.ru.
Связаться с авторами можно:
- На большинстве серверов общей направленности в списке всех отечественных Doom-Discord-серверов;
- Здесь, в этой теме или в личных сообщениях iddqd.ru;
- В issues на GitHub;
- Где-нибудь ещё, где будет удобно общаться и где переписка не потеряется.
* * *
Ищем авторов и редакторов!
За всё время, считая только текстовые файлы статей размером более 1 Кб, было написано 396 Кб текста. За последние три ударные недели перед выпуском первой версии добавлено 112 Кб, или 957 строк/абзацев (подсчёт ведётся по символу новой строки), с учётом заменённых абзацев 1467. Если эти три недели смотреть по всем попарным изменения между соседними коммитами, заменено 1049 строк/абзацев, добавлено — 4328.
Конечно, это уже далеко не капля в море, но проект всё ещё не завершён, и в свободном темпе будет готов хорошо если через десяток лет.
Из истории, из результатов коммерческих компаний и мира Open Source известно, что совместная работа позволяет совершать то, что невозможно одному человеку. Потому, если Вы видите неточности или видите, что можно улучшить абзац — просьба сообщать, корректура тоже отнимает много времени. Если Вы знаете ту или иную тему из мира ZScript, призываю присоединяться к разработке — лучше написать и потом совместно исправить, чем не написать вовсе! Сокращение времени основного цикла разработки до полугода (получается, в двадцать раз) — это уже огромный успех, и он вполне реалистичен.
Вся цепочка поставок настроена, при отправке изменений в репозиторий они появляются и на сайте. В минимальной комплектации достаточно будет блокнота Windows и произвольного канала связи со мной или другим разработчиком, некоторые другие варианты описаны здесь. При необходимости со своей стороны могу провести краткий экскурс в работу с git/репозиторием, про текстовый язык разметки Markdown, или даже про локальное развёртывание сервера MkDocs для необязательного предпросмотра результата.
* * *
Успехов в изучении ZScript! |
Рейтинг сообщения: +12, отметил(и): MAZter[iddqd], Mikle, Dant3, camper, Endoomer, RaRu Des2122, Dron12261, Ear1h, EarKiller6002, Michael_63, RunnerFx, raspad |
|
Shadowman
UAC General
 | | 9241 |
Doom Rate: 2.03
Posts quality: +2598 |
| Отправлено: 22.03.26 21:18:49 | |
|
Отличная тема, но пользуясь случаем, дополню ее следующим вопросом.
Учитывая все ужесточающиеся блокировки, возможно предвидеть наступление часа Х, когда доступ на зарубежные ресурсы окажется полностью заблокирован, и никакой ВПН не спасет. В этой связи есть ли опыт архивирования здум-вики целиком, чтобы ей можно было пользоваться в изолированном режиме на компьютере без доступа к (зарубежному) интернету?
Может быть, пора сделать такую копию, чтобы не оказаться в случае чего вообще без ресурса?
(Понимаю, что в таком случае дум-моддинг отойдет на второй план, но все же иметь ресурс лучше, чем не иметь его вообще). |
|
|
JSO x
- 2nd Lieutenant -
| | 1406 |
Doom Rate: 2.27
Posts quality: +790 |
| Отправлено: 25.03.26 12:54:43 | |
|
| Shadowman пишет: | | Может быть, пора сделать такую копию, чтобы не оказаться в случае чего вообще без ресурса? |
Есть статья "Downloading the ZDoom Wiki", где можно скачать ежедневно обновляемое зеркало Википедии. Движок MediaWiki, используемый на zdoom.org, со своей основной зависимостью MariaDB весит ещё 500 Мб — так что, если нет острой необходимости разворачивать свой сервер, можно с помощью проекта https://github.com/philipashlock/mediawiki-to-markdown конвертировать всё в Markdown-текст, открываемый в любом Блокноте. Или, менее изящный вариант, можно выкачать весь сайт через какой-нибудь HTTrack (но есть вероятность, что где-то на середине канал перекроют). А вот с кем договариваться об аренде сервера для некоммерческой бесплатной документации, я пока не знаю. Возможно, потребуется его у кого-нибудь арендовать.
Если говорить об этом руководстве по ZScript, то последнюю локальную версию в виде Markdown-файлов всегда можно скачать по прямой ссылке в репозитории. GitHub сейчас должен работает с любого провайдера. Надеюсь, до этого дело не дойдёт, но в крайнем случае сделаю зеркало репозитория и, если найду подходящие варианты, подниму сайт на российских серверах. Скоро как раз намеревался добавить инструкцию по конвертации всего руководства в сайт и по запуску локального сервера.
* * *
К теме проекта. Выяснил, что некоторые поисковики вроде Google слабо индексируют сайт ReadTheDocs, и это руководство в частности. Так что, оказывается, есть шанс, что его могут не найти даже при прямом запросе в поисковике... Поэтому прошу по возможности распространять ссылку на руководство там, где оно может оказаться полезным.
Сейчас время в основном получается проводить на работе, которая местами тоже связана с написанием технической документации, так что со своей стороны пока не слишком проявляю активность. Но, несомненно, проект всё так же остаётся в силе и никуда не исчезает.
P. S. Оффтоп, но заметил, что порядок имён в подсчёте рейтинга сообщения определяется по тому, кто когда зарегистрировался на сайте. Чем ближе к началу — тем старше аккаунт ꓽ) . |
|
|
Правила 
Поиск
