Editing Repository Reference/Repository structure in-depth

{{navigation title|}}
{{grammar}}
==User files==
User files are files created by user, depending of engine settigns, 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">
{|
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''data'''
| this directory is created and managed by engine, it stores savegames, edited files, temp files etc.
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''dds'''
| 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=]] 
| '''game'''
| game-related scripts (map scripts, gamemodel scripts etc.)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''gfx'''
| all 2d textures used for graphical user interface
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''glsl'''
| OpenGL GLSL shaders
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''locale'''
| this folder stores all locales
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''maps'''
| game levels and it's additional files (lights, sources, lightmaps etc.)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''models'''
| all game 3d models and textures for them/
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''music'''
| game music
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''particles'''
| textures used on particles
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''radiant'''
| textures and scripts used by leve leditor
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''scripts'''
| material scripts and client-side scripts such as menus, environments etc.
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''sound'''
| all game sounds
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''textures'''
| textures used on map surfaces (brushes, curves, terrains etc.)
|-
| [[File:Icon raw.png|16px|alt=|link=]] 
| '''csprogs.dat'''
| client-side compiled game logic
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''effectinfo.txt'''
| effects script
|-
| [[File:Icon archive.png|16px|alt=|link=]] 
| '''LEGACY0.PK3'''
| Blood Omen original files (created during installation)
|-
| [[File:Icon archive.png|16px|alt=|link=]] 
| '''LEGACY1.PK3'''
| Blood Omen sounds from demo version, this file only exist if installing PlayStation version of the game
|-
| [[File:Icon archive.png|16px|alt=|link=]] 
| '''LEGACY2.PK3'''
| Blood Omen FMV's (created during installation)
|-
| [[File:Icon archive.png|16px|alt=|link=]] 
| '''LEGACY3.PK3'''
| Blood Omen sprites DDS cache
|-
| [[File:Icon archive.png|16px|alt=|link=]] 
| '''PILL500.PK3'''
| generated textures DDS cache (see [[#Building a Game|Building a Game/Textures DDS cache]])
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''lightstyles.txt'''
| Lightstyles table
|-
| [[File:Icon raw.png|16px|alt=|link=]] 
| '''menu.dat'''
| compiled game logic for a menu
|-
| [[File:Icon raw.png|16px|alt=|link=]] 
| '''pill.big'''
| Blood Omen original file (copied during installation)
|-
| [[File:Icon raw.png|16px|alt=|link=]] 
| '''progs.dat'''
| compiled server-side game logic
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''quake.rc'''
| engine startup file
|}
</div>

===game/===
<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
{|
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''maps'''
| [[Map configuration script|map configuration scripts]], each file holds a script for particular map
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''models'''
| [[Gamemodel script|gamemodel scripts]]
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''default.cfg'''
| Defaut config file
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''engine.cfg'''
| Engine [[CFG|config file]]
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''omnicide.cfg'''
| Blood Omnicide-specific config file (loaded after engine config file)
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''world0.nsx'''
| [[Worldmap script|worldmap script]] for prologue game part
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''world0.nsx'''
| worldmap script for the present game part
|}
</div>

===textures/===
{{tip|Once development progressing, new themes get added.}}

<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
{|
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''common'''
| textures for [[Common materials|common materials]]
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''cellar'''
| textures for 'cellar' theme
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''crypt'''
| textures for 'crypt' theme
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''decals'''
| all decal textures
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''dungeon'''
| textures for 'dungeon' theme
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''envmaps'''
| environment maps and cubemaps used on materials for cubemap reflections and tcGen environment
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''liquids'''
| textures used for liquids - lava, water, swamp
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''mausoleum'''
| textures for 'mausoleum' theme
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''murals'''
| murals for spells, artifacts, events etc.
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''signboard'''
| textures for signboards
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''special'''
| special textures (overlays, force-material textures etc.)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''surfaces'''
| generic surface textures
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''terrain'''
| textures used for terrain blending
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''towns'''
| textures for 'town' theme
|-
| [[File:Icon texture.png|16px|alt=|link=]] 
| '''blackmap.tga'''
| simple black texture
|-
| [[File:Icon texture.png|16px|alt=|link=]] 
| '''checker.tga'''
| common checker texture for testing UV distortions
|}
</div>

