Repository Reference/Repository structure in-depth

From Blood Wiki
(Difference between revisions)
Jump to: navigation, search
m
m
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
{{navigation title|Naming conventions}}
+
{{navigation title|}}
−
 
+
{{grammar}}
−
==kain/==
+
==User files==
 +
User files are files created by user, depending of engine settings, they could be located in game folder or in '''My Documents/My Games/omnicide'''.
 +
Here is draft listing of this files:
 
<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
 
<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
 
{|
 
{|
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''cubemaps'''
 
−
| cubemap light filters used on lights (animated cubemaps is stored in subfolders)
 
−
|-
 
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| '''data'''
 
| '''data'''
−
| this directory is created and managed by engine, it stores savegames, edited files, temp files
+
| this directory is created and managed by engine, it stores savegames, edited files, temp files etc.
 
|-
 
|-
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| '''dds'''
 
| '''dds'''
−
| stores all DDS files to be loaded instead of base textures
+
| dynamically created DDS files (fonts, locale images)
 +
|-
 +
| [[File:Icon folder.png|16px|alt=|link=]]
 +
| '''screenshots'''
 +
| screenshots taken from game
 +
|-
 +
| [[File:Icon folder.png|16px|alt=|link=]]
 +
| '''videos'''
 +
| FMV's and recorded with '''cl_capturevideo''' videos
 +
|-
 +
| [[File:Icon file.png|16px|alt=|link=]]
 +
| '''config.cfg'''
 +
| game config file
 +
|-
 +
| [[File:Icon file.png|16px|alt=|link=]]
 +
| '''omnicide.log'''
 +
| engine log file
 +
|-
 +
| [[File:Icon file.png|16px|alt=|link=]]
 +
| '''darkplaces_history.txt'''
 +
| console typing history
 +
|}
 +
</div>
 +
 
 +
==Game files==
 +
kain/
 +
<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
 +
{|
 +
| [[File:Icon folder.png|16px|alt=|link=]]
 +
| '''cubemaps'''
 +
| cubemap light filters used on lights (animated cubemaps is stored in subfolders)
 
|-
 
|-
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| [[File:Icon folder.png|16px|alt=|link=]]  
Line 38: Line 66:
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| '''models'''
 
| '''models'''
−
| all game 3d models and textures for them/
+
| all game 3d models and textures for them
 
|-
 
|-
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| [[File:Icon folder.png|16px|alt=|link=]]  
Line 50: Line 78:
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| '''radiant'''
 
| '''radiant'''
−
| textures and scripts used by leve leditor
+
| textures and scripts used by level editor
−
|-
+
−
| [[File:Icon folder.png|16px|alt=|link=]]
+
−
| '''screenshots'''
+
−
| screenshots taken from game (if running omnicide with no-home-dir option)
+
−
|-
+
−
| [[File:Icon folder.png|16px|alt=|link=]]
+
−
| '''videos'''
+
−
| FMV's and recorded with '''cl_capturevideo''' videos
+
 
|-
 
|-
 
| [[File:Icon folder.png|16px|alt=|link=]]  
 
| [[File:Icon folder.png|16px|alt=|link=]]  
Line 75: Line 95:
 
| '''csprogs.dat'''
 
| '''csprogs.dat'''
 
| client-side compiled game logic
 
| client-side compiled game logic
−
|-
 
−
| [[File:Icon file.png|16px|alt=|link=]]
 
−
| '''darkplaces_history.txt'''
 
−
| console typing history (if running omnicide with no-home-dir option)
 
 
|-
 
|-
 
| [[File:Icon file.png|16px|alt=|link=]]  
 
| [[File:Icon file.png|16px|alt=|link=]]  
Line 102: Line 118:
 
| [[File:Icon archive.png|16px|alt=|link=]]  
 
| [[File:Icon archive.png|16px|alt=|link=]]  
 
| '''PILL500.PK3'''
 
| '''PILL500.PK3'''
−
| generated textures DDS cache (see [[#Building a Game|Building a Game/Textures DDS cache]])
+
| generated textures DDS cache (see [[Repository_Reference/Building_a_Game#Textures_DDS_cache|Building a Game/Textures DDS cache]])
 
|-
 
|-
 
| [[File:Icon file.png|16px|alt=|link=]]  
 
| [[File:Icon file.png|16px|alt=|link=]]  
Line 111: Line 127:
 
| '''menu.dat'''
 
| '''menu.dat'''
 
| compiled game logic for a menu
 
| compiled game logic for a menu
−
|-
 
−
| [[File:Icon file.png|16px|alt=|link=]]
 
−
| '''omnicide.log'''
 
−
| engine log file (only if running game with developer option)
 
 
|-
 
|-
 
| [[File:Icon raw.png|16px|alt=|link=]]  
 
| [[File:Icon raw.png|16px|alt=|link=]]  
Line 298: Line 310:
 
|}
 
|}
 
</div>
 
</div>
−
 
−
====models/mapobjects/====
 
−
One or largest model folders. It contains models to be used on levels as [[func_model]] or [[func_gamemodel]].
 
−
 
−
{{tip|Once development progressing, new mapobject themes get added.}}
 
−
 
−
<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
 
−
{|
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''cave'''
 
−
| models for 'cave' theme
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''crypt'''
 
−
| models for 'crypt' theme
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''dungeon'''
 
−
| models for 'dungeon' theme
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''graveyard'''
 
−
| models for 'graveyard' theme
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''inn'''
 
−
| models for 'inn' theme
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''misc'''
 
−
| unthemed widely used models
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''outdoor'''
 
−
| models for 'Nosgoth Outdoors' theme
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''spikes'''
 
−
| models used in spike zones
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''town'''
 
−
| models for 'town' theme
 
−
|-
 
−
| [[File:Icon folder.png|16px|alt=|link=]]
 
−
| '''trees'''
 
−
| tree models
 
−
|}
 
−
</div>
 
−
 
−
{{navigation footer|Automations}}
 

Latest revision as of 22:58, 4 April 2013

Repository Reference

Contents

[edit] User files

User files are files created by user, depending of engine settings, they could be located in game folder or in My Documents/My Games/omnicide. Here is draft listing of this files:

data this directory is created and managed by engine, it stores savegames, edited files, temp files etc.
dds dynamically created DDS files (fonts, locale images)
screenshots screenshots taken from game
videos FMV's and recorded with cl_capturevideo videos
config.cfg game config file
omnicide.log engine log file
darkplaces_history.txt console typing history

[edit] Game files

kain/

cubemaps cubemap light filters used on lights (animated cubemaps is stored in subfolders)
game game-related scripts (map scripts, gamemodel scripts etc.)
gfx all 2d textures used for graphical user interface
glsl OpenGL GLSL shaders
locale this folder stores all locales
maps game levels and it's additional files (lights, sources, lightmaps etc.)
models all game 3d models and textures for them
music game music
particles textures used on particles
radiant textures and scripts used by level editor
scripts material scripts and client-side scripts such as menus, environments etc.
sound all game sounds
textures textures used on map surfaces (brushes, curves, terrains etc.)
csprogs.dat client-side compiled game logic
effectinfo.txt effects script
LEGACY0.PK3 Blood Omen original files (created during installation)
LEGACY1.PK3 Blood Omen sounds from demo version, this file only exist if installing PlayStation version of the game
LEGACY2.PK3 Blood Omen FMV's (created during installation)
LEGACY3.PK3 Blood Omen sprites DDS cache
PILL500.PK3 generated textures DDS cache (see Building a Game/Textures DDS cache)
lightstyles.txt Lightstyles table
menu.dat compiled game logic for a menu
pill.big Blood Omen original file (copied during installation)
progs.dat compiled server-side game logic
quake.rc engine startup file

[edit] game/

maps map configuration scripts, each file holds a script for particular map
models gamemodel scripts
default.cfg Defaut config file
engine.cfg Engine config file
omnicide.cfg Blood Omnicide-specific config file (loaded after engine config file)
world0.nsx worldmap script for prologue game part
world0.nsx worldmap script for the present game part

[edit] textures/

Tip: Once development progressing, new themes get added.
common textures for common materials
cellar textures for 'cellar' theme
crypt textures for 'crypt' theme
decals all decal textures
dungeon textures for 'dungeon' theme
envmaps environment maps and cubemaps used on materials for cubemap reflections and tcGen environment
liquids textures used for liquids - lava, water, swamp
mausoleum textures for 'mausoleum' theme
murals murals for spells, artifacts, events etc.
signboard textures for signboards
special special textures (overlays, force-material textures etc.)
surfaces generic surface textures
terrain textures used for terrain blending
towns textures for 'town' theme
blackmap.tga simple black texture
checker.tga common checker texture for testing UV distortions

[edit] models/

captives 3d captive models
enemies test 3d models of enemies
enviro models used in environment scripts
fx various models used in special effects
items item models
mapobjects models to be used on levels
maps specific prop models created for levels (such as terrains)
new all new models to be approved (and get texture and material created) goes here
plants Foliage models, such as grass
teststuff all test-only stuff (not exported to game's installer)
traps models to be used on various traps
weapons weapon models
cube.mdl 4x4 units cube model
null.mdl model with no geometry
point.mdl a sphere with an arrow (used for testun purposes)
Retrieved from "http://omnicide.razorwind.ru/wiki/index.php?title=Repository_Reference/Repository_structure_in-depth&oldid=3630"
Personal tools
Namespaces

Variants
Actions
Navigation
Toolbox