[Planeshift-cvs] CVS: planeshift/docs compiling-visualc.txt,1.9,1.10 history.txt,1.2957,1.2958

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Update of /cvsroot/planeshift/planeshift/docs
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7632

Modified Files:
	compiling-visualc.txt history.txt 
Log Message:
Update of compiling-visualc.txt

Index: compiling-visualc.txt
===================================================================
RCS file: /cvsroot/planeshift/planeshift/docs/compiling-visualc.txt,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -d -r1.9 -r1.10
*** compiling-visualc.txt	28 Jul 2005 22:42:15 -0000	1.9
--- compiling-visualc.txt	29 Sep 2005 06:36:43 -0000	1.10
***************
*** 1,9 ****
  Planeshift Guide To Compiling with Microsoft Visual Studio
  ========================================== 
! By Chris Ayers, based on
! Planeshift Guide To Compiling with MinGW32 by Steve Cook
! Updated by Arianna Benigno (22/03/2005)

- This guide lists the steps necessary to download all the tools and compile Planeshift. This guide assumes that Visual C++.NET or  Visual Studio.NET is installed.  Some tools need glut, Directx 9 SDK,  and python. These features are not needed so they won't be covered here. As a result there will be some compilation errors do to missing files.   

  1. Tools Download
--- 1,14 ----
  Planeshift Guide To Compiling with Microsoft Visual Studio
  ========================================== 
! By Chris Ayers, based on Planeshift Guide To Compiling with MinGW32 by Steve Cook
! Updated by Arianna Benigno (29/09/2005)
! 
! This guide lists the steps necessary to download all the tools and compile Planeshift. This guide assumes 
! that Visual C++.NET or Visual Studio.NET is installed. Some tools need glut, Directx 9 SDK, and python. 
! These features are not needed so they won't be covered here. As a result there will be some compilation 
! errors do to missing files.
! 
! BE CAREFUL: AT THE MOMENT (29/09/2005) PLANESHIFT TEAM IS DEVELOPING USING CS and CEL FROM the 5th of SEPTEMBER!   

  1. Tools Download
***************
*** 13,23 ****
  ---------------------------------------------  

! WinCVS is a free version control system that links to the source files for Planeshift and it's libraries at SourceForge.net and allows you to easily download and update the current version of all source code files.  

! At the time of this howto, I recommend the WinCVS 1.3.20 beta 20 (build3) full installer. There are problems with version 1.2.

! 2. Libraries Download
! =====================  

  A) Configure WinCVS 
--- 18,30 ----
  ---------------------------------------------  

! WinCVS is a free version control system that links to the source files for Planeshift and it's libraries at 
! SourceForge.net and allows you to easily download and update the current version of all source code files.  

! At the time of this guide, I recommend the WinCVS 1.3.20 beta 20 (build3) full installer. 
! There are problems with version 1.2.

! 2. Sourcecodes and Libraries Download
! ===================================== 

  A) Configure WinCVS 
***************
*** 25,31 ****

  The first step is to create a directory structure for the library files. Create a root directory for the project.
! (this guide will assume you use C:\development\ as your root directory)

! Run WinCVS. Click "Admin.. Preferences" from the menu if the preferences window is not already open.
  Enter the following information in the dialog box:

--- 32,40 ----

  The first step is to create a directory structure for the library files. Create a root directory for the project.
! This guide will assume you use C:\development\ as your root directory, but if you want to use another one
! just substitute C:\development\ with your choice.

! Run WinCVS. Select the "Admin" menu and then "Preferences" from the menu if the preferences window is not already
! open.
  Enter the following information in the dialog box:

***************
*** 34,40 ****
  (On the CVS tab) [HOME folder (where cvs stores your passwords)] C:\development

! Click OK. Select "View.. Browse Location.. Change" from the menu and select the C:\development directory.
! Click OK, then select "View.. Browse Location.. Save Settings" to save this default.
! You should now see your empty directory structure on the left hand window.

--- 43,50 ----
  (On the CVS tab) [HOME folder (where cvs stores your passwords)] C:\development

! Click OK. Select the menu "View", and then "Browse Location" and select "Change" from the menu. Select the
! C:\development directory.
! Click OK, then select from the menu "View", again "Browse Location" and select "Save Settings" to save this default.
! You should now see your empty directory structure tree on the left hand window.

