VsWiki - User contributions [en]

HowTo:Checkout GIT

2010-12-25T14:30:28Z

Breese: Removed boost 1.28

This page describes how to use GIT with the Vega Strike SVN repository.

[http://git-scm.com/ GIT] is a distributed sourcecode revision control system, which allows you to commit changes to a local repository and from there commit the changes to the remove Vega Strike SVN repository.
This is useful if you want to experiment with the codebase, or if you do not have commit privileges to the Vega Strike SVN repository.

If you are unfamiliar with GIT, the you should start by reading the [https://git.wiki.kernel.org/index.php/GitSvnCrashCourse GIT SVN Crash Course].

== Installation ==
First you need to install the GIT and GIT-SVN packages. How you do this, depends on your system.

See the [http://book.git-scm.com/2_installing_git.html chapter 2] in the GIT Book.

== Set up ==
After installing the two packages above, you have to set up a local git repository for the Vega Strike codebase.

Normally git-svn will copy the full svn repository, that is all revisions of all files.
This takes takes a long time, and as you seldomly need the full history, you can instead copy from a given revision onwards.

This command will only copy the most recent revision. If you want the full history, remove the "-rHEAD" option:
<pre>
git svn clone -rHEAD https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/vegastrike/
</pre>

Next you need to handle svn:externals. You can find them with "git svn show-externals". There may be a better way using git submodules, but this works.
<pre>
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_35_0/boost/ boost/1_35/boost
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_35_0/libs/python/src/ boost/1_35/src
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_45_0/boost/ boost/1_45/boost
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_45_0/libs/python/src/ boost/1_45/src
</pre>

We recommend that you add the following lines to your .gitignore file, which should be created in the same directory as the .git directory is located.
<pre>
boost/1_35
boost/1_45
boost_patched_gcc44
</pre>
You may also want to add auto-generated files to .gitignore.

Now you are almost ready to work on the codebase. You just need to create a branch to work on. This will make it easier to keep your local GIT repository synchonized with the remote SVN repository.

git branch ''insert-your-branch-name''
git checkout ''insert-your-branch-name''

Replace ''insert-your-branch-name'' with the name that you want to call your branch.

From here on, you can follow the normal build instructions.

== Synchonize with SVN ==
If others commit changes to the remote SVN repository, you can update your local GIT repository as follows.

Make sure that you have committed all your changes to the local GIT repository before you start synchronizing.

First you need to update the trunk of your local GIT repository with the changes from the remote SVN repository.

git checkout master
git svn rebase

Next you can synchronize your branch with the trunk.

git checkout ''insert-your-branch-name''
git pull . master

== Submit your changes ==
The "git commit" operation only commits your changes to your local GIT repository. When you want to submit your changes to the remote SVN repository, then you have two options.
If you have commit privileges to the Vega Strike SVN repository, then you can use the "git svn dcommit" command. Otherwise you have to submit a patch to the Vega Strike forums.

You can either use

git diff --no-prefix master..''insert-your-branch-name'' > mypatch.diff

Better yet, you can use the following bash script, which will make sure that the output looks like an SVN patch.
<pre>
#!/bin/sh
#
# git-svn-diff
# Generate an SVN-compatible diff against the tip of the tracking branch
TRACKING_BRANCH=`git config --get svn-remote.svn.fetch | sed -e 's/.*:refs\/remotes\///'`
REV=`git svn find-rev $(git rev-list --date-order --max-count=1 $TRACKING_BRANCH)`
git diff --no-prefix $(git rev-list --date-order --max-count=1 $TRACKING_BRANCH) $* |
sed -e "s/^+++ .*/& (working copy)/" -e "s/^--- .*/& (revision $REV)/" \
-e "s/^diff --git [^[:space:]]*/Index:/" \
-e "s/^index.*/===================================================================/"
</pre>
For a more complete script see [https://gist.github.com/710219 git-svn-diff.sh].

HowTo:Checkout GIT

2010-12-25T12:36:56Z

Breese: Upgraded to boost 1.45

This page describes how to use GIT with the Vega Strike SVN repository.

[http://git-scm.com/ GIT] is a distributed sourcecode revision control system, which allows you to commit changes to a local repository and from there commit the changes to the remove Vega Strike SVN repository.
This is useful if you want to experiment with the codebase, or if you do not have commit privileges to the Vega Strike SVN repository.

If you are unfamiliar with GIT, the you should start by reading the [https://git.wiki.kernel.org/index.php/GitSvnCrashCourse GIT SVN Crash Course].

== Installation ==
First you need to install the GIT and GIT-SVN packages. How you do this, depends on your system.

See the [http://book.git-scm.com/2_installing_git.html chapter 2] in the GIT Book.

== Set up ==
After installing the two packages above, you have to set up a local git repository for the Vega Strike codebase.

Normally git-svn will copy the full svn repository, that is all revisions of all files.
This takes takes a long time, and as you seldomly need the full history, you can instead copy from a given revision onwards.

This command will only copy the most recent revision. If you want the full history, remove the "-rHEAD" option:
<pre>
git svn clone -rHEAD https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/vegastrike/
</pre>

Next you need to handle svn:externals. You can find them with "git svn show-externals". There may be a better way using git submodules, but this works.
<pre>
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_28_0/boost/boost/ boost/1_28/boost
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_28_0/boost/libs/python/src/ boost/1_28/src
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_35_0/boost/ boost/1_35/boost
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_35_0/libs/python/src/ boost/1_35/src
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_45_0/boost/ boost/1_45/boost
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_45_0/libs/python/src/ boost/1_45/src
</pre>

We recommend that you add the following lines to your .gitignore file, which should be created in the same directory as the .git directory is located.
<pre>
boost/1_28
boost/1_35
boost/1_45
boost_patched_gcc44
</pre>
You may also want to add auto-generated files to .gitignore.

Now you are almost ready to work on the codebase. You just need to create a branch to work on. This will make it easier to keep your local GIT repository synchonized with the remote SVN repository.

git branch ''insert-your-branch-name''
git checkout ''insert-your-branch-name''

Replace ''insert-your-branch-name'' with the name that you want to call your branch.

From here on, you can follow the normal build instructions.

== Synchonize with SVN ==
If others commit changes to the remote SVN repository, you can update your local GIT repository as follows.

Make sure that you have committed all your changes to the local GIT repository before you start synchronizing.

First you need to update the trunk of your local GIT repository with the changes from the remote SVN repository.

git checkout master
git svn rebase

Next you can synchronize your branch with the trunk.

git checkout ''insert-your-branch-name''
git pull . master

== Submit your changes ==
The "git commit" operation only commits your changes to your local GIT repository. When you want to submit your changes to the remote SVN repository, then you have two options.
If you have commit privileges to the Vega Strike SVN repository, then you can use the "git svn dcommit" command. Otherwise you have to submit a patch to the Vega Strike forums.

You can either use

git diff --no-prefix master..''insert-your-branch-name'' > mypatch.diff

Better yet, you can use the following bash script, which will make sure that the output looks like an SVN patch.
<pre>
#!/bin/sh
#
# git-svn-diff
# Generate an SVN-compatible diff against the tip of the tracking branch
TRACKING_BRANCH=`git config --get svn-remote.svn.fetch | sed -e 's/.*:refs\/remotes\///'`
REV=`git svn find-rev $(git rev-list --date-order --max-count=1 $TRACKING_BRANCH)`
git diff --no-prefix $(git rev-list --date-order --max-count=1 $TRACKING_BRANCH) $* |
sed -e "s/^+++ .*/& (working copy)/" -e "s/^--- .*/& (revision $REV)/" \
-e "s/^diff --git [^[:space:]]*/Index:/" \
-e "s/^index.*/===================================================================/"
</pre>
For a more complete script see [https://gist.github.com/710219 git-svn-diff.sh].

HowTo:Checkout GIT

2010-12-24T12:01:49Z

Breese: Submit

This page describes how to use GIT with the Vega Strike SVN repository.

[http://git-scm.com/ GIT] is a distributed sourcecode revision control system, which allows you to commit changes to a local repository and from there commit the changes to the remove Vega Strike SVN repository.
This is useful if you want to experiment with the codebase, or if you do not have commit privileges to the Vega Strike SVN repository.

If you are unfamiliar with GIT, the you should start by reading the [https://git.wiki.kernel.org/index.php/GitSvnCrashCourse GIT SVN Crash Course].

== Installation ==
First you need to install the GIT and GIT-SVN packages. How you do this, depends on your system.

See the [http://book.git-scm.com/2_installing_git.html chapter 2] in the GIT Book.

== Set up ==
After installing the two packages above, you have to set up a local git repository for the Vega Strike codebase.

Normally git-svn will copy the full svn repository, that is all revisions of all files.
This takes takes a long time, and as you seldomly need the full history, you can instead copy from a given revision onwards.

This command will only copy the most recent revision. If you want the full history, remove the "-rHEAD" option:
<pre>
git svn clone -rHEAD https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/vegastrike/
</pre>

Next you need to handle svn:externals. You can find them with "git svn show-externals". There may be a better way using git submodules, but this works.
<pre>
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_28_0/boost/boost/ boost/1_28/boost
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_28_0/boost/libs/python/src/ boost/1_28/src
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_35_0/boost/ boost/1_35/boost
git svn clone -rHEAD http://svn.boost.org/svn/boost/tags/release/Boost_1_35_0/libs/python/src/ boost/1_35/src
</pre>

We recommend that you add the following lines to your .gitignore file, which should be created in the same directory as the .git directory is located.
<pre>
boost/1_28
boost/1_35
boost_patched_gcc44
</pre>
You may also want to add auto-generated files to .gitignore.

Now you are almost ready to work on the codebase. You just need to create a branch to work on. This will make it easier to keep your local GIT repository synchonized with the remote SVN repository.

git branch ''insert-your-branch-name''
git checkout ''insert-your-branch-name''

Replace ''insert-your-branch-name'' with the name that you want to call your branch.

From here on, you can follow the normal build instructions.

== Synchonize with SVN ==
If others commit changes to the remote SVN repository, you can update your local GIT repository as follows.

Make sure that you have committed all your changes to the local GIT repository before you start synchronizing.

First you need to update the trunk of your local GIT repository with the changes from the remote SVN repository.

git checkout master
git svn rebase

Next you can synchronize your branch with the trunk.

git checkout ''insert-your-branch-name''
git pull . master

== Submit your changes ==
The "git commit" operation only commits your changes to your local GIT repository. When you want to submit your changes to the remote SVN repository, then you have two options.
If you have commit privileges to the Vega Strike SVN repository, then you can use the "git svn dcommit" command. Otherwise you have to submit a patch to the Vega Strike forums.

You can either use

git diff --no-prefix master..''insert-your-branch-name'' > mypatch.diff

Better yet, you can use the following bash script, which will make sure that the output looks like an SVN patch.
<pre>
#!/bin/sh
#
# git-svn-diff
# Generate an SVN-compatible diff against the tip of the tracking branch
TRACKING_BRANCH=`git config --get svn-remote.svn.fetch | sed -e 's/.*:refs\/remotes\///'`
REV=`git svn find-rev $(git rev-list --date-order --max-count=1 $TRACKING_BRANCH)`
git diff --no-prefix $(git rev-list --date-order --max-count=1 $TRACKING_BRANCH) $* |
sed -e "s/^+++ .*/& (working copy)/" -e "s/^--- .*/& (revision $REV)/" \
-e "s/^diff --git [^[:space:]]*/Index:/" \
-e "s/^index.*/===================================================================/"
</pre>
For a more complete script see [https://gist.github.com/710219 git-svn-diff.sh].

HowTo:Checkout GIT

2010-12-24T11:43:58Z

Breese: Synchronize

HowTo:Checkout GIT

2010-12-24T11:29:33Z

Breese: Initial version

HowTos

2010-12-24T11:04:47Z

Breese: Added git

{{Languages|En|HowTos}}
{{Wiki_Nav_Index}}
__FORCETOC__
= Game HowTos =
== Modeling ==
''This series of How-to articles is intended to take you through the full process of creating a model and adding it to Vega Strike.''
* [[HowTo:Add Ships|Adding your ship to Vega Strike]] - An overview of how to create and add ships to the game
** [[HowTo:Create Models]] - A summary on how to create a new model for Vega Strike
*** [[HowTo:Model a Ship|Brad Mick's video tutorial on ship modelling]] - using Lightwave, but the concept is general: ''Rapid Prototyping''
*** [[HowTo:Create Ships in Wings3D|Creating a 3D-model using Wings3D]] - includes general guidance for other modeling programs
*** [[HowTo:Basic Blender Tutorial|A basic Blender3D tutorial]] - not specific to ships, though...
** [[HowTo:Smooth Groups|Understanding "Smooth Groups"]] - a Blender tutorial on splitting smooth groups...
** [[HowTo:Bevel|Getting bevels to look good]] - a Blender tutorial on smooth shading and beveling...
** [[HowTo:Weld|Smoothly Welding complex shapes]] - a Blender tutorial on smooth welding...
** [[HowTo:Unwrap|Unwrapping your model]] - How to UV-map your ship so it can be textured
*** [[HowTo:Unwrap in Blender|Using Blender to unwrap your model]] - A blender UV-mapping tutorial
*** [[HowTo:FullUnwrapBlender|Full ship unwrap tutorial (Blender)]] - Full ship UV unwrap, from A to Z
** [[HowTo:Texture|Creating your own textures]] - A summary on how to make texture maps
*** [[HowTo:Texture in Wings3d|Texturing your model in Wings 3d]]
*** [http://web.archive.org/web/20040310195543/http://netzwelt.gaming-hut.de/vegatexturing/ WIP VegaStrike texturing page by Major] (web archive)
*** [http://edice.netfirms.com/tuts/texturetut.htm Texturing tutorial by Duality]
*** [[HowTo:SuperrealisticTexturing|Tips for realistic-looking textures]]
*** [[HowTo:Make Animated Textures|Using animated textures on a model]]
** [[HowTo:Edit BFXM files|Editing BFXM files (format spec)]]
*** [[HowTo:Edit XMESH files|Editing the xmesh file of a ship]]
*** [[HowTo:Add LODs|Adding Levels of Detail]]
*** [[HowTo:Add Engine Glow|Adding an engine glow to your 3D model]]
*** [[HowTo:Add Per Pixel Lighting|Adding per-pixel lighting to your 3D model]]
** [[HowTo:Edit units.csv|Editing units.csv]]
*** [[HowTo:Edit Unit Files|Editing the xunit file of a ship]] - Deprecated, but can be converted easily to .csv format
=== Advanced Topics ===
* [[HowTo:Edit HUDs|Editing HUDs, placing radars, ...]]
* [[HowTo:Create Cockpit in Wings3d|Creating a 3D cockpit for your ship.]]
=== New Stuff (The Shaders Age begins...) ===
* [[HowTo:IntroToShaders|Introduction to shaders, and what they mean for you]] --Bumpmaps, Normalmaps, Shininess maps ...

==Artwork ==
''Artwork related Howtos''
* [[HowTo:Radiosity baking in Blender|Radiosity baking in Blender]]

== MODs ==
* [[HowTo:MOD|You want to create your own mod for VS? Start here.]]

=Sourcecode HowTos =
== Obtain a copy of the development-version files ==
* [[HowTo:Checkout SVN|Checkout Vega Strike's Subversion (SVN) modules.]]
* [[HowTo:Checkout SVN (Ubuntu Linux)|Checkout Vega Strike's Subversion (SVN) modules in Ubuntu.]]
* [[HowTo:Checkout SVNMac|Checkout Vega Strike's Subversion (SVN) modules on Mac OSX.]]
* [[HowTo:Checkout GIT|Use GIT to work on the Vega Strike Subversion (SVN) modules.]]
* [[HowTo:Checkout CVS|Checkout Vegastrike CVS modules with various programs.]] - '''Deprecated'''
'''NOTE: Vegastrike development has moved to SVN. CVS is still theoretically accessible, but the repository is months out of date and will never be updated again. There is no reason not to use Subversion instead.'''
* [[Moving data4.x to data]] - We recently (on May 1, 2008) moved the data4.x repository to "data". This has instructions on how to update your repository without checking out everything again.

== Compile the Vega Strike sourcecode ==
* [[HowTo:VCPP Compiling|Compiling from SVN under Visual C++]]
* [[HowTo:Cygwin Compiling|Compiling from SVN under Cygwin]] (may not work--enter at your own risk)
* [[HowTo:Compile from CVS|Compiling from SVN under your favourite Unixlike OS]]
* [[HowTo:Compile on OSX|Compiling from SVN on Mac OSX]]
* [[HowTo:Compile_from_released_source|Compiling from the released source]]
* Debug a Vega Strike Compilation
** [[HowTo:Use GDB|Debugging on your Unixlike OS using GDB]]
** [[HowTo:Use Dr Watson|Debugging on Windows using Dr Watson]]

= Miscellaneous HowTos =
*[[HowTo:Contribute|The Vega Strike Contributor's Guide]]
* [[HowTo:Install Wings3d|Installing Wings 3D and the Xmesh Plugin]] (deprecated)

=See Also=
* [[FAQ:Installing|Installing]]
* [[Development]]
* For related tools see the [[Links]] section.
[[Category:HowTos]]