GameMapa

Офіційна документація Roblox: де її шукати

· 3 хв читання

Редакція GameMapaяк ми перевіряємо факти

Зміст
  1. Що таке Creator Hub
  2. Машинні індекси документації
  3. Будь-яка сторінка доків — і в Markdown
  4. Навіщо це звичайному розробнику
  5. Чого офіційно НЕ вказано
  6. Коротко

Офіційна документація 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. Працює це через суфікс до адреси:

  1. Візьми звичайну адресу сторінки документації на create.roblox.com/docs/…
  2. Додай .md одразу в кінець цієї адреси.
  3. Відкрий отриману адресу — замість оформленої 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-варіант.

Джерела