***************
*** 42,48 ****
  -----------------------------------------------------------

! Downloads ~100MB
! 
! Right-click on the development subdirectory and select "Checkout module" again.

  Local folder to checkout to must be C:\Development\
--- 52,56 ----
  -----------------------------------------------------------

! Right-click on the development subdirectory and select "Checkout module".

  Local folder to checkout to must be C:\Development\
***************
*** 52,55 ****
--- 60,67 ----
  Check CVSROOT and write next to it: :pserver:ano...@cv...:/cvsroot/crystal

+ Since you need to download a specific date of the code (05/09/2005) you have to click on the tab "Update Options",
+ then check "By Date" and on the right of the check box you will have available some white space where you can write
+ the date: 5 Sep 2005 should do it.
+ 
  click ok to start the download.

***************
*** 58,63 ****
  -------------------------------------------------------------------

- Downloads ~10MB
- 
  Right-click on the development subdirectory and select "Checkout module" again.

--- 70,73 ----
***************
*** 66,71 ****
  This time enter 'cel' as module name.

! Check CVSROOT and write next to it: :pserver:ano...@cv...:/cvsroot/cel

--- 76,84 ----
  This time enter 'cel' as module name.

! Since you need to download a specific date of the code (05/09/2005) you have to click on the tab "Update Options",
! then check "By Date" and on the right of the check box you will have available some white space where you can write 
! the date: 5 Sep 2005 should do it.

+ Check CVSROOT and write next to it: :pserver:ano...@cv...:/cvsroot/cel

***************
*** 73,78 ****
  ---------------------------------------------------

- Downloads ~40MB
- 
  Right-click on the development subdirectory and select "Checkout module" again.

--- 86,89 ----
***************
*** 88,101 ****
  -----------------------

! Download ~3MB
! 
! Rather than having to install CS dependant components manually, Microsoft Visual C++  6 & 7, MinGW/MSYS,
! and Cygwin users can download a single package which contains all common headers, pre-built library files,
! and dynamic link libraries in pre-compiled form from the Crystal Space website, http://www.crystalspace3d.org/

! Go to the downloads section and find the download link to the cs-win32libs. (it should be under the "External utilities and libraries" section).
! The link should be this ftp://sunsite.dk/projects/crystal/support/win32/

! Run the program and install the libraries. The Default name is fine. When it asks  you for the CS directory, enter C:\development\CS 
  You only need the VC Typical Setup.

--- 99,112 ----
  -----------------------

! Rather than having to install CS dependant components manually, Microsoft Visual C++  6 & 7, MinGW/MSYS, and Cygwin 
! users can download a single package which contains all common headers, pre-built library files,and dynamic link
! libraries in pre-compiled form from the Crystal Space website, http://www.crystalspace3d.org/

! Go to the downloads section and find the download link to the cs-win32libs. It should be under the "External
! utilities and libraries" section.
! The link should be this http://crystalspace3d.org/support/win32/

! Run the program and install the libraries. The Default name is fine. When it asks you for the CS directory, enter
! C:\development\CS 
  You only need the VC Typical Setup.

***************
*** 107,112 ****
  -----------------

- Download ~20MB
- 
  You need MySQL to run psserver, further instructions for this will follow.

--- 118,121 ----
***************
*** 117,133 ****
  Select the developers tab, then downloads. Click on MySQL 4.0 (release) and select the windows build to download.

! Run the setup program and install MySQL. (The defaults are fine)

  G) Download cURL
  -----------------

- Download ~1MB
- 
  cURL is needed to compile the new updater for PlaneShift.

! Download the cURL dev package (it contains the library and header files too).  http://curl.haxx.se/

  It doesn't matter if you pick with or without ssl. Unzip this into  C:\development\curl. 

  3. Compiling
--- 126,156 ----
  Select the developers tab, then downloads. Click on MySQL 4.0 (release) and select the windows build to download.

! Run the setup program and install MySQL. The defaults are fine.

  G) Download cURL
  -----------------

  cURL is needed to compile the new updater for PlaneShift.

! Download the cURL devel package (it contains the library and header files too) at http://curl.haxx.se/
! You have to select the Win32 - MSVC area, devel package.

  It doesn't matter if you pick with or without ssl. Unzip this into  C:\development\curl. 

+ H) Updating CS and CEL
+ ----------------------
+ 
+ If in the future you have the intentions to update CS and CEL, because the team has decided to use another date or 
+ because you feel like you want to update it, instead of doing a checkout you have simply to update.
+ 
+ Right Click on CS directory on your directory tree in WinCVS. Then select Update. Check "Missing directories that 
+ exist in repository" and select the "Update Options" tab. There, if you don't need to stick to a new date, simply
+ check "Reset any sticky tags/date/kopts".
+ If you also need to update CS to a specific date, please check "By date" and on the space on the right of the check
+ box specify the date in this format "day Month year", like 17 Aug 2005.
+ Then click "Ok" to start the update.
+ 
+ You have to do the same procedure with CEL, but this time you will have to right click, first, CEL directory on your 
+ directory tree in WinCVS.

  3. Compiling
***************
*** 137,142 ****
  --------------------------------

! Right-Click My Computer and choose Properties. Under Advanced choose Environmental Variables.
! Click New under either User or System variables depending on how you want it setup. If you choose System, you will have to log off to make the changes.
  Variable Name: CRYSTAL (all caps) Variable Value: C:\development\CS
  Variable Name: CEL (all caps) Variable Value: C:\development\cel
--- 160,166 ----
  --------------------------------

! Right-Click My Computer on your desktop and choose Properties. Under Advanced choose Environmental Variables.
! Click New under either User or System variables depending on how you want it setup. If you choose System, you will have
! to log off to make the changes.
  Variable Name: CRYSTAL (all caps) Variable Value: C:\development\CS
  Variable Name: CEL (all caps) Variable Value: C:\development\cel
***************
*** 145,152 ****
  ---------------------------------------------------

! Here we will add all the directories, containing all the include and lib files  that we will need to use during this compile.
!  Under Tools->Options look on the left hand side for the Projects folder. Under Projects choose "VC++ Directories". 
  In the Show Directories for: choose "Include Files". Add the following directories: (click the new folder icon) 
! C:\development\CS\include\csutil\win32 C:\mysql\include C:\development\cel\include C:\development\CS\include C:\development\curl\include

  In the Show Directories for: choose "Library Files". Add the following directories: (click the new folder icon) 
--- 169,178 ----
  ---------------------------------------------------

! Here we will add all the directories, containing all the include and lib files  that we will need to use during this
! compile.
! Under Tools->Options look on the left hand side for the Projects folder. Under Projects choose "VC++ Directories". 
  In the Show Directories for: choose "Include Files". Add the following directories: (click the new folder icon) 
! C:\development\CS\include\csutil\win32 C:\mysql\include C:\development\cel\include C:\development\CS\include 
! C:\development\curl\include

  In the Show Directories for: choose "Library Files". Add the following directories: (click the new folder icon) 
***************
*** 156,179 ****
  ------------------------------------

! Note. If you are using VC 7.1 or higher, you will need to convert the solution.
  Make sure that your 'msvc' folder has the 'read only' box unchecked before continuing.

! Open C:\development\CS\mk\msvc\wkstypical.sln with Visual Studio. Click 'yes to all' if asked to convert.

  Go into the 'Build' menu, and select 'configuration manager'. Change the 'Active Solution Configuration' to 'Debug'.

  Right click on the solution and select 'Build Solution'.
! To test the build of CS, run the walktest.exe in C:\development\CS If you encounter any errors,
! check you have done everything correctly, and then if the problem persists, you can ask for help on the CS channel:  irc.freenode.net #crystalspace

  D) Compile CEL
  --------------------------

! Note. If you are using VC 7.1 or higher, you will need to convert the solution.
  Make sure that your 'msvc' folder has the 'read only' box unchecked before continuing.

! Open C:\development\cel\msvc\wkscel.sln with Visual Studio.
! Click 'yes to all' if asked to convert.
  Build the solution.
  Just ignore any Python Errors. 

--- 182,208 ----
  ------------------------------------

! Note: if you are using VC 7.1 or higher, you will need to convert the solution.
  Make sure that your 'msvc' folder has the 'read only' box unchecked before continuing.

