Guida al repositorio di SVN/Convenzioni per i nomi
Le convenzioni per i nomi sono necessarie per mantenere in ordine il repositorio e per rendere facile lavorarci. Alcuni file violano le regole comuni, rendendosi i primi candidati per essere rinominati.
Fare sempre in modo di attenersi a queste convenzioni quando si aggiungono nuovi file al repositorio.
Nomi delle texture
Il nome di una texture deve essere una o due parole che spiegano l'uso della texture stessa.
Le texture speciali (mappature delle normali, dei glow...) devono avere un suffisso secondo le regole dello skinframe (vedi texture)
Modello di nome:
- nometexture<gruppo_numero>_<variazione_numero>
Esempio:
textures/towns/brick1_1 textures/towns/brick1_2 textures/towns/brick1_3 textures/towns/brick2_1 textures/towns/brick2_2 textures/towns/brick2_3 textures/towns/brick3_1
Nomi dei materiali
I nomi dei materiali devono riprendere i nomi delle texture, dove possibile. Per motivi di trasmissibilità devono esserci solo barre (/), non barre capovolte.
Se il materiale è una variazione o un livello aggiuntivo di un materiale base il suo nome deve iniziare come quello del materiale base.
Esempio:
textures/inn/window // materiale base textures/inn/window_envmap // livello aggiuntivo per l'enVMap
Temi delle texture
I temi delle texture sono un metodo per classificare le texture nell'editor dei livelli. Nell'elenco delle texture è possibile guardare solo un tema alla volta. Può anche essere un buon metodo per separare i file in più cartelle.
Il tema di una texture deve essere di una paola e deve spiegare che per cosa sarà usata la texture (ad esempio per la cripta, il mausoleo, la locanda...).
Esempi:
crypt mausoleum dungeon spiritforge town
Nomi dei modelli
I nomi dei materiali possono contenere caratteri latini minuscoli, numeri, underscore (_) e spazi. I nomi devono avere sensati, suffissi e numeri vanno aggiunti solo se il modello è parte di un gruppo.
Important: Alcuni programmi per esportare i file, ad esempio 3D Studio Max ASE exporter, scrivono sempre le estensioni dei file in maiuscolo. Vanno modificate prima che i modelli siano caricati nel repositorioEsempi:
// Corretti models/mapobjects/graveyard/stone1.md3 models/mapobjects/graveyard/stone2.md3 models/mapobjects/graveyard/stone3.md3 models/mapobjects/misc/bat1.md3 models/mapobjects/misc/bat2.md3 // Sbagliati models/mapobjects/my models/barrel.md3 models/mapobjects/graveyard/stone4.MD3
Temi dei modelli
Come i temi delle texture, i temi dei modelli sono sottocartelle in models/mapobjects/. Il nome del tema di un modello deve essere di una parola, e deve spiegare per che cosa i modelli verranno utilizzati.
Esempi:
crypt dungeon graveyard
Nomi delle mappe
Il nome della mappa contiene la posizione della mappa stessa all'interno della gerarchia:
- Mondo
- Ubicazione
- Sub-ubicazione (opzionale)
- Ubicazione
Modello di nome:
- w<numeromondo>m<numeroubicazione>-<nome_ubicazione>-<nome_sub_ubicazione>
Se una sub-ubicazione è di un tipo ripetuto più volte (ci sono più cripte, caverne...) la prima non devee avere il numero 1 alla fine.
Esempi:
w1m1-cemetery w1m2-pillars-crypt w1m2-pillars-crypt2
I livelli per i test sono eccezioni, e va aggiunto il prefisso test- al loro nome. I livelli per i test non vengono aggiunti alla build della versione release.
Elementi delle mappe
Tutti gli elementi delle mappe vengono salvati nelle cartelle models/maps/<nome_posizione>. Vanno nominati secondo la loro convenzione.
Esempi:
// Corretto: terrain.ase // Sbagliati: 02.ase terr01b.ASE