===models/===
<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
{|
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''captives'''
| 3d captive models
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''enemies'''
| test 3d models of enemies
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''enviro'''
| models used in [[Environment script|environment scripts]]
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''fx'''
| various models used in special effects
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''items'''
| item models
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''mapobjects'''
| models to be used on levels
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''maps'''
| specific prop models created for levels (such as terrains)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''new'''
| all new models to be approved (and get texture and material created) goes here
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''plants'''
| Foliage models, such as grass
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''teststuff'''
| all test-only stuff (not exported to game's installer)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''traps'''
| models to be used on various traps
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''weapons'''
| weapon models
|-
| [[File:Icon raw.png|16px|alt=|link=]] 
| '''cube.mdl'''
| 4x4 units cube model
|-
| [[File:Icon raw.png|16px|alt=|link=]] 
| '''null.mdl'''
| model with no geometry
|-
| [[File:Icon raw.png|16px|alt=|link=]] 
| '''point.mdl'''
| a sphere with an arrow (used for testun purposes)
|}
</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>

==Development kit==
devkit/

<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
{|
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''bloodpill'''
| [[BloodPill|Blood Pill]] utility
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''cubemaps'''
| tools for making cubemaps
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''launcher'''
| source code for launcher
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''modelling'''
| tools for modelling (coverters, exporters)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''notepad++'''
| syntax highlight scripts for notepad++
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''other'''
| other tools
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''quakec'''
| game logic QuakeC sourcecode (client, server and menu)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''spr32edit'''
| Tool to edit sprites
|}
</div>

===devkit/modelling===
<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
{|
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''dpmwizard'''
| DPMWizard tool (make [[DPM]] models from Half-Life [[SMD]] models)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''gensurf'''
| An old tool to generate brush-based terrain from heightmaps or random noises.
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''plugins'''
| Import/Export plugins for various game formats used with Darkplaces engine.
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''plugins_src'''
| Source code for plugins.
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''qme'''
| Old program to edit [[MDL]] models.
|-
| [[File:Icon md3compiler.png|16px|alt=|link=]] 
| '''MD3Compiler.exe'''
| [[MD3 Compiler|NPherno's MD3 Compiler]]
|}
</div>

===devkit/quakec===
<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
{|
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''csprogs.dat'''
| QuakeC sources for client-side progs
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''menu.dat'''
| QuakeC sources for menu progs
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''progs.dat'''
| QuakeC sources for game progs (server game logic)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''shared'''
| Shared QuakeC code (libraries, systems)
|-
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''shared'''
| Shared QuakeC code (libraries, systems)
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''compile_csprogs.bat'''
| Script to compile client-side progs into '''kain/csprogs.dat'''
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''compile_menu.bat'''
| Script to compile menu progs into '''kain/menu.dat'''
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''compile_progs.bat'''
| Script to compile game progs into '''kain/progs.dat'''
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''fteqcc.exe'''
| FTEQCC QuakeC source compiler
|-
| [[File:Icon file.png|16px|alt=|link=]] 
| '''sourcescanner.exe'''
| SourceScanner - a tool to make level editor entity defs (mapeditor/kain.game/kain/entities.ent) from QuakeC source.
|}
</div>
{{navigation footer|}}

==Misc==
All misc files are stored in the '''misc/''' folder, there can be many subfolders there, but here we only list most useful.

<div style="border: 1px #999 dotted; padding: 8px; margin: 4px;vertical-align:bottom">
{|
| [[File:Icon folder.png|16px|alt=|link=]] 
| '''Balance and Docs'''
| various documents regarding original game, dialogue scripts, weapon damage listings etc.
|-
| '''Concept Art'''
| All concept art submitted to Blood Omnicide.
|-
| '''Graphics'''
| Various non-agme graphical files (logos, icons, site designs)
|}
</div>

{{finished}}