====== Formální požadavky ======

Zde jsou upřesněny požadavky a náležitosti formy semestrálního projektu.

===== Zpráva =====

Typická délka zprávy je 4-6 stran. Obecně ale **není stanovena minimální ani maximální délka** zprávy k projektu - je na každém týmu zhodnotit, co vše ve zprávě zmínit.

Zpráva by měla mít strukturu závěrečné práce, tedy hlavně kapitoly úvod, analýza, implementace a závěr.

===== Prezentace =====

Jelikož je na prezentaci věnované jedno cvičení, odvíjí se od toho i délka prezentace každého týmu. Zároveň musí po prezentaci zbýt čas na dotazy a případné hodnocení.

Každý tým bude mít na prezentaci **8 minut**.

===== Implementace =====

Výsledná implementace je týmem odevzdávaná buď jako archiv, nebo jako odkaz na repozitář, odkud lze kód stáhnout.

O odevzdávaném archivu nebo obsahu repozitáře by mělo platit následující:
  * Projekt lze otevřít a spustit.
  * Archiv neobsahuje žádné soubory, které si prostředí generuje samo z odevzdaných souborů.
  * Součástí projektu je minimum (ideálně žádný) obsahu a kódu, který není součástí implementace, popřípadě její ukázky/scény.
  * Napsaný kód by měl být patřičně komentován.

<note tip>Pokud použijete při vývoji verzovací systém git, snadno druhý bod splníte pomocí souboru ''.gitignore''</note>

Níže je uvedena správná struktura pro projekty Unreal Engine 5 a Unity. Pokud si nejste něčím jisti nebo na projekt použijete jiné prostředí, neváhejte se zeptat cvičícího.

==== Unreal Engine 5 ====

K Unreal Engine je potřeba zmínit dvě věci. První jsou složky, které engine generuje automaticky a tak není třeba je odevzdávat (ani sdílet pro práci v týmu). Jde hlavně o tyto složky, případně ty samé složky v každém pluginu, který je součástí projektu:

  * Build
  * DerivedDataCache
  * Intermediate
  * Saved

Kdybyste pracovali na větším projektu, používá se také sdílená Derived Data Cache - hodí se v případech, kdy by byla umístěna na místní síti a přístup by trval kratší dobu než data znovu vygenerovat. V našem případě je ale lepší DDC nesdílet.

Pro git repozitář můžete použít tento obsáhlý ''.gitignore'', který zajistí, že přebytečné soubory nebudou v repozitáři zahrnuty: https://raw.githubusercontent.com/github/gitignore/main/UnrealEngine.gitignore

Druhá věc je obsah navíc. Můžete pro svoje projekty použít libovolný volně dostupný balíček obsahu (např. Starter Content, který je součástí instalace UE5). V odevzdávané verzi projektu, ať už jde o poslední commit nebo archiv, by měl zůstat jen ten **obsah, který skutečně používáte**.

==== Unity ====

Podobně jako u Unreal Engine, také Unity generuje ve složce projektu data, která není potřeba v týmu sdílet a neměla by být součástí odevzdání. Jedná se hlavně o tyto složky:

  * Library 
  * Temp
  * Obj
  * Build(s)
  * Logs
  * UserSettings

Pro git repozitář můžete použít tento obsáhlý ''.gitignore'', který zajistí, že přebytečné soubory nebudou v repozitáři zahrnuty: https://raw.githubusercontent.com/github/gitignore/main/Unity.gitignore

Také dbejte na to, aby v odevzdané verzi semestrální práce byly jen ty soubory **obsahu, který skutečně používáte.** Nepoužité modely, textury, zvuky, atd. z odevzdávané verze odstraňte.