Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

Organizace projektu

Úvod

Vzhledem k tomu, že Godot nemá žádná omezení týkající se struktury projektu nebo použití souborového systému, může se uspořádání souborů při učení se enginu zdát náročné. Tento návod navrhuje pracovní postup, který by měl být dobrým výchozím bodem. Budeme se také zabývat používáním správy verzí v systému Godot.

Organizace

Godot je primárně založen na scénách a používá souborový systém tak jak je, tj. bez metadat nebo databáze zdrojů.

Na rozdíl od jiných enginů je mnoho zdrojů obsaženo uvnitř scény samotné , takže množství souborů v souborovém systému je podstatně nižší.

Vzhledem k tomu je zvykem seskupovat prostředky co nejblíže scénám; když se projekt rozrůstá, je pak lépe udržovatelný.

Například do jedné složky lze obvykle umístit základní zdroje, jako jsou obrázky spritů, sítě 3D modelů, materiály, hudba atd. Samostatnou složku pak lze využít pro ukládání sestavených úrovní, které základní zdroje používají.

/project.godot
/docs/.gdignore  # See "Ignoring specific folders" below
/docs/learning.html
/models/town/house/house.dae
/models/town/house/window.png
/models/town/house/door.png
/characters/player/cubio.dae
/characters/player/cubio.png
/characters/enemies/goblin/goblin.dae
/characters/enemies/goblin/goblin.png
/characters/npcs/suzanne/suzanne.dae
/characters/npcs/suzanne/suzanne.png
/levels/riverdale/riverdale.scn

Průvodce stylem

Pro zajištění konzistence mezi projekty doporučujeme dodržovat tyto pokyny:

  • Pro názvy složek a souborů (s výjimkou skriptů v jazyce C#) používejte snake_case. Tím se vyhnete problémům s citlivostí velkých a malých písmen, které se mohou objevit po exportu projektu v systému Windows. Skripty C# jsou výjimkou z tohoto pravidla, protože konvence je pojmenovat soubor podle názvu třídy, který by měl být v PascalCase.

  • Pro názvy uzlů použijte PascalCase, protože to odpovídá vestavěnému zápisu uzlů.

  • Obecně platí, že prostředky třetích stran je lépe uchovávat ve vrcholové složce addons/, i když se nejedná o zásuvné moduly editoru. Snadněji pak lze sledovat, které soubory patří třetí straně. Z tohoto pravidla existují výjimky; například pokud pro postavu používáte herní prostředky třetích stran, je rozumnější je zařadit do stejné složky jako scény a skripty postavy.

Import

Verze Godot před verzí 3.0 prováděly import ze souborů mimo projekt. To sice může být užitečné u velkých projektů, ale pro většinu vývojářů to znamenalo organizační potíže.

Z tohoto důvodu jsou nyní prostředky transparentně importovány ze složky projektu.

Ignorování určitých složek

Chcete-li Godotu zabránit v importu souborů obsažených v určité složce, vytvořte v této složce prázdný soubor s názvem .gdignore (počáteční znak . je nutný). To může být užitečné pro urychlení počátečního importu projektu.

Poznámka

To create a file whose name starts with a dot on Windows, place a dot at both the beginning and end of the filename (".gdignore."). Windows will automatically remove the trailing dot when you confirm the name.

Alternatively, you can use a text editor such as Notepad++ or use the following command in a command prompt: type nul > .gdignore

Jakmile je složka ignorována, prostředky v této složce již nelze načíst pomocí metod load() a preload(). Ignorování složky ji také automaticky skryje z doku FileSystem, což může být užitečné pro snížení nepořádku.

Note that the .gdignore file's contents are ignored, which is why the file should be empty. It does not support patterns like .gitignore files do.

Citlivost na velikost písmen

Systém Windows a nejnovější verze systému macOS používají ve výchozím nastavení souborový systém NErozlišující malá a velká písmena, zatímco linuxové distribuce ve výchozím nastavení souborového systému velká a malá písmena rozlišují. To může způsobit problémy při exportu projektu, protože virtuální souborový systém PCK systému Godot malá a velká písmena rozlišuje . Abyste se tomu vyhnuli, doporučujeme pojmenování dle snake_case pro všechny soubory v projektu (a malá písmena obecně ).

Poznámka

Toto pravidlo můžete porušit, pokud příručky stylů říkají něco jiného (například příručka stylů jazyka C#). Přesto buďte důslední, abyste se vyhnuli chybám.

Chcete-li se v systému Windows 10 dále vyhnout chybám souvisejícím s rozlišováním velkých a malých písmen, můžete také nastavit, aby se ve složce projektu velká a malá písmena rozlišovala . Po povolení funkce Subsystém Windows pro Linux spusťte v okně prostředí PowerShell následující příkaz:

# To enable case-sensitivity:
fsutil file setcasesensitiveinfo <path to project folder> enable

# To disable case-sensitivity:
fsutil file setcasesensitiveinfo <path to project folder> disable

Pokud jste nepovolili podsystém Windows pro Linux, můžete do okna prostředí PowerShell spuštěného jako správce zadat následující řádek a po výzvě restartovat počítač:

Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux