Difference between revisions of "HowTo:Checkout SVN (Ubuntu Linux)"

From VsWiki
Jump to: navigation, search
m (→‎Downloading Vega Strike: new repository localisation)
 
(50 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
This is a newb friendly guide to help people who do not want to learn deep specifics and terms. Most of this guide will show you copy-paste lines to paste in Terminal, omitting most technical issues. However, you might want to take a look at what SVN is to have a general understanding of this version. If you follow steps correctly, it should be able to work. ''If you have problems compiling in Ubuntu, post a new thread in the VS Forums (click here [http://vegastrike.sourceforge.net/forums/viewforum.php?f=5]). Someone will be able to help you.''
+
{{NAV_Manual |
−
Note: This process was done in Ubuntu 8.10 (Intrepid).
+
| previous=[[HowTo:Checkout SVN|Checkout SVN]]
 +
| up=[[HowTos]]
 +
| next=[[HowTo:VCPP Compiling|Compiling with VCPP]]
 +
}}
 +
----
  
−
== Installing SVN ==
+
This is a newb friendly guide to help people who do not want to learn ''deep'' specifics and terms. Most of this guide will show you copy-paste lines to paste in Terminal, omitting most technical issues. However, you might want to take a look at what SVN is to have a general understanding of this version. If you follow steps correctly, VS should be able to run. ''If you have problems compiling in Ubuntu, post a new thread in the [http://forums.vega-strike.org/viewforum.php?f=5|VS Forums]. Someone will be able to help you.''
−
The first step is to install Subversion. In Ubuntu (and Debian, I guess) it is easy to install Subversion just by using the Synaptic Package Manager. Goto System>Administration>Synaptic Package Manager. In the quick search box, type "subversion" without quotation marks. Select the first option and mark for installation. Every step involving the command "svn", will be using subversion.
+
Note: This process was done in Ubuntu 8.10 (Intrepid), though it might work in Debian as well. Should be able to work in the Ubuntu derivatives, too.
  
−
== Downloading VS ==
+
= Basic Tutorial to Download, Compile, Setup and Run Vega Strike =
−
First, you must understand some basic knowledge. The first thing to do is to download the most important modules, which are the basic structure of VS. Basically, this is the game. You must download these in order to play VS.
+
== Downloading Vega Strike ==
 +
=== Installing SVN ===
 +
The first step is to install '''S'''ub'''V'''ersio'''N'''. In Ubuntu (and Debian, I guess) it is easy to install Subversion just by using the Synaptic Package Manager (''Adept'' for Kubuntu). Goto System>Administration>Synaptic Package Manager. In the quick search box, type "subversion" without quotation marks. Select the first option and mark for installation. A window will appear that will show "Mark additional required changes?". Click on "Mark". After that, click on "Apply". Every step involving the command "svn", will be using subversion.
 +
 
 +
=== Preparing Vega Strike ===
 +
First of all, you must understand some basic knowledge. The first thing to do is to download the most important modules, which are the basic structure of VS. Basically, this is the game. You must download these in order to play VS. The modules are the ''data'' and ''vegastrike'' modules.
 +
 
 +
* First create a directory where you would like your copy of the Vega Strike development version to live in. For tutorial purposes, we will create a directory called ''VegaStrike'' in our user's home-directory.
 +
<pre>User@UserMachine:~$ mkdir VegaStrike</pre>
 +
* Change into this newly created directory. In our case:
 +
<pre>User@UserMachine:~$ cd VegaStrike</pre>
 +
Note for newbs: The directory '''is case sensitive'''. If you type: cd vegastrike or Vegastrike, it won't find the directory. Also, do not copy and paste "User@UserMachine:~$", or "User@UserMachine:~/VegaStrike/vegastrike$", or "User@UserMachine:~/VegaStrike/data$", or anything between "User@UserMachine:~" and the "$" letter. You know what I mean.
 +
 
 +
=== Downloading Vega Strike ===
 +
Now we can start downloading the packages from the SVN repository. If you download them directly into your Vega Strike directory they will be just in the right place.
 +
* Download (check-out) the source code package vegastrike, and the content package data package.
 +
<pre>User@UserMachine:~/VegaStrike$ svn co https://svn.code.sf.net/p/vegastrike/code/trunk/vegastrike
 +
</pre>
 +
* After the first one finishes downloading (User@UserMachine:~/VegaStrike$ will reappear), insert the next. Be warned, you need a descent download speed to download the next package with this method.
 +
<pre>User@UserMachine:~/VegaStrike$ svn co https://svn.code.sf.net/p/vegastrike/code/trunk/data</pre>
 +
This leaves you with two new directories inside your Vega Strike directory called as the packages are.
 +
 
 +
''Nota : svn repository has changed in 2013<br/>
 +
For information, these are the old repositories : ''
 +
<pre>
 +
svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/vegastrike
 +
svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/data
 +
</pre>
 +
 
 +
== Building ==
 +
You might not understand what building or compiling is, but that is not important. What ''is'' important is that you do it. Its really not that complicated, so here it goes.
 +
* First of all, we have to make sure we have certain minimum requirements. I could list you a dozen ''1337'' terms, but you don't certainly need to know them. We'll just make sure to have them all by inserting this into Terminal (copy and paste entire code into Terminal).
 +
<pre>sudo apt-get install libpng12-0 libpng12-dev python2.7-dev libexpat1-dev    \
 +
        libjpeg62-dev freeglut3-dev libopenal-dev libgtk2.0-dev libogg-dev libvorbis-dev \
 +
        build-essential libgl1-mesa-dev automake autoconf libsdl1.2-dev
 +
</pre>
 +
''Note that some recent distributions need python2.7-dev instead of python2.6-dev or python2.5-dev''
 +
 
 +
Xubuntu 12.04 also does not install cmake and libxmu-dev by default. You can get those with
 +
<pre>sudo apt-get install cmake libxmu-dev </pre>
 +
 
 +
=== Compiling ===
 +
The compile procedure should look like the following listing. Remember, the configure part depends on above requirements. Autotools is no longer supported, so we need to follow the instructions for cmake instead:
 +
 
 +
* Create a build directory somewhere outside of the source tree
 +
<pre>User@UserMachine:~/VegaStrike$ mkdir build</pre>
 +
* Run cmake <path to source tree> inside the build directory
 +
<pre>User@UserMachine:~/VegaStrike$ cd build
 +
User@UserMachine:~/VegaStrike/build$ cmake ../vegastrike
 +
</pre>
 +
* Compile. Make must be called from the build directory
 +
<pre>User@UserMachine:~/VegaStrike/build$ make</pre>
 +
* Install.
 +
<pre>sudo make install # [AS ROOT]</pre>
 +
Note: you may not need to install, VS will run fine where it's built, provided its data is in ../data (relative to the source). Ie: the way it normally checks out of SVN. Also, install may be broken right now, "make install" did not work for me after the above steps :(
 +
 
 +
== Running Vega Strike ==
 +
Just go to the directory ''vegastrike'' then run ./vssetup to setup the game options, then run ./vegastrike to start the game. If everything has gone well the main menu will appear where you can click on new campaign.
 +
 
 +
= Advanced Tutorials for less common or previously nessasary configurations and setups =
 +
 
 +
== Optional High Quality Texture Files ==
 +
*You can optionally install high quality texture files. You would place this folder next to the data folder (not ''inside''). So if data is in /home/USER/VegaStrike You would:
 +
<pre>sudo svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/hqtextures /home/USER/VegaStrike/hqtextures</pre>
 +
As always, replace USER with your user name. (Open text editor, paste above code, change USER for your user name, copy that code and paste in Terminal).
 +
 
 +
*After downloading these high quality texture files, go to your home folder (using GUI, not terminal), then to VegaStrike, then to data, and open ''vegastrike.config''. Then, using the ''find'' button, type "'''hq'''" (without quotations). Text editor will automatically find the string containing the configuration to enable HQ Textures. Just replace the following string
 +
<pre><!-- var name="hqtextures" value="hqtextures" --></pre>
 +
for this one
 +
<pre><var name="hqtextures" value="hqtextures"/></pre>
 +
* After this, close Terminal.
 +
 
 +
== Advanced Configuring Installation ==
 +
We need to make sure the data directory is *recognized*. For tutorial purposes, we will use the directory where we downloaded first in this tutorial.
 +
* Open text editor (Applications>Accessories>Text Editor), copy and paste the following code in text editor, change the USER in caps to the name of your user, and then paste in Terminal.
 +
<pre>./configure --with-data-dir=/home/USER/VegaStrike</pre>
 +
 
 +
* We need to configure Boost revision. Simply copy and paste code. This time, we will configure version 1.35.
 +
<pre>./configure --with-boost=1.35</pre>
 +
 
 +
== Advanced Make ==
 +
The final step compiling is the command make.
 +
* For ''example'', to compile the mesher.
 +
<pre>make mesher</pre>
 +
*You ''probably'' want to compile everything, so simply paste:
 +
<pre>make all</pre>
 +
*To use less memory usage while compiling use the following command. It is the same as the above command, except it will run only one instance instead of two in order to use less memory.
 +
<pre>make all-am</pre>
 +
*The next step is optional, but recommended.
 +
<pre>sudo make install</pre>
 +
 
 +
You might receive errors while doing any of the previous steps (make). If so, give privileges (sudo) before any of the commands.
 +
 
 +
== Advanced Setup ==
 +
The next step is to setup the game. This is quite easy to do, so you are almost done.
 +
 
 +
=== vegastrike and vssetup ===
 +
To run Vega Strike, the built executables need all the configuration and data files to be in the right place relative to them. Currently, the executables (''vegastrike'' and ''vssetup'') reside in the source code directory. But they can be run out of the ''data'' directory. Therefore, we will create a link.
 +
* Change in to the ''data'' directory. (We are still in the source code directory ''vegastrike''.)
 +
<pre>User@UserMachine:~/VegaStrike/vegastrike$ cd ../data</pre>
 +
* Create symbolic links to the executables in the source code directory.
 +
<pre>User@UserMachine:~/VegaStrike/data$ ln -s ../vegastrike/vegastrike vegastrike
 +
User@UserMachine:~/VegaStrike/data$ ln -s ../vegastrike/vssetup vssetup</pre>
 +
* After that, you must run "'''./vssetup'''" inside the '''data''' folder, or any folder which has the correct '''setup.config''' and '''vegastrike.config'''.
 +
If we had made copies or moved the files instead of symbolic linking, we would have to do the procedure of copying or moving every time we build the executables from source.
 +
 
 +
*Optionally, you can right-click the vegastrike link and make yet another link. This link can be moved over to the desktop or menu.
 +
 
 +
= Staying updated with the Development Version =
 +
As development progresses the repository changes. In order to update your working copy you need to do the following.
 +
* Open Terminal and change into the package's directory you want to update. In our tutorial example, all the packages were stored in a directory called ''VegaStrike''. Let's assume we want to update the ''data'' package.
 +
<pre>User@UserMachine:~$ cd VegaStrike/data</pre>
 +
* After changing into the package's directory, update the SVN repository.
 +
<pre>User@UserMachine:~/VegaStrike/data$ svn update</pre>
 +
 
 +
* To update the ''vegastrike'' package, simply return to the ''VegaStrike'' directory, then change to the ''vegastrike'' directory and update.
 +
<pre>User@UserMachine:~/VegaStrike/data$ cd ..</pre>
 +
then
 +
<pre>User@UserMachine:~/VegaStrike$ cd vegastrike</pre>
 +
finally
 +
<pre>User@UserMachine:~/VegaStrike/vegastrike$ svn update</pre>
 +
 
 +
* Do this for every package you want to update.
 +
* If something changed in the data package, you don't need to recompile.
 +
* If something changed in the source code package vegastrike, you only need to repeat the building part of this tutorial. You should not need to type "make clean", however if you experience errors like "unresolved external symbol" it may remedy that error.
 +
 
 +
= Troubleshooting =
 +
If you have trouble with compiz, try [http://forlong.blogage.de/entries/pages/Compiz-Switch this application] to temporarily disable compiz. Then, launch the game normally. The game will be much faster with compiz disabled, too.
 +
 
 +
If you have trouble with starting the game perhaps try to work through the generic instructions in case somthing is significantly different between them. Else ask for help on the fourms in the section named [http://forums.vega-strike.org/viewforum.php?f=1&sid=63de74c4da0aad85e3417b72509a6e8c User Help].
 +
 
 +
[[Category:fixme]]
 +
[[Category:HowTos|Checkout SVN (Ubuntu Linux)]]

Latest revision as of 23:50, 13 February 2014

arrow_left.png Checkout SVN arrow_up.png HowTos Compiling with VCPP arrow_right.png

This is a newb friendly guide to help people who do not want to learn deep specifics and terms. Most of this guide will show you copy-paste lines to paste in Terminal, omitting most technical issues. However, you might want to take a look at what SVN is to have a general understanding of this version. If you follow steps correctly, VS should be able to run. If you have problems compiling in Ubuntu, post a new thread in the Forums. Someone will be able to help you. Note: This process was done in Ubuntu 8.10 (Intrepid), though it might work in Debian as well. Should be able to work in the Ubuntu derivatives, too.

Basic Tutorial to Download, Compile, Setup and Run Vega Strike

Downloading Vega Strike

Installing SVN

The first step is to install SubVersioN. In Ubuntu (and Debian, I guess) it is easy to install Subversion just by using the Synaptic Package Manager (Adept for Kubuntu). Goto System>Administration>Synaptic Package Manager. In the quick search box, type "subversion" without quotation marks. Select the first option and mark for installation. A window will appear that will show "Mark additional required changes?". Click on "Mark". After that, click on "Apply". Every step involving the command "svn", will be using subversion.

Preparing Vega Strike

First of all, you must understand some basic knowledge. The first thing to do is to download the most important modules, which are the basic structure of VS. Basically, this is the game. You must download these in order to play VS. The modules are the data and vegastrike modules.

  • First create a directory where you would like your copy of the Vega Strike development version to live in. For tutorial purposes, we will create a directory called VegaStrike in our user's home-directory.
User@UserMachine:~$ mkdir VegaStrike
  • Change into this newly created directory. In our case:
User@UserMachine:~$ cd VegaStrike

Note for newbs: The directory is case sensitive. If you type: cd vegastrike or Vegastrike, it won't find the directory. Also, do not copy and paste "User@UserMachine:~$", or "User@UserMachine:~/VegaStrike/vegastrike$", or "User@UserMachine:~/VegaStrike/data$", or anything between "User@UserMachine:~" and the "$" letter. You know what I mean.

Downloading Vega Strike

Now we can start downloading the packages from the SVN repository. If you download them directly into your Vega Strike directory they will be just in the right place.

  • Download (check-out) the source code package vegastrike, and the content package data package.
User@UserMachine:~/VegaStrike$ svn co https://svn.code.sf.net/p/vegastrike/code/trunk/vegastrike
  • After the first one finishes downloading (User@UserMachine:~/VegaStrike$ will reappear), insert the next. Be warned, you need a descent download speed to download the next package with this method.
User@UserMachine:~/VegaStrike$ svn co https://svn.code.sf.net/p/vegastrike/code/trunk/data

This leaves you with two new directories inside your Vega Strike directory called as the packages are.

Nota : svn repository has changed in 2013
 For information, these are the old repositories : 

svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/vegastrike
svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/data

Building

You might not understand what building or compiling is, but that is not important. What is important is that you do it. Its really not that complicated, so here it goes.

  • First of all, we have to make sure we have certain minimum requirements. I could list you a dozen 1337 terms, but you don't certainly need to know them. We'll just make sure to have them all by inserting this into Terminal (copy and paste entire code into Terminal).
sudo apt-get install libpng12-0 libpng12-dev python2.7-dev libexpat1-dev     \
        libjpeg62-dev freeglut3-dev libopenal-dev libgtk2.0-dev libogg-dev libvorbis-dev \
        build-essential libgl1-mesa-dev automake autoconf libsdl1.2-dev

Note that some recent distributions need python2.7-dev instead of python2.6-dev or python2.5-dev

Xubuntu 12.04 also does not install cmake and libxmu-dev by default. You can get those with 

sudo apt-get install cmake libxmu-dev

Compiling

The compile procedure should look like the following listing. Remember, the configure part depends on above requirements. Autotools is no longer supported, so we need to follow the instructions for cmake instead:

  • Create a build directory somewhere outside of the source tree 
User@UserMachine:~/VegaStrike$ mkdir build
  • Run cmake <path to source tree> inside the build directory
User@UserMachine:~/VegaStrike$ cd build
User@UserMachine:~/VegaStrike/build$ cmake ../vegastrike
  • Compile. Make must be called from the build directory
User@UserMachine:~/VegaStrike/build$ make
  • Install.
sudo make install # [AS ROOT]

Note: you may not need to install, VS will run fine where it's built, provided its data is in ../data (relative to the source). Ie: the way it normally checks out of SVN. Also, install may be broken right now, "make install" did not work for me after the above steps :(

Running Vega Strike

Just go to the directory vegastrike then run ./vssetup to setup the game options, then run ./vegastrike to start the game. If everything has gone well the main menu will appear where you can click on new campaign.

Advanced Tutorials for less common or previously nessasary configurations and setups

Optional High Quality Texture Files

  • You can optionally install high quality texture files. You would place this folder next to the data folder (not inside). So if data is in /home/USER/VegaStrike You would: 
sudo svn co https://vegastrike.svn.sourceforge.net/svnroot/vegastrike/trunk/hqtextures /home/USER/VegaStrike/hqtextures

As always, replace USER with your user name. (Open text editor, paste above code, change USER for your user name, copy that code and paste in Terminal).

  • After downloading these high quality texture files, go to your home folder (using GUI, not terminal), then to VegaStrike, then to data, and open vegastrike.config. Then, using the find button, type "hq" (without quotations). Text editor will automatically find the string containing the configuration to enable HQ Textures. Just replace the following string
<!-- var name="hqtextures" value="hqtextures" -->

for this one 

<var name="hqtextures" value="hqtextures"/>
  • After this, close Terminal.

Advanced Configuring Installation

We need to make sure the data directory is *recognized*. For tutorial purposes, we will use the directory where we downloaded first in this tutorial.

  • Open text editor (Applications>Accessories>Text Editor), copy and paste the following code in text editor, change the USER in caps to the name of your user, and then paste in Terminal.
./configure --with-data-dir=/home/USER/VegaStrike
  • We need to configure Boost revision. Simply copy and paste code. This time, we will configure version 1.35.
./configure --with-boost=1.35

Advanced Make

The final step compiling is the command make.

  • For example, to compile the mesher.
make mesher
  • You probably want to compile everything, so simply paste:
make all
  • To use less memory usage while compiling use the following command. It is the same as the above command, except it will run only one instance instead of two in order to use less memory.
make all-am
  • The next step is optional, but recommended.
sudo make install

You might receive errors while doing any of the previous steps (make). If so, give privileges (sudo) before any of the commands.

Advanced Setup

The next step is to setup the game. This is quite easy to do, so you are almost done.

vegastrike and vssetup

To run Vega Strike, the built executables need all the configuration and data files to be in the right place relative to them. Currently, the executables (vegastrike and vssetup) reside in the source code directory. But they can be run out of the data directory. Therefore, we will create a link.

  • Change in to the data directory. (We are still in the source code directory vegastrike.)
User@UserMachine:~/VegaStrike/vegastrike$ cd ../data
  • Create symbolic links to the executables in the source code directory.
User@UserMachine:~/VegaStrike/data$ ln -s ../vegastrike/vegastrike vegastrike
User@UserMachine:~/VegaStrike/data$ ln -s ../vegastrike/vssetup vssetup
  • After that, you must run "./vssetup" inside the data folder, or any folder which has the correct setup.config and vegastrike.config.

If we had made copies or moved the files instead of symbolic linking, we would have to do the procedure of copying or moving every time we build the executables from source.

  • Optionally, you can right-click the vegastrike link and make yet another link. This link can be moved over to the desktop or menu.

Staying updated with the Development Version

As development progresses the repository changes. In order to update your working copy you need to do the following.

  • Open Terminal and change into the package's directory you want to update. In our tutorial example, all the packages were stored in a directory called VegaStrike. Let's assume we want to update the data package.
User@UserMachine:~$ cd VegaStrike/data
  • After changing into the package's directory, update the SVN repository.
User@UserMachine:~/VegaStrike/data$ svn update
  • To update the vegastrike package, simply return to the VegaStrike directory, then change to the vegastrike directory and update.
User@UserMachine:~/VegaStrike/data$ cd ..

then 

User@UserMachine:~/VegaStrike$ cd vegastrike

finally 

User@UserMachine:~/VegaStrike/vegastrike$ svn update
  • Do this for every package you want to update.
  • If something changed in the data package, you don't need to recompile.
  • If something changed in the source code package vegastrike, you only need to repeat the building part of this tutorial. You should not need to type "make clean", however if you experience errors like "unresolved external symbol" it may remedy that error.

Troubleshooting

If you have trouble with compiz, try this application to temporarily disable compiz. Then, launch the game normally. The game will be much faster with compiz disabled, too.

If you have trouble with starting the game perhaps try to work through the generic instructions in case somthing is significantly different between them. Else ask for help on the fourms in the section named User Help.

Retrieved from "https://wiki.vega-strike.org/mediawiki/index.php?title=HowTo:Checkout_SVN_(Ubuntu_Linux)&oldid=19636"