An example of a game jam repository.
Java HTML CSS JavaScript
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
project
.gitignore
CREDITS.md
LICENSE.md
README.md

README.md

Przykładowe repozytorium

To repozytorium zawiera prosty, przykładowy projekt oraz instrukcję korzystania z GitHuba.

Instrukcja

  1. Po zgłoszeniu zespołu, organizatorzy założą Waszej drużynie repozytorium dostępne pod adresem github.com/BialJam/NazwaDruzyny. Wszystkie osoby ze zgłoszonymi loginami powinny mieć pełne prawa do modyfikacji repozytorium. Przed jamem warto nadrobić braki w obsłudze Gita.
  2. Projekt można zacząć od dodania pliku README.md (przykład), który będzie wyświetlany jako opis repozytorium. Składnia jest bardzo prosta. Warto tu wspomnieć o używanych silnikach i bibliotekach. Koniecznie należy wybrać licencję (przykład) - dowolną Creative Commons (w tym CC0).
  3. Jeżeli jesteście zdecydowani na określony silnik/framework, warto wrzucić szkielet aplikacji do repozytorium. Dozwolny jest tzw. projektowy boilerplate, czyli generyczna baza aplikacji bez implementacji logiki gry - coś, co zwykle jest generowane automatycznie, ale mimo wszystko może zmarnować trochę czasu (przykład). Ten szkielet może również zawierać zalążki niewystylizowanego UI (typowe ekrany, nic specyficznego dla wybranej gry). Taka baza musi być zatwierdzona przez organizatorów i - jeżeli pozwala uruchomić zalążek aplikacji - musi zawierać prostą instrukcję obsługi (przykład) lub plik wykonywalny.
  4. Jeśli Wasza drużyna korzysta z darmowych zasobów, warto dodać plik z wymienionymi twórcami (przykład) - szczególnie, gdy wymaga tego licencja.
  5. Zmiany w repozytorium są dozwolone tylko w czasie game jamu. Po zakończeniu konkursu, uprawnienia będą stopniowo usuwane.
  6. Przed zakończeniem jamu należy wydać grę, najlepiej spakowaną archiwum zip wraz z instrukcją obsługi i pobieżnym spisem wymagań (przykład).
  7. Opcjonalnie, jeżeli gra wymaga zwykłej przeglądarki do uruchomienia (JavaScript, Flash itp.): można skorzystać z github.io, zakładając prostą witrynę projektu. Poszczególne kroki tworzenia witryny można znaleźć przechodząc do Project site -> Start from scratch. Uproszczona instrukcja:
  8. Utwórz branch gh-pages (przykład).
  9. Zacommituj niezbędne skrypty, zasoby oraz index.html do nowego brancha. Możesz opcjonalnie usunąć pozostałe pliki: wystarczy, że kod aplikacji i pliki informacyjne będą w masterze (przykład).
  10. Sprawdź, czy Twoja gra jest dostępna na bialjam.github.io/TwojaDruzyna (przykład).

Przykładowy opis projektu

Gra stworzona w ramach BialJamu. Wyświetla jaszczura na środku ekranu i kompletnie ignoruje akcje użytkownika. Do utworzenia aplikacji wykorzystano framework LibGDX. Gra wymaga JRE 7+ (wersja desktopowa) lub dowolnej przeglądarki obsługującej WebGL (wersja na przeglądarkę).