Oficjalna dokumentacja Roblox: gdzie jej szukać
Spis treści
Oficjalna dokumentacja Roblox dla deweloperów znajduje się w jednym miejscu — Creator Hub na create.roblox.com/docs, a stamtąd prowadzi bezpośrednia droga do maszynowo czytelnych wersji wszystkiego, co tam napisano.
Ten materiał to nie streszczenie treści dokumentacji, lecz mapa: gdzie patrzeć, gdy coś jest niejasne, i jak uzyskać dokumentację nie do czytania oczami, lecz dla narzędzi.
Czym jest Creator Hub
Creator Hub to oficjalna sekcja Roblox dla deweloperów. Zebrano tam dokumentację silnika oraz osobną sekcję z dokumentacją języka skryptowego Luau na create.roblox.com/docs/luau. To źródło, na którym warto opierać się w pierwszej kolejności: zewnętrzne wiki i poradniki mogą pozostawać w tyle za oficjalnymi stronami albo interpretować coś po swojemu, a Creator Hub to bezpośrednia dokumentacja od samego Roblox.
Dla kogoś, kto po prostu gra w gry na Roblox, Creator Hub w ogóle nie będzie potrzebny — to dokumentacja właśnie dla tych, którzy coś w Roblox budują: piszą skrypty, konfigurują silnik albo łączą się z Roblox z zewnątrz przez interfejsy chmurowe.
Maszynowe indeksy dokumentacji
Oprócz zwykłych stron przeznaczonych do czytania przez ludzi, Roblox publikuje osobne indeksy dokumentacji w formacie llms.txt — pliki tekstowe z listą i strukturą dokumentacji, przeznaczone do przetwarzania maszynowego. Takich indeksów jest kilka, każdy obejmuje inną część dokumentacji:
| Indeks | Adres | Co obejmuje |
|---|---|---|
| Ogólny | create.roblox.com/docs/llms.txt | Cała dokumentacja Creator Hub |
| Dokumentacja silnika | create.roblox.com/docs/reference/engine/llms.txt | Dokumentacja silnika Roblox (Engine Reference) |
| Interfejsy chmurowe | create.roblox.com/docs/cloud/llms.txt | Dokumentacja interfejsów chmurowych Roblox |
Czyli jeśli potrzebna jest akurat dokumentacja silnika, nie trzeba przeszukiwać całego indeksu ogólnego — istnieje osobny, węższy plik.
Dowolna strona dokumentacji — także w Markdown
Osobno Roblox daje sposób na pobranie dowolnej strony dokumentacji nie w zwykłej postaci HTML, lecz jako zwykły tekst w formacie Markdown. Działa to przez przyrostek dodany do adresu:
- Weź zwykły adres strony dokumentacji na create.roblox.com/docs/…
- Dodaj
.mdbezpośrednio na końcu tego adresu. - Otwórz uzyskany adres — zamiast sformatowanej strony HTML wczyta się jej tekstowa wersja w Markdown.
Dotyczy to stron dokumentacji ogółem, a nie tylko samych plików-indeksów. Czyli do każdej pojedynczej strony z opisem konkretnej funkcji silnika czy metody Luau też można dopisać .md i otrzymać ten sam tekst bez oprawy strony — nagłówków menu, nawigacji bocznej i reszty formatowania.
Po co to zwykłemu deweloperowi
Jeśli piszesz skrypty do gry w Roblox Studio, na co dzień potrzebujesz właśnie zwykłych stron Creator Hub — tam jest dokumentacja Luau i opis funkcji silnika. Jeśli dopiero stawiasz pierwsze kroki w Studio, warto najpierw przejść podstawowy poradnik, a dopiero potem sięgać do Creator Hub po szczegóły konkretnych funkcji. Pierwsze kroki w Roblox Studio omówiliśmy osobno.
Indeksy llms.txt i wersje Markdown stron przydają się raczej wtedy, gdy dokumentację przetwarza nie człowiek, lecz narzędzie — na przykład gdy trzeba pobrać dokumentację silnika jako jeden plik, a nie stronę po stronie.
Czego oficjalnie NIE podano
- Ile stron lub sekcji wchodzi w skład każdego z trzech indeksów — Roblox tego nie publikuje.
- Czy istnieją osobne indeksy llms.txt dla innych części Creator Hub poza silnikiem i interfejsami chmurowymi — oficjalnie nie powiedziano.
- Jak często te indeksy są aktualizowane względem samych stron dokumentacji — nie podano.
- Czy obowiązują jakieś ograniczenia dotyczące automatycznego pobierania tych plików przez zewnętrzne narzędzia — Roblox tego nie wyjaśnia.
Krótko
Cała oficjalna dokumentacja Roblox dla deweloperów znajduje się w Creator Hub na create.roblox.com/docs, a do przetwarzania maszynowego służą trzy osobne indeksy llms.txt oraz wersja Markdown każdej strony dostępna przez przyrostek .md.
Najczęstsze pytania
Gdzie jest oficjalna dokumentacja Roblox dla deweloperów?
W Creator Hub na create.roblox.com/docs. Zebrano tam dokumentację silnika, dokumentację języka Luau i opis interfejsów chmurowych — wszystko w jednym miejscu, a nie rozproszone po zewnętrznych źródłach.
Czym jest llms.txt w dokumentacji Roblox?
To tekstowy plik-indeks dokumentacji przeznaczony do przetwarzania maszynowego, a nie do czytania przez człowieka. Roblox publikuje go pod adresem create.roblox.com/docs/llms.txt.
Czy istnieje osobny indeks dokumentacji silnika Roblox w formacie maszynowym?
Tak. Dla dokumentacji silnika istnieje osobny indeks create.roblox.com/docs/reference/engine/llms.txt — węższy niż ogólny, dotyczący tylko silnika.
Gdzie jest indeks dokumentacji interfejsów chmurowych Roblox?
Pod adresem create.roblox.com/docs/cloud/llms.txt. To osobny indeks właśnie dla interfejsów chmurowych, a nie dla całej dokumentacji Creator Hub.
Jak pobrać stronę dokumentacji Roblox w formacie Markdown?
Wystarczy dodać przyrostek .md na końcu adresu wybranej strony na create.roblox.com/docs. Zamiast sformatowanej strony HTML wczyta się jej tekstowa wersja w Markdown.