Официальная документация Roblox: где её искать
Содержание
Официальная документация Roblox для разработчиков лежит в одном месте — Creator Hub на create.roblox.com/docs, и оттуда есть прямой путь к машиночитаемым версиям всего, что там написано.
Этот материал — не пересказ содержимого доков, а карта: куда смотреть, когда что-то непонятно, и как получить документацию не для чтения глазами, а для инструментов.
Что такое Creator Hub
Creator Hub — официальный раздел Roblox для разработчиков. Там собрана документация движка и отдельный раздел со справочником языка сценариев Luau на create.roblox.com/docs/luau. Это источник, на который стоит ориентироваться в первую очередь: сторонние вики и гайды могут отставать от официальных страниц или трактовать что-то по-своему, а Creator Hub — прямой справочник от самого Roblox.
Для того, кто просто играет в игры на Roblox, Creator Hub вообще не понадобится — это справочник именно для тех, кто что-то в Roblox строит: пишет скрипты, настраивает движок или обращается к Roblox извне через облачные интерфейсы.
Машинные индексы документации
Кроме обычных страниц для чтения людьми, Roblox публикует отдельные индексы документации в формате llms.txt — текстовые файлы со списком и структурой доков, предназначенные для машинной обработки. Таких индексов несколько, и каждый охватывает свою часть документации:
| Индекс | Адрес | Что охватывает |
|---|---|---|
| Общий | create.roblox.com/docs/llms.txt | Вся документация Creator Hub |
| Справочник движка | create.roblox.com/docs/reference/engine/llms.txt | Справочник движка Roblox (Engine Reference) |
| Облачные интерфейсы | create.roblox.com/docs/cloud/llms.txt | Справочник облачных интерфейсов Roblox |
То есть если нужен именно справочник движка, не обязательно перебирать весь общий индекс — есть отдельный, более узкий файл.
Любая страница доков — и в Markdown
Отдельно Roblox даёт способ получить любую страницу документации не в привычном HTML-виде, а как простой текст в формате Markdown. Работает это через суффикс к адресу:
- Возьми обычный адрес страницы документации на create.roblox.com/docs/…
- Добавь
.mdсразу в конец этого адреса. - Открой полученный адрес — вместо оформленной HTML-страницы загрузится её текстовый Markdown-вариант.
Это касается страниц документации в целом, а не только самих файлов-индексов. То есть к каждой отдельной странице с объяснением конкретной функции движка или метода Luau тоже можно дописать .md и получить тот же текст без разметки сайта — заголовков меню, боковой навигации и прочего оформления.
Зачем это обычному разработчику
Если ты пишешь скрипты для игры в Roblox Studio, в повседневной работе тебе нужны именно обычные страницы Creator Hub — там справочник Luau и описание функций движка. Если ты только делаешь первые шаги в Studio, сначала стоит пройти базовый гайд, а уже потом обращаться в Creator Hub за деталями конкретных функций. Первые шаги в Roblox Studio мы разобрали отдельно.
А вот llms.txt-индексы и Markdown-версии страниц пригодятся скорее тогда, когда документацию обрабатывает не человек, а инструмент, — например, когда нужно взять справочник движка целым файлом, а не страница за страницей.
Чего официально НЕ указано
- Сколько страниц или разделов входит в каждый из трёх индексов — Roblox этого не публикует.
- Существуют ли отдельные llms.txt-индексы для других частей Creator Hub, кроме движка и облачных интерфейсов, — официально не сказано.
- Как часто эти индексы обновляются относительно самих страниц документации — не указано.
- Действуют ли какие-то ограничения на автоматизированную загрузку этих файлов сторонними инструментами — Roblox этого не поясняет.
Коротко
Вся официальная документация Roblox для разработчиков лежит в Creator Hub на create.roblox.com/docs, а для машинной обработки в ней есть три отдельных llms.txt-индекса и Markdown-версия каждой страницы через суффикс .md.
Частые вопросы
Где официальная документация Roblox для разработчиков?
В Creator Hub на create.roblox.com/docs. Там собраны справочник движка, документация языка Luau и описание облачных интерфейсов — всё в одном месте, а не разбросано по сторонним ресурсам.
Что такое llms.txt в документации Roblox?
Текстовый файл-индекс документации, предназначенный для машинной обработки, а не для чтения человеком. Roblox публикует его по адресу create.roblox.com/docs/llms.txt.
Есть ли отдельный справочник движка Roblox в машинном формате?
Да. Для справочника движка существует отдельный индекс create.roblox.com/docs/reference/engine/llms.txt — более узкий, чем общий, только про движок.
Где индекс документации облачных интерфейсов Roblox?
По адресу create.roblox.com/docs/cloud/llms.txt. Это отдельный индекс именно для облачных интерфейсов, а не для всей документации Creator Hub.
Как получить страницу документации Roblox в формате Markdown?
Добавить суффикс .md сразу в конец адреса нужной страницы на create.roblox.com/docs. Вместо оформленной HTML-страницы загрузится её текстовый Markdown-вариант.