Project Intelligence Mod do Minecraft 1.12.2, 1.16.5

Witaj w Project Intelligence! czyli "PI"

Celem tego projektu jest stworzenie naprawdę uniwersalnego moda dokumentacyjnego poprzez wykorzystanie siły społeczności Minecrafta.

Jak więc to będzie działać? Na początek każdy twórca modów może dodać dokumentację swojego moda do PI. Problem w tym, że twórcy modów to zajęci ludzie, więc większość z nich nie będzie miała czasu na pisanie dokumentacji do jakiegoś przypadkowego moda dokumentacyjnego, takiego jak PI, i moim zdaniem jest to główny problem większości obecnych modów dokumentacyjnych. Wymagają one bezpośredniego wsparcia ze strony twórców modów. PI ma na celu rozwiązanie tego problemu, umożliwiając każdemu w społeczności wniesienie wkładu poprzez pisanie dokumentacji do różnych modów za pomocą stosunkowo prostego wbudowanego edytora. Następnie mogą oni przesłać swoją dokumentację poprzez pull request, a jeśli przejdzie ona recenzję, zostanie dodana do repozytorium online.

Wszystko, co robi PI, jest open source i całkowicie przejrzyste. Cała dokumentacja jest przechowywana w swojej surowej formie na githubie. Następnie jest ona budowana przez serwer jenkins i przesyłana na serwer internetowy kontrolowany przez covers1624, skąd może być dostępna dla PI. Wszystko, czego używa PI, pochodzi z tego serwera, w tym wszystkie obrazy używane w dokumentacji. Żadne żądania nie są wysyłane do serwerów spoza pi.brandon3055.com. Jedynym możliwym wyjątkiem jest dokumentacja paczki, o której więcej można przeczytać poniżej.

Edycja: Powyższe stwierdzenie będzie prawdziwe, gdy covers ukończy pi bot, który automatycznie zapewni, że wszystkie obrazy używane w pi będą hostowane na naszym serwerze. Do tego czasu niektóra dokumentacja może zawierać obrazy hostowane na imgur.com lub innych tego typu stronach hostingowych.

Funkcje: (Spodziewaj się, że ta lista będzie rosnąć wraz z rozwojem PI)

Wysoce konfigurowalny interfejs użytkownika Cały interfejs użytkownika PI jest wysoce konfigurowalny przez użytkownika. PI ma obecnie tylko 2 domyślne presety stylów, ale więcej zostanie dodanych w przyszłości. A użytkownicy mają możliwość zapisywania własnych niestandardowych presetów. Uwaga na marginesie: Jeśli stworzyłeś preset, który Twoim zdaniem byłby miłym dodatkiem do domyślnych presetów, śmiało opublikuj go na githubie.

Integracja z JEI PI ma pełne wsparcie dla przepisów JEI, co oznacza, że każdy przepis obsługiwany przez JEI może być wyświetlony w dokumentacji PI.

Łączenie treści i "Wyjaśnij to" Pozwala to na łączenie przedmiotów, bloków lub encji ze stronami dokumentacji. Działa to z funkcją o nazwie "Wyjaśnij to", która pozwala otwierać połączone strony dokumentacji, po prostu naciskając przypisany klawisz, patrząc na obiekt w świecie lub najeżdżając myszą na przedmiot w ekwipunku.

Łączenie dokumentacji z interfejsami Ta funkcja wymaga obecnie wsparcia ze strony modów (choć może się to zmienić w przyszłości). Ta funkcja pozwala twórcom modów łączyć konkretne strony dokumentacji z interfejsami w ich modzie. Pi doda wtedy przycisk "info" do obsługiwanych interfejsów, który otworzy mini okno pi wewnątrz interfejsu, zawierające strony połączone z tym interfejsem.

Wsparcie lokalizacji językowej

Wbudowany edytor Edytor dokumentacji pi wciąż wymaga trochę pracy, ale w obecnej formie zapewnia całą podstawową funkcjonalność wymaganą do pisania i utrzymywania dokumentacji.

Wsparcie dla wielu wersji modów Jest to niezbędna funkcja podczas pisania dokumentacji do stale zmieniających się modów. Ta funkcja pozwala aktualizować dokumentację, gdy mod coś zmienia, bez łamania kompatybilności z poprzednimi wersjami moda.

Dokumentacja paczki Jest to funkcja dodana dla twórców paczek modów. Pozwala ona pisać dokumentację identyczną z dokumentacją moda, z tą różnicą, że nie jest ona powiązana z konkretnym modem i jest przechowywana lokalnie w konfiguracji paczki, co oznacza, że może być dostarczana razem z paczką modów. Warto zauważyć, że w przeciwieństwie do dokumentacji modów nie mam kontroli nad hostingiem obrazów używanych w dokumentacji paczki. To od twórcy paczki zależy hostowanie ich na stronie takiej jak imgur.com lub na własnym prywatnym serwerze hostingu obrazów.

Współtworzenie: Wszystkie potrzebne informacje dotyczące współtworzenia własnej dokumentacji w grze PI znajdziesz w dokumentacji PI.

Pamiętaj, że system zaplecza, który umożliwi łatwe zarządzanie dokumentacją tworzoną przez użytkowników, jest wciąż rozwijany przez covers1624. Mam możliwość ręcznego akceptowania dokumentacji, ale zalecam poczekać, aż covers ukończy zaplecze.

Edycja: po namyśle covers jest trochę zajęty innymi projektami, więc na razie będzie to musiał pozostać proces ręczny.