Repository Reference/Introduction
From Blood Wiki
(Difference between revisions)
(→Looking around) |
(→Getting a working copy) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{navigation title|}} | {{navigation title|}} | ||
| − | Blood Omnicide repository stores all files needed for the development process. It contains game files, media, sourcecodes, useful tools and other helpful stuff that makes life easier | + | {{grammar checked|darth}} |
| + | Blood Omnicide repository stores all files needed for the development process. It contains game files, media, sourcecodes, useful tools and other helpful stuff that makes life easier when working on various aspects of the game. Blood Omnicide repository stores project at its very latest development state and all previous versions. | ||
| − | Before you start working with Blood Omnicide repository, be sure to learn how version control systems | + | Before you start working with Blood Omnicide repository, be sure to learn how version control systems works and particulary [http://en.wikipedia.org/wiki/Apache_Subversion subversion]. |
==Getting a working copy== | ==Getting a working copy== | ||
This is actually first step on work with Blood Omnicide repository - get a working copy of the repository. | This is actually first step on work with Blood Omnicide repository - get a working copy of the repository. | ||
| − | Install SVN client (for Windows [http://tortoisesvn.net/ TortoiseSVN] | + | Install SVN client (for Windows [http://tortoisesvn.net/ TortoiseSVN] is recommended). For executing '''svn checkout''' command you only need to get repository address, password is not required. |
| − | {{Important|Make sure path to working copy folder is nice and | + | {{Important|Make sure path to working copy folder is nice and doesn't contain non-latin characters and whitespaces:}} |
| − | <font color= | + | <font color=red>// Wrong</font> |
c:\Documents and Settings\Администратор\Desktop\Blood Omnicide Repository | c:\Documents and Settings\Администратор\Desktop\Blood Omnicide Repository | ||
<font color=green>// Correct</font> | <font color=green>// Correct</font> | ||
c:\OmnicideSVN | c:\OmnicideSVN | ||
| − | Downloading full working copy takes about | + | Downloading full working copy takes about 4GB of bandwidth. Downloaded working copy takes about 10GB, make sure you have at least double of that as it will grow up with time. |
| + | {{Important|By default checkout will download all stuff of svn, including base game and optional DLC packages. In order to reduce download size you can exclude '''kain_dlc''' folder from being downloaded by pressing "Choose items..." button in "Checkout Depth" group of Checkout window. Also you can exclude "misc" and "devkit" folder if you only planning to test stuff. If you are updating SVN, you can set the checkout depth in "Update to Revision" menu.}} | ||
{{Tip|Download can be stopped and resumed at any time}} | {{Tip|Download can be stopped and resumed at any time}} | ||
==Looking around== | ==Looking around== | ||
| − | Once download is completed, you will see | + | Once download is completed, you will see: |
<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"> | ||
| Line 41: | Line 43: | ||
| '''kain_make''' | | '''kain_make''' | ||
| installation scripts and scripts to build release version of the game. | | installation scripts and scripts to build release version of the game. | ||
| + | |- | ||
| + | | [[File:Icon folder.png|16px|alt=|link=]] | ||
| + | | '''kain_dlc''' | ||
| + | | gamedir storing additional downloadable content. | ||
|- | |- | ||
| [[File:Icon folder.png|16px|alt=|link=]] | | [[File:Icon folder.png|16px|alt=|link=]] | ||
| Line 49: | Line 55: | ||
| '''misc''' | | '''misc''' | ||
| help files, icons, map shots etc. | | help files, icons, map shots etc. | ||
| + | |- | ||
| + | | [[File:Icon file.png|16px|alt=|link=]] | ||
| + | | '''gpl.txt''' | ||
| + | | GNU GPL v2 license | ||
| + | |- | ||
| + | | [[File:Icon omnicide.png|16px|alt=|link=]] | ||
| + | | '''launch.exe''' | ||
| + | | Blood Omnicide launcher | ||
| + | |- | ||
| + | | [[File:Icon omnicide.png|16px|alt=|link=]] | ||
| + | | '''omnicide.exe''' | ||
| + | | Blood Omnicide game executable | ||
| + | |- | ||
| + | | [[File:Icon omnicide.png|16px|alt=|link=]] | ||
| + | | '''omnicide-dev.exe''' | ||
| + | | Blood Omnicide development-only executable (has raised entity limits) | ||
|} | |} | ||
</div> | </div> | ||
{{navigation footer|Key Concepts}} | {{navigation footer|Key Concepts}} | ||
| + | {{finished}} | ||
Latest revision as of 15:33, 1 September 2013
Blood Omnicide repository stores all files needed for the development process. It contains game files, media, sourcecodes, useful tools and other helpful stuff that makes life easier when working on various aspects of the game. Blood Omnicide repository stores project at its very latest development state and all previous versions.
Before you start working with Blood Omnicide repository, be sure to learn how version control systems works and particulary subversion.
[edit] Getting a working copy
This is actually first step on work with Blood Omnicide repository - get a working copy of the repository.
Install SVN client (for Windows TortoiseSVN is recommended). For executing svn checkout command you only need to get repository address, password is not required.
Important: Make sure path to working copy folder is nice and doesn't contain non-latin characters and whitespaces:// Wrong c:\Documents and Settings\Администратор\Desktop\Blood Omnicide Repository // Correct c:\OmnicideSVN
Downloading full working copy takes about 4GB of bandwidth. Downloaded working copy takes about 10GB, make sure you have at least double of that as it will grow up with time.
Important: By default checkout will download all stuff of svn, including base game and optional DLC packages. In order to reduce download size you can exclude kain_dlc folder from being downloaded by pressing "Choose items..." button in "Checkout Depth" group of Checkout window. Also you can exclude "misc" and "devkit" folder if you only planning to test stuff. If you are updating SVN, you can set the checkout depth in "Update to Revision" menu.Tip: Download can be stopped and resumed at any time
[edit] Looking around
Once download is completed, you will see:
|
bin32 | game binaries for x86 platform |
|
|
bin64 | game binaries for x64 platform |
|
|
devkit | game sourcecodes and tools |
|
|
kain | gamedir storing all of Blood Omnicide files (textures, maps, scripts etc.) |
|
|
kain_make | installation scripts and scripts to build release version of the game. |
|
|
kain_dlc | gamedir storing additional downloadable content. |
|
|
mapeditor | level editor |
|
|
misc | help files, icons, map shots etc. |
|
gpl.txt | GNU GPL v2 license |
|
launch.exe | Blood Omnicide launcher |
|
|
omnicide.exe | Blood Omnicide game executable |
|
|
omnicide-dev.exe | Blood Omnicide development-only executable (has raised entity limits) |
Next chapter: Key Concepts
Back to index | Top of the page