! If you have MSVC 6.0 open C:\development\CS\mk\msvc\wkstypical.dsw .
! If you have MSVC 7.0 or higher open C:\development\CS\mk\msvc\wkstypical.sln . Click 'yes to all' if asked to convert.

  Go into the 'Build' menu, and select 'configuration manager'. Change the 'Active Solution Configuration' to 'Debug'.

  Right click on the solution and select 'Build Solution'.
! To test the build of CS, run the walktest.exe in C:\development\CS.
! If you encounter any errors, check you have done everything correctly, and then if the problem persists, you can 
! ask for help on the CS channel:  irc.freenode.net #crystalspace

  D) Compile CEL
  --------------------------

! Note: if you are using VC 7.1 or higher, you will need to convert the solution.
  Make sure that your 'msvc' folder has the 'read only' box unchecked before continuing.

! If you have MSVC 6.0 open C:\development\cel\msvc\wkscel.dsw .
! If you have MSVC 7.0 or higher open C:\development\cel\msvc\wkscel.sln . Click 'yes to all' if asked to convert.
  Build the solution.
+ 
  Just ignore any Python Errors. 

***************
*** 181,187 ****
  ---------------------------------

! -If you have VS.NET 2003 open C:\development\planeshift\mk\visualc7.1\psall.sln with Visual Studio. 

! -If you have Visual Studio 6 open  C:\development\planeshift\mk\visualc6\psall.dsw with Visual Studio

  Do the following if you put mysql somewhere else than C:\mysql:
--- 210,216 ----
  ---------------------------------

! If you have MSVC.NET 2003/VC 7.1 open C:\development\planeshift\mk\visualc7.1\psall.sln . 

! If you have Visual Studio 6 open  C:\development\planeshift\mk\visualc6\psall.dsw .

  Do the following if you put mysql somewhere else than C:\mysql:
***************
*** 202,206 ****
  You should be good to go now.

! NOTE: you might have to copy all DLL files from your CEL directory  to your PlaneShift directory if you get problems related to CEL.  

  4. Getting the Server up
--- 231,236 ----
  You should be good to go now.

! NOTE: you might have to copy all DLL files from your CEL directory  to your PlaneShift directory if you get 
!       problems related to CEL.  

  4. Getting the Server up
***************
*** 236,241 ****
  ready

! NOTE: If you get any problems with psserver, make sure you have  the latest version of MySQL and that your libMySQL.dll file in  WINDOWS\system32 is the same as the one in mysql\lib\opt.
! 	If you want to investigate functions of psserver type help to get a list of all the available commands and a short of description of them.

  You should now be able to start psclient.exe and log in. 
--- 266,273 ----
  ready

! NOTE: If you get any problems with psserver, make sure you have  the latest version of MySQL and that your 
!       libMySQL.dll file in  WINDOWS\system32 is the same as the one in mysql\lib\opt.
!       If you want to investigate functions of psserver type help to get a list of all the available commands 
!       and a short of description of them.

  You should now be able to start psclient.exe and log in. 
***************
*** 246,256 ****

  5. Getting Help
!  =============== 

! If you have trouble getting any of this to work, please feel free to  contact me and I will do my best to help.

! Email: ca...@mc...  There is also an IRC channel dedicated to providing help with building PlaneShift.
  Server: irc.freenode.com
  Channel #PlaneShift-Build

! Chris
--- 278,288 ----

  5. Getting Help
! ================ 

! If you have trouble getting any of this to work, please feel free to contact me and I will do my best to help.

! Email: ari...@gm...  There is also an IRC channel dedicated to providing help with building PlaneShift.
  Server: irc.freenode.com
  Channel #PlaneShift-Build

! Arianna 

Index: history.txt
===================================================================
RCS file: /cvsroot/planeshift/planeshift/docs/history.txt,v
retrieving revision 1.2957
retrieving revision 1.2958
diff -C2 -d -r1.2957 -r1.2958
*** history.txt	28 Sep 2005 23:26:03 -0000	1.2957
--- history.txt	29 Sep 2005 06:36:43 -0000	1.2958
***************
*** 1,2 ****
--- 1,7 ----
+ *** 2005-09-29 by Arianna Benigno
+ - Update the guide for compiling with MSVC with instructions for the frozen 
+   date. If somebody has suggestions for improvement of the guide, please just 
+   tell me!
+ 
  *** 2005-09-28 by Andrew Craig
  - Some major changes in how the updater works. 