OpenUru - User contributions [en]

Build the client with MSVC 2010 Express

2020-09-15T05:51:57Z

Marten: /* Required source changes for Visual Studio 2010 Express */ - fix incorrect directory name

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code] - this does not include the Python code, which can be found in the [https://foundry.openuru.org/gitblit/summary/?r=MOULSCRIPT-ou.git MOULSCRIPT repo]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
Install PhysX SDK, and copy PhysX subdirectories as follows:
* Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
* Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE and perform the following steps:</li>
<ol style="list-style-type:lower-latin">
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project (e.g. "libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
</ol>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat the preceding steps for projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpngd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpng.lib''</li>
</ul>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib'' and rename it ''zlibd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ul>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"
* Change "DXGetErrorString9" to "DXGetErrorString"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp":
* Remove the "#include <dmusici.h>" line
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher\" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-29T18:49:45Z

Marten: /* Items needed to compile */ add link to MOULSCRIPT repo

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code] - this does not include the Python code, which can be found in the [https://foundry.openuru.org/gitblit/summary/?r=MOULSCRIPT-ou.git MOULSCRIPT repo]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
Install PhysX SDK, and copy PhysX subdirectories as follows:
* Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
* Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE and perform the following steps:</li>
<ol style="list-style-type:lower-latin">
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project (e.g. "libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
</ol>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat the preceding steps for projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpngd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpng.lib''</li>
</ul>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib'' and rename it ''zlibd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ul>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"
* Change "DXGetErrorString9" to "DXGetErrorString"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp":
* Remove the "#include <dmusici.h>" line
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-29T04:41:54Z

Marten: /* OpenAL SDK */ remove unnecessary bullet

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
Install PhysX SDK, and copy PhysX subdirectories as follows:
* Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
* Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE and perform the following steps:</li>
<ol style="list-style-type:lower-latin">
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project (e.g. "libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
</ol>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat the preceding steps for projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpngd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpng.lib''</li>
</ul>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib'' and rename it ''zlibd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ul>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"
* Change "DXGetErrorString9" to "DXGetErrorString"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp":
* Remove the "#include <dmusici.h>" line
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-29T04:41:23Z

Marten: /* PhysX SDK */ remove unnecessary level of indentation

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
Install PhysX SDK, and copy PhysX subdirectories as follows:
* Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
* Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE and perform the following steps:</li>
<ol style="list-style-type:lower-latin">
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project (e.g. "libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
</ol>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat the preceding steps for projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpngd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpng.lib''</li>
</ul>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib'' and rename it ''zlibd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ul>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"
* Change "DXGetErrorString9" to "DXGetErrorString"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp":
* Remove the "#include <dmusici.h>" line
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-29T04:40:19Z

Marten: /* Required source code changes for newer version of DirectX SDK */ make easier to read

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories as follows:
** Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
** Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE and perform the following steps:</li>
<ol style="list-style-type:lower-latin">
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project (e.g. "libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
</ol>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat the preceding steps for projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpngd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpng.lib''</li>
</ul>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib'' and rename it ''zlibd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ul>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"
* Change "DXGetErrorString9" to "DXGetErrorString"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp":
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp":
* Remove the "#include <dmusici.h>" line
* Change "#include <dxerr9.h>" to "#include <dxerr.h>"

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-29T04:38:13Z

Marten: /* zlib and libpng */ tidy up and correct the ending copy instructions

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories as follows:
** Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
** Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE and perform the following steps:</li>
<ol style="list-style-type:lower-latin">
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project (e.g. "libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
</ol>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat the preceding steps for projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpngd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/libpng15.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib'' and rename it ''libpng.lib''</li>
</ul>
<li>In the ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib'' folder, create a ''lib'' folder. Then:</li>
<ul>
<li>Copy ''png/projects/vstudio/Debug Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib'' and rename it ''zlibd.lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ul>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-29T04:26:31Z

Marten: /* libogg and libvorbis */ cleanup unnecessary specificity

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories as follows:
** Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
** Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE and perform the following steps:</li>
<ol style="list-style-type:lower-latin">
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project (e.g. "libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
</ol>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat the preceding steps for projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-29T04:25:39Z

Marten: /* libogg and libvorbis */ indent the set of steps that need to be repeated to make instructions easier to follow

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories as follows:
** Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
** Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE and perform the following steps:</li>
<ol style="list-style-type:lower-latin">
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the "libogg_static Properties Pages" panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
</ol>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat the preceding steps for projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-29T02:27:15Z

Marten: /* zlib and libpng */ Added missing steps and made consistent with previous reformatting improvements

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories as follows:
** Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
** Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the "libogg_static Properties Pages" panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat all of the preceding steps beginning at step "d" for both projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Edit the ''png/projects/vstudio/zlib.props'' file. Towards the bottom is a path for ZLibSrcDir. Change the value to "..\..\..\..\zlib" (no -1.2.5 or such on the end) and save the file.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>On the IDE toolbar, click on the configuration drop down at the upper left (it defaults to "Debug") and change it to "Release Library".</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer and select "Add > Existing item"</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzclose.c, gzlib.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project in the solution explorer and select ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > C/C++ > Preprocessor
|Preprocessor Definitions
|''Remove '''Z_SOLO''' if present, leave everything else alone''
|}
</li>
<li>Click "Apply" and then "OK".
</ol>
<li>Repeat the following steps for each of these projects: "libpng", "pngtest", "pngvalid", and "zlib".</li>
<ol style="list-style-type:lower-latin">
<li>Right-click on the project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
</li>
<li>Click "Apply".</li>
<li>Click on the configuration drop down at the upper left of the panel and select "Debug Library".</li>
<li>Set (or verify) the following items as follows, noting that the 4th item is not the same as in the previous list.
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties > General
|Project Defaults > Whole Program Optimization
|No Whole Program Optimization
|-
|Configuration Properties > C/C++ > General
|Treat Warnings As Errors
|No (/WX-)
|-
|Configuration Properties > C/C++ > Optimization
|Whole Program Optimization
|No
|-
|Configuration Properties > C/C++ > Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and "OK".
<li>(Remember you need to follow these steps four times, once each for libpng, pngtest, pngvalid, AND zlib!)
</ol>
<li>Select “Debug Library” from the ''Solution Configurations'' drop down in the IDE toolbar, then right click the top line in the Solution Explorer (Solution 'vstudio') and choose ''Build Solution''.</li>
<li>Select the “Release Library” configuration, and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-28T23:08:16Z

Marten: Change CWE to CWE-ou in all appropriate spots

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE-ou\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories as follows:
** Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
** Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the "libogg_static Properties Pages" panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat all of the preceding steps beginning at step "d" for both projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c, gzclose.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE-ou\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-28T23:05:02Z

Marten: /* PhysX SDK */ improve legibility of instruction

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories as follows:
** Copy from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
** Copy from and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the "libogg_static Properties Pages" panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat all of the preceding steps beginning at step "d" for both projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c, gzclose.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-28T23:03:21Z

Marten: /* CWE-ou */ remove stray /LI tag

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the "libogg_static Properties Pages" panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat all of the preceding steps beginning at step "d" for both projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c, gzclose.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-28T03:36:30Z

Marten: Reformat page for improved readability and edit-ability, from top through "zlib and libpng" section

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated.
* Server hostnames, IP addresses, and ports are located in the following files:
: The status URL:
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp"
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp"
: The auth/gatekeeper address
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp"
: The default client port
:: "CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h"

== Build preparation steps ==

=== git (Optional) ===
If you plan to make changes to the source code and contribute to the community, install git (accepting the default options).

=== CWE-ou ===
Obtain CWE-OU source by one of these methods:
* Use '''git clone''' with the repository link found on the webpage referenced above</li>
* Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive

=== DirectX ===
Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c".
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>


=== Visual Studio 2010 Express ===

* Install Visual Studio 2010 Express
* Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times)
* Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency.
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>


=== OpenAL SDK ===
* Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>


=== PhysX SDK ===
* Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX"
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>


=== libogg and libvorbis ===

Build Ogg and Vorbis
<ol style="list-style-type:lower-latin">
<li>Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li>Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li>Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li>On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li>Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li>In the "libogg_static Properties Pages" panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply"</li>
<li>Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li>Click "Apply" and then "OK". </li>
<li>On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li>On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build".</li>
<li>Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE, and repeat all of the preceding steps beginning at step "d" for both projects libvorbis_static and libvorbisfile.</li>
</ol>

Copy Ogg and Vorbis files to CWE
<ol style="list-style-type:lower-latin">
<li>Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
</ol>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>


=== Speex ===

Rebuild the Speex 1.0.1 included in the CWE tree.
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li>Click on configuration drop-down on the upper left and select "Release"</li>
<li>Right click on project in the solution explorer and select properties.</li>
<li>In the panel that opens, set (or verify) the following items as follows:
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded DLL (/MD)
|}
<li>Click on "Apply".</li>
<li>Click on configuration drop-down on the upper left of the properties page and select "Debug". Set (or verify) the following items as follows, noting that the 3rd item is not the same as in the previous list.</li>
{| class="wikitable"
!Left Pane
!Right pane parameter
!Right pane value (drop down)
|-
|Configuration Properties -> General
|Whole Program Optimization
|No Whole Program Optimization
|-
|C/C++ -> Optimization
|Whole Program Optimization
|No
|-
|C/C++ Code Generation
|Runtime Library
|Multi-threaded Debug DLL (/MDd)
|}
</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build".</li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>

=== OpenSSL ===
Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit).
As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path.
Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL".
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>


=== JPEG ===
Build in-tree JPEG library
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE-ou\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>

=== zlib and libpng ===
Build zlib and libpng
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c, gzclose.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-28T03:31:50Z

Marten: More step corrections.

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<ul>
<li>(Optional) If you plan to make changes to the source code and contribute to the community, install git (accepting the default options)</li>
<li>Obtain CWE-OU source by one of these methods:
<ul>
<li> Use '''git clone''' with the repository link found on the webpage referenced above</li>
<li> Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive</li>
</ul>
</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Install Service Pack 1 (SP1) for Visual Studio 2010, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li> Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li> In the "libogg_static Properties Pages" panel that opens, select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and verify it is set to "No Whole Program Optimization".</li>
<li> Select "C/C++ -> Optimization" in the left pane, and verify "Whole Program Optimization" in the right pane is set to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and set it to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "p" for projects libvorbis_static and libvorbisfile.</li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain [https://wiki.openssl.org/index.php/Binaries precompiled binaries] (32-bit, not 64-bit). As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio Command Prompt (2010)" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c, gzclose.c, gzread.c, and gzwrite.c files (hold Ctrl while clicking to select multiple files).</li>
<li>Click "Add".</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol></ul>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-28T00:36:00Z

Marten: Corrected instructions - you do need to build libvorbis

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<ul>
<li>(Optional) install git (accepting the default options)</li>
<li>Obtain CWE-OU source by one of these methods:
<ul>
<li> Use '''git clone''' with the repository link found on the webpage referenced above</li>
<li> Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive</li>
</ul>
</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li> Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li> In the "libogg_static Properties Pages" panel that opens, select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and verify it is set to "No Whole Program Optimization".</li>
<li> Select "C/C++ -> Optimization" in the left pane, and verify "Whole Program Optimization" in the right pane is set to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and set it to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "p" for projects libvorbis_static and libvorbisfile.</li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol></ul>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T21:06:03Z

Marten: add missing step to Save All

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<ul>
<li>(Optional) install git (accepting the default options)</li>
<li>Obtain CWE-OU source by one of these methods:
<ul>
<li> Use '''git clone''' with the repository link found on the webpage referenced above</li>
<li> Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive</li>
</ul>
</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li> Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li> In the "libogg_static Properties Pages" panel that opens, select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and verify it is set to "No Whole Program Optimization".</li>
<li> Select "C/C++ -> Optimization" in the left pane, and verify "Whole Program Optimization" in the right pane is set to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and set it to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for projects libvorbis_static and libvorbisfile.</li>
<li> Select File-> Save All.</li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol></ul>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T05:02:56Z

Marten: Clarified libogg/libvorbis setup instructions

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<ul>
<li>(Optional) install git (accepting the default options)</li>
<li>Obtain CWE-OU source by one of these methods:
<ul>
<li> Use '''git clone''' with the repository link found on the webpage referenced above</li>
<li> Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive</li>
</ul>
</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> On the IDE toolbar, click on configuration drop down at the upper left (it defaults to "Debug") and change it to "Release"</li>
<li> Right click on the project ("libogg_static") in the Solution Explorer at upper left, and select Properties.</li>
<li> In the "libogg_static Properties Pages" panel that opens, select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop down at the upper left of the "libogg_static Properties Pages" panel and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and verify it is set to "No Whole Program Optimization".</li>
<li> Select "C/C++ -> Optimization" in the left pane, and verify "Whole Program Optimization" in the right pane is set to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and set it to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, verify the configuration drop down is still set to "Release". Then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. Then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for projects libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol></ul>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T04:44:26Z

Marten: Fixed filename: libogg.props, not libogg.vsprops

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<ul>
<li>(Optional) install git (accepting the default options)</li>
<li>Obtain CWE-OU source by one of these methods:
<ul>
<li> Use '''git clone''' with the repository link found on the webpage referenced above</li>
<li> Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive</li>
</ul>
</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.props file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol></ul>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T03:45:25Z

Marten:

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested. See the next section for restrictions on using newer versions.

== Notes ==
* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<ul>
<li>(Optional) install git (accepting the default options)</li>
<li>Obtain CWE-OU source by one of these methods:
<ul>
<li> Use '''git clone''' with the repository link found on the webpage referenced above</li>
<li> Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive</li>
</ul>
</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.vsprops file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol></ul>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T03:44:00Z

Marten: Added zlib and libpng download links

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [https://www.zlib.net/fossils/zlib-1.2.7.tar.gz zlib 1.2.7]
* [https://ftp-osl.osuosl.org/pub/libpng/src/archive/gz/libpng15/libpng-1.5.12.tar.gz libpng 1.5.12]
Newer versions of these libraries may work, but no guarantees are offered; these are what have been tested.

== Notes ==

* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<ul>
<li>(Optional) install git (accepting the default options)</li>
<li>Obtain CWE-OU source by one of these methods:
<ul>
<li> Use '''git clone''' with the repository link found on the webpage referenced above</li>
<li> Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive</li>
</ul>
</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.vsprops file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol></ul>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T03:04:56Z

Marten: Improved instructions for obtaining source code, and fixed indentation issue

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://git-scm.com/download/win git] (recommended but not required)
* [https://foundry.openuru.org/gitblit/summary/?r=CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]

== Notes ==

* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<ul>
<li>(Optional) install git (accepting the default options)</li>
<li>Obtain CWE-OU source by one of these methods:
<ul>
<li> Use '''git clone''' with the repository link found on the webpage referenced above</li>
<li> Click "tree" in the top menu of the webpage reference above, then click "zip" to download a ZIP archive</li>
</ul>
</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.vsprops file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol></ul>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<ul>
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
</ul>

== Required source changes for Visual Studio 2010 Express ==
<ul>
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
</ul>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T02:41:49Z

Marten: Added link to the source code

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://foundry.openuru.org/gitblit/r/CWE-ou.git The CWE OpenUru source code]
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]

== Notes ==

* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<li>Obtain CWE-OU source</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.vsprops file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
== Required source changes for Visual Studio 2010 Express ==
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T02:34:54Z

Marten:

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile ==
See [[Build the client with MSVC 2010 Express|Build preparation steps]] for installation instructions!
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]

== Notes ==

* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<li>Obtain CWE-OU source</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Install the DirectX SDK before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.vsprops file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
== Required source changes for Visual Studio 2010 Express ==
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T02:20:09Z

Marten: Revised installation order and added Before you Begin steps.

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Before you begin ==
* If you have a version of Visual Studio later than 2010 installed, you may need to uninstall it.
* If you have Microsoft Visual C++ 2010 Redistributable installed (x86 and/or x64), [https://support.microsoft.com/en-us/help/2728613/s1023-error-when-you-install-the-directx-sdk-june-2010 you will need to uninstall it before installing DirectX SDK]. While installing Visual Studio below, the Redistributable package(s) will be reinstalled for you automatically.

== Items needed to compile (recommended to install in this order) ==
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - This will be in two downloads, you'll need to search for and download both "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]

== Notes ==

* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<li>Obtain CWE-OU source</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Do this before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.vsprops file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
== Required source changes for Visual Studio 2010 Express ==
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T00:25:45Z

Marten:

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Items needed to compile ==
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - you'll need to search for "Visual Studio 2010 VC Express" and "Visual Studio 2010 Service Pack 1".
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]

== Notes ==

* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<li>Obtain CWE-OU source</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Do this before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.vsprops file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
== Required source changes for Visual Studio 2010 Express ==
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Build the client with MSVC 2010 Express

2020-08-27T00:21:44Z

Marten: /* Items needed to compile */

{{UruDocProj}}

== Introduction ==
This document provides steps to build the CWE client with MSVC 2010 SP1 Express.
 

== Items needed to compile ==
* [https://my.visualstudio.com/Downloads?q=visual%20studio%202010&wt.mc_id=o~msft~vscom~older-downloads Microsoft Visual Studio 2010 SP1 Express] - you'll need to search for "Visual Studio 2010 VC Express".
* [https://www.microsoft.com/en-us/download/details.aspx?id=6812 DirectX 9.0c SDK (June 2010)]
* [https://www.openssl.org/source/openssl-1.0.2t.tar.gz OpenSSL 1.0.2t]
* [http://downloads.xiph.org/releases/ogg/libogg-1.3.2.zip libogg-1.3.2]
* [http://downloads.xiph.org/releases/vorbis/libvorbis-1.3.6.zip libvorbis-1.3.6]
* [https://www.openal.org/downloads/OpenAL11CoreSDK.zip OpenAL v1.1 SDK]
* [http://developer.download.nvidia.com/PhysX/2.6.4/PhysX_2.6.4_SDK_Core.exe Ageia PhysX 2.6.4 Core SDK]

== Notes ==

* This guide assumes you are going to use the 7.0A SDK installed with Visual Studio 2010, and are using a 64 bit Windows install.
* You can upgrade to a newer version of Speex if you like, but you will need to fix the Speex VS2010 projects first (by removing the architectures we do not have from the Speex project files).
* Libogg 1.3.2 was used because xiph removed the VS2010 projects from 1.3.3 and above.
* The client has physics bugs (cannot step off the Kadish elevator, and such) when compiled with PhysX 2.6.4 (the only available version). If you can obtain it, PhysX 2.6.0 is the version Cyan used, and clients compiled with it do not seem to have these physics bugs.
* You must use a 2.6.x version of PhysX for CWE, because the cooked mesh format was changed in PhysX 2.7.x and later.
* All libraries are compiled with "Whole Program Optimization" turned off.
* Release version libraries are compiled as "Multi-threaded DLL (/MD)"
* Debug version libraries are compiled as "Multi-threaded Debug DLL (/MDd)"
* Crypto keys are located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\NucleusLib\pnNetBase". Edit the *.hpp files with a text editor to replace Cyan's keys with your own server's keys. Always clean your solution and rebuild when you change crypto keys, to make sure they are updated. 

* Server hostnames, IP addresses, and ports are located in the following files:
The status URL: 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plClient/winmain.cpp" 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/Apps/plUruLauncher/Main.cpp" 
The auth/gatekeeper address 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/Private/pnNbSrvs.cpp" 
The default client port 
"CWE\MOULOpenSourceClientPlugin/Plasma20/Sources/Plasma/NucleusLib/pnNetBase/pnNbConstant.h" 

== Build preparation steps ==
<li>Obtain CWE-OU source</li>
<li>Install the DirectX 9.0c SDK and copy it to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\DX9.0c". 
Do this before you install VS2010 Express, or the DirectX SDK install will throw error S1023, due to a newer version of the C++ 2010 redistributables being installed. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
DX9.0c
include
Lib
</pre>
</li>
<li> Install Visual Studio 2010 Express</li>
<li> Update Visual Studio 2010 Express to SP1, plus security updates (run Windows Update a few times).</li>
<li> Copy the include and lib directories from the SDK installed with VS2010 SP1 Express to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PlatformSDK". The directory where the SDK resides will most likely be "Program Files (x86)\Microsoft SDKs\Windows\v7.0A". As the SDK is in our path, this step is probably not necessary but we will do it for consistency. 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PlatformSDK
include
lib</pre>
</li>
<li>Install the OpenAL SDK and copy the include and lib directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenAL 1.1 with EFX SDK" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
OpenAL 1.1 with EFX SDK
include
libs
</pre>
</li>
<li>Install PhysX SDK, and copy PhysX subdirectories from "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\SDKs" and "Program Files (x86)\AGEIA Technologies\AGEIA PhysX SDK\v2.6.4\Bin" to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\PhysX" 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
PhysX
Bin
Cooking
Docs
Foundation
Framework
lib
...</pre>
</li>
 
<li> Build Ogg and Vorbis</li>
<ol style="list-style-type:lower-latin">
<li> Create a directory and extract Ogg and Vorbis archives to it.
<pre>
oggvorbis
libogg-1.3.2
libvorbis-1.3.6</pre>
</li>
<li> Change directory to "libvorbis-1.3.6\win32\vs2010" and edit the libogg.vsprops file. Make sure the "LIBOGG_VERSION" value matches your version of Ogg (1.3.2 in this document).</li>
<li> Open "libogg-1.3.2\win32\VS2010\libogg_static.sln" in the Visual Studio IDE.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> Open "libvorbis-1.3.6\win32\VS2010\vorbis_static.sln" in the Visual Studio IDE. </li>
<li> Repeat steps "d" through "n" for libvorbis_static and libvorbisfile. </li>
</ol>
<li> Copy Ogg and Vorbis files to CWE </li>
<ol style="list-style-type:lower-latin">

<li> Copy the ogg and vorbis include directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include". It is okay to let it overwrite.
<li> Copy the "libogg-1.3.2\win32\VS2010\Win32\Release" and "Debug" directories into "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
<li> Copy the "libvorbis-1.3.6\win32\VS2010\Win32\Release" and "Debug" directories to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib"</li>
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
win32
xiph
include
ogg
vorbis
lib
Debug
Release</pre>
</li>
</ol>
<li>Rebuild the Speex 1.0.1 included in the CWE tree.</li>
<ol style="list-style-type:lower-latin">
<li>Open CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\libspeex.sln in the Visual Studio 2010 IDE, and convert.</li>
<li> Click on configuration drop-down on the upper left and select "Release"</li>
<li> Right click on project in the solution explorer and select properties.</li>
<li> Select "Configuration Properties -> General " in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded DLL (/MD)"</li>
<li> Click on "Apply"</li>
<li> Click on configuration drop-down on the upper left of the properties page and select "Debug"</li>
<li> Select "Configuration Properties -> General" in the left pane, and then select "Whole Program Optimization" in the right pane, and select "No Whole Program Optimization" from the drop-down.</li>
<li> Select "C/C++ -> Code Generation" in the left pane, and select "Runtime Library" and verify it is set to "Multi-threaded Debug DLL (/MDd)"</li>
<li> Click "Apply" and then "OK". </li>
<li> On the IDE toolbar, select "Release" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li> On the IDE toolbar, select "Debug" from the drop down. then right click on the project in the solution explorer and select "Build". </li>
<li>Copy the headers (.h files) from CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\libspeex to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\include\speex</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Release\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Release</li>
<li> Copy CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\speex-1.0.1\win32\libspeex\Debug\libspeex.lib to CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\xiph\lib\Debug</li>
</ol>
<li>Compile and install OpenSSL (see [[Build OpenSSL with MS Visual C++]]), or obtain precompiled binaries. As this is security software, it is best (in my opinion) to compile it yourself from source. You can choose either static or dynamic linking. '''Note:''' If you link it dynamically, it will cause the Uru client to require the OpenSSL DLLs to be present in the client directory or in the system path. Copy the installed OpenSSL files to "CWE\MOULOpenSourceClientPlugin\StaticSDKs\Win32\OpenSSL". 
Directory structure in the CWE tree will look like this:
<pre>
StaticSDKs
Win32
OpenSSL
bin
include
openssl
lib</pre>
</li>
<li>Build in-tree JPEG library</li>
<ol style="list-style-type:lower-latin">
<li>Open "Visual Studio 2010 Command Prompt" and change to the "CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\jpeg-8c-rgba directory."</li>
<li>Copy makefile.vc to makefile.nmake</li>
<li>Copy jconfig.vc to jconfig.h</li>
<li>Run ''nmake nodebug=1 -f makefile.nmake''. This will build the library in non-debug mode. If you use a debug library, the linker will complain when we link the client executable.</li>
</ol>
<li>Build zlib and libpng</li>
<ol style="list-style-type:lower-latin">
<li>Extract the files in the zlib archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/zlib''.</li>
<li>Extract the files in the libpng archive to ''MOULOpenSourceClientPlugin/StaticSDKs/XPlatform/png''.</li>
<li>Open ''png/projects/vstudio/vstudio.sln'' in the Visual Studio 2010 IDE.</li>
<li>The VS2010 zlib project file distributed in the png archive is set to build for embedded environments. We need to reconfigure it.</li>
<ol style="list-style-type:lower-latin">
<li>Right click on the zlib project tree in the solution explorer.</li>
<li>Select Add -> Existing item</li>
<li>Browse to the zlib source directory (CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib) and select the gzlib.c file</li>
<li>Do the same step above for gzclose.c, gzread.c, and gzwrite.c</li>
<li>Right click on the zlib project and select ''Properties''.</li>
<li>Open 'Configuration Properties'' > ''C/C++'' > ''Preprocessor''</li>
<li>Remove the ''Z_SOLO'' directive from ''Preprocessor Directives'' - Do this for both the LIB Release and LIB Debug configurations.</li>
</ol>
<li>Right-click on the “libpng” project in the ''Solution Explorer'' and choose ''Properties''.</li>
<li>Select configuration “LIB Debug” in the popup menu at the top.</li>
<li>Select ''Configuration Properties'' > ''C/C++'' and set ''Treat Warnings As Errors'' to ''No''</li>
<li>Select ''Configuration Properties'' > ''C/C++'' > ''Code Generation'' on the left.</li>
<li>Change the ''Runtime Library'' line to “Multi-threaded Debug DLL (/MDd)”.</li>
<li>Select "C/C++ -> Optimization" in the left pane, and set "Whole Program Optimization" in the right pane to "No".</li>
<li>Choose the “LIB Release” configuration and set ''Runtime Library'' to “Multi-threaded DLL (/MD)”.</li>
<li>Repeat the above 7 steps for the other two projects “pngtest” and “zlib”.</li>
<li>Select “LIB Debug” from the ''Solution Configurations'' popup menu in the toolbar, then ''Build'' > ''Build Solution''.</li>
<li>Select the “LIB Release” configuration and build the solution.</li>
<li>Rename ''png/projects/vstudio/Debug Library/libpn16.lib'' to ''libpngd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Release Library/libpn16.lib'' to ''libpng.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\png\lib''</li>
<li>Rename ''png/projects/vstudio/Debug Library/zlib.lib'' to ''zlibd.lib'' and copy it to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
<li>Copy ''png/projects/vstudio/Release Library/zlib.lib'' to ''CWE\MOULOpenSourceClientPlugin\StaticSDKs\XPlatform\zlib\lib''</li>
</ol>

== Required source code changes for newer version of DirectX SDK ==
Since we are using a newer version of the DirectX SDK (which supports Visual Studio 2010 Express), we will need to change the source code slightly. We are not changing this in the source tree, since OpenUru is still using the original libraries and VS2003.
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plPipeline\plDXPipeline.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>" 
Change "DXGetErrorString9" to "DXGetErrorString" 
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plWavFile.cpp": 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
<li> In file "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\PubUtilLib\plAudio\plEAXEffects.cpp": 
Remove the "#include <dmusici.h>" line 
Change "#include <dxerr9.h>" to "#include <dxerr.h>"
</li> 
== Required source changes for Visual Studio 2010 Express ==
<li>We do not have MFC with VS2010 SP1 Express, so we need to replace the first reference to afxres.h. The client portion of CWE does not use MFC (I believe the MAX plugin does), so we can make this replacement.</li> 
Note: If you are compiling with VS2010 Professional or greater, you do *not* need to make these edits. Only the Express edition excludes MFC. 
 
<li>Edit '''plClient.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Sources\Plasma\Apps\plClient\res\" 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>
<li>edit '''plUruLauncher.rc''' file located in "CWE\MOULOpenSourceClientPlugin\Plasma20\Apps\plUruLauncher.rc" 
This is the same change we just made in the previous file. 
'''Before''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
#include "afxres.h"
</pre>
'''After''' 
<pre>
// Microsoft Visual C++ generated resource script.
//
#include "resource.h"

#define APSTUDIO_READONLY_SYMBOLS
/////////////////////////////////////////////////////////////////////////////
//
// Generated from the TEXTINCLUDE 2 resource.
//
//#include "afxres.h"

#include <windows.h>
#define IDC_STATIC (-1)
</pre></li>

== Build the client ==
Now that the prep is done, you can actually build the client.
<ol>
<li> Open the "CWE\MOULOpenSourceClientPlugin\Plasma20\MSVC10Projects\Plasma\Apps\AllClient\AllClient.sln" in the VS2010 IDE.</li>
<li> Select the type of build you want from the dropdown on the IDE toolbar.
* Release
* Release_Internal
* Debug
* Debug_Internal
</li>
<li> Right click on the "AllClient" project and select "Build".</li>
 
Completed builds are copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\test" directory.
 
'''Note:''' You '''*must*''' make sure your client is using the same versions of the PhysX DLLs that you built with. They are not compatible from version to version.
</ol>

If, after building the client, you require the server prep tools (plFileSecure, plFileEncrypt, plPythonPak), right click on those specific projects and click "Build". 
The compiled files will be copied into the "CWE\MOULOpenSourceClientPlugin\Plasma20\tools" directory.

[[Category:Cyan_Worlds]]

Instancing - Bookmarks

2016-12-22T04:51:50Z

Marten: Correct minor factual error - banners are in the library, not the museum

{{draft}}
Note: This page is a work in progress as I detail thoughts on my Instancing proposal.
-- Marten

TODO:
* Identify and add any missing Location/Link pairs
* Add detailed linking information for remaining Ages
* Identify how existing Yeesha bookmarks work with the proposal
* Discuss issues and possible solutions to [http://forums.openuru.org/viewtopic.php?p=799#p799 Kenguin's Issues List]
* Note which instances are "default" in which situations
* Resolve any lingering inconsistencies
* Begin related proposal for [[KI Interface:Group Management]]

{{TOClimit|2}}

==Objective==
Replace the Instancing system with a consistent model that gives players greater control. Under the MOUL model, some areas of the game could only be shared by neighbors; under the proposed model, players will be able to invite friends to share all areas of the game.

==Prerequisites==
* Performance Improvements for large groups in one Age
* Queuing system for high-population areas
* Grouping ("Party") System implemented into KI

==Origin of Concept==
First, this proposal is an attempt to incorporate the model of Instancing used in other popular multiplayer online games. A detailed description of Instancing as it applies in most MMOs can be found at http://en.wikipedia.org/wiki/Instance_dungeons, but the key idea is that players do not need to be independently invited to every instance they wish to visit together; players may ally themselves with friends to form a group or party such that all members automatically enter an instance together.

Second, this proposal is inspired by some unused assets hidden in the game files for Uru. One of the more intriguing assets is series of [http://mystonline.com/forums/viewtopic.php?t=16333 three hanging banners] (one blue, one red, and one purple) that can appear in the Library area of Ae'gura. Each of the pedestals under the banners has a set of matching ribbons, although not all pedestals have all ribbons. The sequence of books and ribbons was as follows:
* Gahreesen: Red and Blue
* Teledahn: Purple, Red, Blue
* Kadish: Purple and Blue
* Ahnonay Cathedral: Purple and Blue
* Uran Silo: Purple and Blue
Each banner has [http://mystonline.com/forums/viewtopic.php?p=256592#256592 one of two symbols] on it. The first symbol is named "Yeesha's Story" and it appears on the blue and purple banners. The second symbol is named "Journey Story" and appears on the red banner. This Bookmark Instance proposal is based upon personal musings of how these ribbons may have been intended to work.

== Application: Rules ==

=== Acquisition and Use ===

A set of bookmarks are acquired by the player at the beginning of the game, perhaps in Cleft as an alternative to the Relto book, or with a Relto book. Some sort of tutorial will need to be added to explain the function of the bookmarks.

The bookmarks may be applied to books and Bahro stones; they may not, for obvious reasons, be applied to portals of more ethereal nature.

Two bookmark ribbons appear when the player lifts a book or Bahro stone to examine it. The bookmarks function in this manner:
* Solo Journey (solo hand symbol) - when active, the player will link to his or her own private Age. The Solo Journey bookmark should always be available.
* Group Journey (paired hand symbols) - when active, the player and his or her companions will link to the same Age, which will be the private Age of the "expedition leader." The Group Journey bookmark is only available for a book or Bahro Stone if the player has joined a group, and the leader must have collected and unlocked the Age in his or her Relto.
* No bookmark (drc symbol) - when neither bookmark is active, the player will link to the authentic (public) instance of the Age. This instance may be unavailable if it is at player capacity (see "Managing Access to Full Areas" below), and although this proposal does not mandate it, the public Age might also be unavailable if the player has not completed one or more tasks in his or her private version of the Age.

There will few exceptions where the bookmarks do not apply in the above manner.

Here is a comparison of the how this model replaces the sharing of Instances as it worked in Myst Online.

In Myst Online, a player could reach a friend's Age by one of these methods:
* Meet the friend, link to the friend's Relto, then pull the unlocked book from the bookshelf
* Meet the friend at a copy of the book in a public space. Accept a sharing of the book from the friend.
* Receive an invitation from the friend. Link to Nexus, and access the book.

In this proposal, a player can reach a friend's Age by:
* Join a group where the friend is leader. Use the Group Journey bookmark with ''any'' book or Bahro stone that links to the friend's collected and unlocked Age.

=== The Authentic (Public) Age ===

The Authentic instance of an Age is the legitimate place, typically unmodified by Bahro or Yeesha, open for all explorers. This version of the Age generally lacks rewards. With few exceptions, players will not be able to obtain relto pages, clothing, or puzzle rings from the authentic instance. These Ages are places to hang out, explore, and have parties without needing to invite anyone.

=== The Journey (Private) Age ===

The Journey Age is the private instance controlled by an individual or by the leader of a group of explorers who have banded together. The Journey Age contains the Bahro doors, cloths, and rewards that represent progress in the game.

=== Privacy Control ===

When in a group, the tab at the top of a book in the leader's Relto bookshelf will enable or disable the group journey bookmark for all links to that Age. Consequently, if the leader has not acquired a book, any group members using that book will find the group bookmark disabled for that Age.

=== Managing Access to Full Areas ===

The Bookmark Instancing system depends upon some new or extended method of managing access to high-population areas. Though perhaps deserving of its own proposal, here are a few comments on such a method.

In Prologue and in Myst Online, access to the "real" D'ni City was controlled through the Nexus. Direct linking to the city was not possible; the City books in Relto & Kadish Tolesa and the City Bahro Stone in Neighborhood would link players to a Neighborhood-instanced City. (There was a bug in Myst Online that allowed players to circumvent the intended behavior and link to the main city, but that is not relevant to the discussion of how Cyan meant for the system to work.) When it worked, this system prevented the city from becoming overcrowded.

The original system did not provide a way for players to know when an empty spot had opened in the City. Furthermore, the Bookmark Instancing proposal complicates matters by permitting players to link to public areas from any book - not just Nexus controlled books.

For the Bookmarks proposal to be minimally viable, when the Public instance of an Age is full, the player should not be permitted to link to the that instance, even if he or she has an open book leading to that place. (If an In-Cavern reason is desired for being unable to link, it could simply be that when an area is too crowded, it is not safe to link into that area, and perhaps the link becomes unstable.) The link in the book could appear as a swirling black void, unless one of Yeesha's bookmarks is applied.

This minimal system still leaves much to be desired. A better system would permit background downloading of an Age as well as for waiting on an empty spot in a filled-to-maximum-capacity area. Players attempting to use a book linking to a full area would be notified that they are unable to link to the Age (for whatever reason). The player would be given the option to be notified later when the Age is available. If the Age is downloaded but the public area is full, the player could also still link to a private instance.

An even more advanced solution would introducing queuing, and could permit a player to immediately link to an area that he or she has been waiting to visit. However, this solution is likely to be unsatisfactory to players who want canon rules enforced on actual gameplay, rather than "ICly" explaining that they had linked back to Relto first before linking to the destination Age.

== Application: Specifics (List of Locations and Age Links) ==

=== Self ===
* Relto
** There is no single "authentic" original Relto. Each Relto is its own unique place, and so there is no need for a Solo Journey bookmark with this book.
** When the player is part of a group, as group leader, he or she can control whether people can link to his or her Relto by manipulating the Group bookmark in the Relto book. This will enable or disable the Group bookmark in group members' Relto books. If the player is not a member of a group, the Group bookmark does not appear.

=== Relto===
*Neighborhood
** Each Neighborhood is considered a public place. No private instances exists for these books. The Solo and Group bookmarks do not appear when opening the Neighborhood book in Relto, and all links take the player to the neighborhood for which the player is a member.
*Nexus
** Nexus is a public place that operates in a way that prevents two explorers from occupying the same "cell." The Solo and Group bookmarks do not appear when opening the Nexus book.
*Ae'gura (many links)
** Authentic, Solo Journey, and Group Journey are available.
*Cleft
** Book only available after Original Journey Ages are complete. Authentic, Solo Journey, and Group Journey are available. Dropping through the cleft in Relto to complete Original Journey will take the player to a Solo Journey Cleft. Solo/Group Journey Cleft may be necessary to complete puzzles e.g. link to K'veer.
*Gahreesen
** Authentic, Solo Journey, and Group Journey are available. Authentic Gahreesen might be similar to Neighborhood-instanced Gahreesen from Myst Online.
*Teledahn
** Authentic, Solo Journey, and Group Journey are available.
*Kadish Tolesa
** Authentic, Solo Journey, and Group Journey are available.
*Eder Gira
** Authentic, Solo Journey, and Group Journey are available.
*Eder Kemo
** Authentic, Solo Journey, and Group Journey are available.
*Negilahn/Dereno/Payiferen/Tetsonot
** Authentic, Solo Journey, and Group Journey are available.
*Er'cana
** Authentic, Solo Journey, and Group Journey are available.
*Ahnonay Cathedral
** Authentic, Solo Journey, and Group Journey are available.
*Ahnonay
** Authentic, Solo Journey, and Group Journey are available.
*Minkata
** Authentic, Solo Journey, and Group Journey are available. Authentic Minkata might be Nighttime only and lacking Bahro stones, or could still be manipulated but would lack symbols
*Jalak Dador
** Authentic, Solo Journey, and Group Journey are available.
*Myst
** Authentic, Solo Journey, and Group Journey are available, although Authentic could probably become cramped quickly if only the Library is accessible.

===Neighborhood===
*Gahreesen
** Authentic, Solo Journey, and Group Journey are available. See notes for Relto.
*Eder Delin
** Authentic, Solo Journey, and Group Journey are available. Solo Journey would still include Bahro doors but would obviously not be solvable.
*Eder Tsogal
** Authentic, Solo Journey, and Group Journey are available. Solo Journey would still include Bahro doors but would obviously not be solvable.
*Great Zero
:In Prologue, Great Zero was a Nexus link. Players linking to Great Zero found themselves in a private instance.

:In MOUL, Great Zero was moved to the Neighborhood so that neighbors could gather at the Great Zero. Unfortunately, being able to link from Neighborhood to Great Zero violates the rule against intra-Age linking.

:Although this Proposal does not mandate it, with Bookmark Instancing, players could link from Nexus into the public Great Zero, a group Great Zero, or a totally private Great Zero by using the appropriate Instance bookmark; maintaining the book in the Neighborhood is no longer needed for group Great Zero gatherings. However, if the book is moved to Nexus, the stained glass art for Great Zero no longer has a home.

* Great Stair Bahro Stone
** Authentic, Solo Journey, and Group Journey are available.

===Nexus===
* City Links
* All Ages available from Relto (except Nexus itself)
* Watcher's Sanctuary
* Kirel
* Guild Pubs

Although not mandated by this proposal, the KI and Nexus could interact according to these rules: Ages visited with a KI would be added to the list of books available through Nexus. Ages visited before picking up the KI would not be added. "Unapproved Ages" might also not be added (as the book would not be added to the Nexus library), and the KI could display ??? while in these Ages (as it would not know the name to display).

===D'ni===
====Ae'gura====
*Nexus
*Ferry: Teledahn Dock Bahro Stone
*Takotah: Descent Bahro Stone
*Museum: Negilahn
*Museum: Dereno
*Museum: Payiferen
*Museum: Tetsonot
*Gallery: Kadish Tolesa
*Library: Minkata
*Library: Jalak Dador
*Library: Kadish Tolesa Bahro Stone

====Baron's Office====
*Teledahn
*Teledahn Mushroom Bahro Stone

====Spyroom====
*Teledahn
*Phil's Relto

====Watcher's Sanctuary====
*Er'cana
*Ahnonay Cathedral

====K'veer====
*Nexus
*Myst

====Uran Silo====
*Er'cana

===Gahreesen===
*Neighborhood (Balcony) Bahro Stone
*D'ni (Ae'gura Balcony 1) Bahro Stone
*Nexus
*Wall Nexus
*Teledahn

===Teledahn===
*D'ni (Baron's Office)
*D'ni (Spyroom) - book or stone?
*Gahreesen Bahro Stone

===Kadish Tolesa===
*D'ni (Ae'gura Balcony 2) Bahro Stone
*D'ni (Ae'gura Gallery)
*Kadish Tolesa Alternate

===Eder Gira===
*Eder Kemo
*D'ni (Ae'gura Takotah Roof) Bahro Stone

===Eder Kemo===
*Eder Gira
*Neighborhood (Classroom Roof) Bahro Stone

====Negilahn/Dereno/Payiferen/Tetsonot====
*Nexus

===Er'cana===
*D'ni (Uran Silo)
*Upper Bahro Cave Bahro Stone

===Ahnonay Cathedral===
*Ahnonay

===Ahnonay===
*Ahnonay Cathedral
*Lower Bahro Cave Bahro Stone

===Eder Delin/Eder Tsogal===
*Neighborhood
** The Neighborhood book in Eder Delin/Eder Tsogal must be replaced with a Nexus book. A Neighborhood book should only link to a specific neighborhood and should not work differently for different players.
*Nexus
** Replaces Neighborhood book. The Solo and Group bookmarks do not appear when opening the Nexus book.


[[Category:Instancing]]

Cyan Content Licensing Proposals

2012-02-05T15:44:33Z

Marten: /* Signatures */

== Localization Licensing Request ==
=== Problem Statement ===
==== Preface ====
Please note that this is not a complete statement of the aspirations of the fan developers in respect of Uru/MOUL content licensing; rather it is an exemplar of a specifc case where fan developer efforts to improve Uru/MOUL for the community are hindered by the absence of a suitable license for the adaptation and distribution of Cyan's content. This example is used as a means to explore the licensing possibilities with Cyan and to elicit feedback on potential difficulties so that we might collectively establish a way forward.

==== Introduction ====
Uru has an international audience, and an extensible Localization system which allows content creators to provide translated text to be utilized automatically. Unfortunately, many of the dialogs currently in Uru don't take advantage of this capability and cannot be adapted to do so properly without modifying them.

==== What the Community Has Accomplished Thus Far ====
Thanks to the efforts of everyone at GULP (http://rel.to/gulp, formerly the Uru Localization Project), we have a database of translations in a large number of languages. Changes have been made to the code to re-enable the functions which had been disabled after Untìl Uru, as well as fixes in the input routines that now allow non-US keyboards.

==== What the Community Needs to Continue ====
There are two primary allowances we need from Cyan in order to continue our efforts to expand Uru's accessibility:
# A permissive license that would allow us to copy, translate, and distribute all textual information available in Uru, currently located in the .loc files. This would legalize the translations already done by the community and allow their distribution.
# Access to the 3ds Max source files for the GUIs used in Uru so that we can normalize their use of the provided hooks in the code which they currently do not use, and a license to re-distribute at least the compiled output with those fixes applied. If that is deemed impossible, an alternative solution that would allow at least this specific goal is a license to modify and distribute the existing PRPs containing translatable GUI items.

At this time, we would ask: is Cyan able to indicate what difficulties they perceive over the licensing of content, are there particular aspects where Cyan is open to suggestions, and are there specific limitations which the fans should place on their aspirations for content licensing? We are not asking for a final solution for this specific case yet, but we are presenting a specific case in the hope that it will be helpful as a first step on the collaborative path to a general solution.

Thank you for reading and considering this request.

==== Signatures ====
[[User:OHB|OHB]] 19:24, 2 February 2012 (MST)

[[User:Hoikas|Hoikas]] 19:31, 2 February 2012 (MST)

[[User:Branan|Branan]] 21:08, 2 February 2012 (MST)

[[User:Christian Walther|Christian Walther]] 05:28, 3 February 2012 (MST)

[[User:Leonardo|Leonardo]] 06:16, 3 February 2012 (MST)

[[User:Mac Fife|Mac Fife]] 12:12, 3 February 2012 (MST)

[[User:Nadnerb|Nadnerb]] 14:36, 3 February 2012 (MST)

[[User:Malfhok|Malfhok]] 05:14, 4 February 2012 (MST)

[[User:Deledrius|Deledrius]] 08:57, 4 February 2012 (MST)

[[User:Marten|Marten]] 09:44, 5 February 2012 (MST)

<hr>

Following is additional technical information.

=== Technical Information ===
The .loc files are XML files containing translations for all textual items in Uru. GULP (http://rel.to/gulp) already has an extensive library of translations and a system to export that database to Uru-ready .loc files. Not all of Uru uses these however, as some values are hard-coded in Python scripts or the PRPs themselves, but this can be converted as the GUI items have the ability to reference the XML paths directly. Much of this Python code references the GUI items by TagIDs, which are arbitrary unique numbers used to refer to the resource. This is messy, as it must be updated when the GUI is updated and can otherwise become out of sync; it is also problematic in the current data set as not all translatable GUI items have been assigned TagIDs, meaning they must be found (if at all) by very fragile code. There is also an embedded text field in these items, which currently contains only the English text. Fortunately, these items support a self-describing LocalizationPath which automatically informs the Plasma engine's LocalizationManager which string to use, allowing localization to be handled cleanly and consistently. All of these items are a part of the data and without a license to modify and distribute the PRPs, we cannot continue the efforts to localize Uru outside of using hacks and shims to the existing elegant but under-utilized engine.

As an additional benefit to Cyan: the changes made under the proposed licensing could be relatively easy for Cyan to integrate back into their own assets without affecting current functionality. This would be impossible if only binary changes are allowed to the exported PRPs rather than the .max sources, and it allows Cyan to take advantage of the localization code changes in the engine once it reaches maturity in the community testing with very little friction.

An extra note about the alternative suggestion in (2) which only allows modification of PRPs -- The reason this is inferior, aside from the obvious, is that while it would allow the immediate goal of activating the built-in localization, I anticipate minor bugs such as text flow and sizing in the UI when displaying languages other than the one for which they were designed. These will be extremely difficult to fix under the limited alternative solution and should be far simpler with access to the original 3D Studio Max source files.

=== License Suggestions ===
I was going to wrap up by suggesting licenses in order to simplify the burden on Cyan, but as the OU Content Licensing thread proves there are many viable options and they all address different needs. Unfortunately, in order to find where that spot of compromise is we'll need feedback from Cyan on this point. I implore Cyan, should they wish to consider this request, to respond with their concerns and needs first. At that point tangible suggestions can be made regarding the specifics and the proposal can move forward should they be agreeable.

At any rate, for the .loc files I'd suggest terms which preserves Cyan's ownership of the text (some of which, being canon from the Myst universe, has inherent value to them), while allowing edits and distribution by the community. A disclaimer stating that Cyan is only responsible for the original English text may also be desirable.

=== Links ===
Forum link: [http://forums.openuru.org/viewtopic.php?f=91&t=635 Content Licensing]

MOSS/Distribution Specific Instructions

2011-11-04T03:43:06Z

Marten: /* MacOS X */

This document is meant to collect any known distribution-specific instructions
for installing MOSS. There are two main parts: installing the prerequisite
packages, and setting up the PostgreSQL database. Feel free to add any other
notes you may find useful.

== Prerequisite Packages ==

=== NetBSD pkgsrc ===

Only PostgreSQL and the autotools are needed. You can build the packages
or use the prebuilt packages with pkg_add.

pkg_add automake
pkg_add libtool
pkg_add libpqxx
I recommend starting with libpqxx because it seems to lag the postgresql-client
package, and installing libpqxx will get the correct client.
pkg_add postgresqlNN-server
Get the version number to match the client installed for pqxx.

Now follow the instructions:
* copy /usr/pkg/share/examples/rc.d/pgsql to /etc/rc.d/pgsql
* chmod 555 /etc/rc.d/pgsql
* append pgsql=YES to /etc/rc.conf

=== MacOS X ===

First, you will need the MacOS X developer tools installed.

Second, you will need to install libpqxx, zlib, and postgresql. Here is one approach:

You can use [[http://www.macports.org/ MacPorts]] to install as follows:
sudo port install libpqxx zlib postgresql84 postgresql84-server

Some instruction guides for installing PostgreSQL (such as the README for EnterpriseDB's version) suggest editing /etc/sysctl.conf and increasing the shmall setting from the default (8192 under Mac OS X 10.6, exactly 1/4096th of shmmax). Whatever number you choose for shmall, it should be (a) smaller than shmmax, and (b) divisible by 4096. For example, a valid value might be:
kern.sysv.shmall=65536

MacPorts might not create the user and group accounts for postgres. For some reason, most instructions for installing PostgreSQL from MacPorts seem to gloss over this issue. You may need to manually create the postgres User and Group. This is accomplished in two phases.

First, identify the last user and group IDs already present.
sudo dscl . -list /Users UniqueID | sort -n -k 2 | tail -n 1
sudo dscl . -list /Groups PrimaryGroupID | sort -n -k 2 | tail -n 1
For each, take the number shown and add 1. These are your UniqueID and PrimaryGroupID numbers.

Second, replace the ### in the following commands as indicated to create the user and group.
sudo dscl . -create /Users/postgres UniqueID ###
sudo dscl . -create /Users/postgres PrimaryGroupID ###
sudo dscl . -create /Users/postgres HomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres NFSHomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres RealName "PostgreSQL Administrator"
sudo dscl . -create /Users/postgres Password \*
sudo dscl . -create /Groups/postgres PrimaryGroupID ###
sudo dscl . -create /Groups/postgres Password \*

The following instructions must be performed after installing PostgreSQL. If the 'chown' step fails, then you're probably missing the user and group settings indicated above.
sudo mkdir -p /opt/local/var/db/postgresql84/defaultdb
sudo chown -R postgres:postgres /opt/local/var/db/postgresql84
sudo su postgres -c '/opt/local/lib/postgresql84/bin/initdb -D /opt/local/var/db/postgresql84/defaultdb'
sudo launchctl load -w /Library/LaunchDaemons/org.macports.postgresql84-server.plist

The last line above should cause the server to start on reboot. Don't reboot yet - proceed to the database setup instructions where there are more steps you'll want to complete before starting the server.

==== Security Suggestion ====
For some installations of Postgres, experts recommend an additional step:
sudo dscl . -create /Users/postgres UserShell /usr/bin/false
After setting this up, you'll lose the ability to su to the postgres account to run other programs. So, this is a step you might take only after getting everything else working. To revert this step:
sudo dscl . -create /Users/postgres UserShell /bin/bash

== Database Setup ==

=== NetBSD pkgsrc ===

Copy moss_uuidgen.so to /usr/pkg/lib/postgresql/

The database user is <tt>pgsql</tt>. It has root access to the DB by default.
Connect from localhost (the default).

Create the database:
su -m pgsql -c "psql postgres"
create database moss with encoding='UTF8';
\c moss
create role moss with login;
\q
su -m pgsql -c "psql postgres -f moss.sql"

Then set db_user=moss in moss_backend.cfg.

=== MacOS X ===

Copy moss_uuidgen.so to /opt/local/lib/postgresql84/. From the root of your MOSS build tree:

sudo cp postgresql/moss_uuidgen.so /opt/local/lib/postgresql84/

Now you'll need to start the server. The & will background the process:
sudo su postgres -c '/opt/local/lib/postgresql84/bin/postgres -D /opt/local/var/db/postgresql84/defaultdb' &

The database user is postgres. Start psql, the postgreSQL command line interface, as user postgres:

sudo su -m postgres -c "/opt/local/lib/postgresql84/bin/psql postgres"

At the postgres prompt run these commands. If you are going to run MOSS as a user other than "moss", change the role name appropriately:

create database moss with encoding='UTF8' template = template0;
\c moss
create role moss with login;
\q

Then from the root of your MOSS build tree:
sudo su -m postgres -c "/opt/local/lib/postgresql84/bin/psql postgres -f postgresql/moss.sql"

== Additional Notes ==

=== MacOS X ===

The bootstrap.sh file does not currently work because libtoolize is named glibtoolize under MacOS. A patch has been submitted. With the patched boostrap, you'll just need to <code>export LIBTOOLIZE=glibtoolize</code>.

If you installed PostgreSQL and libpqxx from MacPorts, your configure command line will need to look like this:
./configure --with-postgres=/opt/local/lib/postgresql84 --with-libpqxx=/opt/local

In the postgres subdirectory, the Makefile for the UUID generator expects pg_config to be in your PATH.
export PATH=${PATH}:/opt/local/lib/postgresql84/bin

The UUID generator Makefile may also fail because the MacPorts package doesn't automate linking to SSL. Alternate Makefile:
MODULE_big = moss_uuidgen
SHLIB_LINK += -lssl
PGXS := $(shell pg_config --pgxs)
include $(PGXS)

[[Category:MOSS]]

MOSS/Distribution Specific Instructions

2011-11-03T05:13:34Z

Marten: /* MacOS X */

This document is meant to collect any known distribution-specific instructions
for installing MOSS. There are two main parts: installing the prerequisite
packages, and setting up the PostgreSQL database. Feel free to add any other
notes you may find useful.

== Prerequisite Packages ==

=== NetBSD pkgsrc ===

Only PostgreSQL and the autotools are needed. You can build the packages
or use the prebuilt packages with pkg_add.

pkg_add automake
pkg_add libtool
pkg_add libpqxx
I recommend starting with libpqxx because it seems to lag the postgresql-client
package, and installing libpqxx will get the correct client.
pkg_add postgresqlNN-server
Get the version number to match the client installed for pqxx.

Now follow the instructions:
* copy /usr/pkg/share/examples/rc.d/pgsql to /etc/rc.d/pgsql
* chmod 555 /etc/rc.d/pgsql
* append pgsql=YES to /etc/rc.conf

=== MacOS X ===

First, you will need the MacOS X developer tools installed.

Second, you will need to install libpqxx, zlib, and postgresql. Here is one approach:

You can use [[http://www.macports.org/ MacPorts]] to install as follows:
sudo port install libpqxx zlib postgresql84 postgresql84-server

Some instruction guides for installing PostgreSQL (such as the README for EnterpriseDB's version) suggest editing /etc/sysctl.conf and increasing the shmall setting from the default (8192 under Mac OS X 10.6, exactly 1/4096th of shmmax). Whatever number you choose for shmall, it should be (a) smaller than shmmax, and (b) divisible by 4096. For example, a valid value might be:
kern.sysv.shmall=65536

MacPorts might not create the user and group accounts for postgres. For some reason, most instructions for installing PostgreSQL from MacPorts seem to gloss over this issue. You may need to manually create the postgres User and Group. This is accomplished in two phases.

First, identify the last user and group IDs already present.
sudo dscl . -list /Users UniqueID | sort -n -k 2 | tail -n 1
sudo dscl . -list /Groups PrimaryGroupID | sort -n -k 2 | tail -n 1
For each, take the number shown and add 1. These are your UniqueID and PrimaryGroupID numbers.

Second, replace the ### in the following commands as indicated to create the user and group.
sudo dscl . -create /Users/postgres UniqueID ###
sudo dscl . -create /Users/postgres PrimaryGroupID ###
sudo dscl . -create /Users/postgres HomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres NFSHomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres RealName "PostgreSQL Administrator"
sudo dscl . -create /Users/postgres Password \*
sudo dscl . -create /Groups/postgres PrimaryGroupID ###
sudo dscl . -create /Groups/postgres Password \*

The following instructions must be performed after installing PostgreSQL. If the 'chown' step fails, then you're probably missing the user and group settings indicated above.
sudo mkdir -p /opt/local/var/db/postgresql84/defaultdb
sudo chown -R postgres:postgres /opt/local/var/db/postgresql84
sudo su postgres -c '/opt/local/lib/postgresql84/bin/initdb -D /opt/local/var/db/postgresql84/defaultdb'
sudo launchctl load -w /Library/LaunchDaemons/org.macports.postgresql84-server.plist

The last line above should cause the server to start on reboot. Don't reboot yet - proceed to the database setup instructions where there are more steps you'll want to complete before starting the server.

==== Security Suggestion ====
For some installations of Postgres, experts recommend an additional step:
sudo dscl . -create /Users/postgres UserShell /usr/bin/false
After setting this up, you'll lose the ability to su to the postgres account to run other programs. So, this is a step you might take only after getting everything else working. To revert this step:
sudo dscl . -create /Users/postgres UserShell /bin/bash

== Database Setup ==

=== NetBSD pkgsrc ===

Copy moss_uuidgen.so to /usr/pkg/lib/postgresql/

The database user is <tt>pgsql</tt>. It has root access to the DB by default.
Connect from localhost (the default).

Create the database:
su -m pgsql -c "psql postgres"
create database moss with encoding='UTF8';
\c moss
create role moss with login;
\q
su -m pgsql -c "psql postgres -f moss.sql"

Then set db_user=moss in moss_backend.cfg.

=== MacOS X ===

Copy moss_uuidgen.so to /opt/local/lib/postgresql84/. From the root of your MOSS build tree:

sudo cp postgresql/moss_uuidgen.so /opt/local/lib/postgresql84/

Now you'll need to start the server. The & will background the process:
sudo su postgres -c '/opt/local/lib/postgresql84/bin/postgres -D /opt/local/var/db/postgresql84/defaultdb' &

The database user is postgres. Start psql, the postgreSQL command line interface, as user postgres:

sudo su -m postgres -c "/opt/local/lib/postgresql84/bin/psql postgres"

At the postgres prompt:

create database moss with encoding='UTF8' template = template0;
\c moss
create role moss with login;
\q

Then from the root of your MOSS build tree:
sudo su -m postgres -c "/opt/local/lib/postgresql84/bin/psql postgres -f postgresql/moss.sql"

== Additional Notes ==

=== MacOS X ===

The bootstrap.sh file does not currently work because libtoolize is named glibtoolize under MacOS. A patch has been submitted. With the patched boostrap, you'll just need to <code>export LIBTOOLIZE=glibtoolize</code>.

If you installed PostgreSQL and libpqxx from MacPorts, your configure command line will need to look like this:
./configure --with-postgres=/opt/local/lib/postgresql84 --with-libpqxx=/opt/local

In the postgres subdirectory, the Makefile for the UUID generator expects pg_config to be in your PATH.
export PATH=${PATH}:/opt/local/lib/postgresql84/bin

The UUID generator Makefile may also fail because the MacPorts package doesn't automate linking to SSL. Alternate Makefile:
MODULE_big = moss_uuidgen
SHLIB_LINK += -lssl
PGXS := $(shell pg_config --pgxs)
include $(PGXS)

[[Category:MOSS]]

MOSS/Distribution Specific Instructions

2011-11-03T05:12:29Z

Marten: /* MacOS X */

This document is meant to collect any known distribution-specific instructions
for installing MOSS. There are two main parts: installing the prerequisite
packages, and setting up the PostgreSQL database. Feel free to add any other
notes you may find useful.

== Prerequisite Packages ==

=== NetBSD pkgsrc ===

Only PostgreSQL and the autotools are needed. You can build the packages
or use the prebuilt packages with pkg_add.

pkg_add automake
pkg_add libtool
pkg_add libpqxx
I recommend starting with libpqxx because it seems to lag the postgresql-client
package, and installing libpqxx will get the correct client.
pkg_add postgresqlNN-server
Get the version number to match the client installed for pqxx.

Now follow the instructions:
* copy /usr/pkg/share/examples/rc.d/pgsql to /etc/rc.d/pgsql
* chmod 555 /etc/rc.d/pgsql
* append pgsql=YES to /etc/rc.conf

=== MacOS X ===

First, you will need the MacOS X developer tools installed.

Second, you will need to install libpqxx, zlib, and postgresql. Here is one approach:

You can use [[http://www.macports.org/ MacPorts]] to install as follows:
sudo port install libpqxx zlib postgresql84 postgresql84-server

Some instruction guides for installing PostgreSQL (such as the README for EnterpriseDB's version) suggest editing /etc/sysctl.conf and increasing the shmall setting from the default (8192 under Mac OS X 10.6, exactly 1/4096th of shmmax). Whatever number you choose for shmall, it should be (a) smaller than shmmax, and (b) divisible by 4096. For example, a valid value might be:
kern.sysv.shmall=65536

MacPorts might not create the user and group accounts for postgres. For some reason, most instructions for installing PostgreSQL from MacPorts seem to gloss over this issue. You may need to manually create the postgres User and Group. This is accomplished in two phases.

First, identify the last user and group IDs already present.
sudo dscl . -list /Users UniqueID | sort -n -k 2 | tail -n 1
sudo dscl . -list /Groups PrimaryGroupID | sort -n -k 2 | tail -n 1
For each, take the number shown and add 1. These are your UniqueID and PrimaryGroupID numbers.

Second, replace the ### in the following commands as indicated to create the user and group.
sudo dscl . -create /Users/postgres UniqueID ###
sudo dscl . -create /Users/postgres PrimaryGroupID ###
sudo dscl . -create /Users/postgres HomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres NFSHomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres RealName "PostgreSQL Administrator"
sudo dscl . -create /Users/postgres Password \*
sudo dscl . -create /Groups/postgres PrimaryGroupID ###
sudo dscl . -create /Groups/postgres Password \*

The following instructions must be performed after installing PostgreSQL. If the 'chown' step fails, then you're probably missing the user and group settings indicated above.
sudo mkdir -p /opt/local/var/db/postgresql84/defaultdb
sudo chown -R postgres:postgres /opt/local/var/db/postgresql84
sudo su postgres -c '/opt/local/lib/postgresql84/bin/initdb -D /opt/local/var/db/postgresql84/defaultdb'
sudo launchctl load -w /Library/LaunchDaemons/org.macports.postgresql84-server.plist

The last line above should cause the server to start on reboot. Don't reboot yet - proceed to the database setup instructions where there are more steps you'll want to complete before starting the server.

==== Security Suggestion ====
For some installations of Postgres, experts recommend an additional step:
sudo dscl . -create /Users/postgres UserShell /usr/bin/false
After setting this up, you'll lose the ability to su to the postgres account to run other programs. So, this is a step you might take only after getting everything else working. To revert this step:
sudo dscl . -create /Users/postgres UserShell /bin/bash

== Database Setup ==

=== NetBSD pkgsrc ===

Copy moss_uuidgen.so to /usr/pkg/lib/postgresql/

The database user is <tt>pgsql</tt>. It has root access to the DB by default.
Connect from localhost (the default).

Create the database:
su -m pgsql -c "psql postgres"
create database moss with encoding='UTF8';
\c moss
create role moss with login;
\q
su -m pgsql -c "psql postgres -f moss.sql"

Then set db_user=moss in moss_backend.cfg.

=== MacOS X ===

Copy moss_uuidgen.so to /opt/local/lib/postgresql84/. From the root of your MOSS build tree:

sudo cp postgresql/moss_uuidgen.so /opt/local/lib/postgresql84/

The database user is postgres. Start psql, the postgreSQL command line interface, as user postgres:

sudo su -m postgres -c "/opt/local/lib/postgresql84/bin/psql postgres"

At the postgres prompt:

create database moss with encoding='UTF8' template = template0;
\c moss
create role moss with login;
\q

Then from the root of your MOSS build tree:
sudo su -m postgres -c "/opt/local/lib/postgresql84/bin/psql postgres -f postgresql/moss.sql"

== Additional Notes ==

=== MacOS X ===

The bootstrap.sh file does not currently work because libtoolize is named glibtoolize under MacOS. A patch has been submitted. With the patched boostrap, you'll just need to <code>export LIBTOOLIZE=glibtoolize</code>.

If you installed PostgreSQL and libpqxx from MacPorts, your configure command line will need to look like this:
./configure --with-postgres=/opt/local/lib/postgresql84 --with-libpqxx=/opt/local

In the postgres subdirectory, the Makefile for the UUID generator expects pg_config to be in your PATH.
export PATH=${PATH}:/opt/local/lib/postgresql84/bin

The UUID generator Makefile may also fail because the MacPorts package doesn't automate linking to SSL. Alternate Makefile:
MODULE_big = moss_uuidgen
SHLIB_LINK += -lssl
PGXS := $(shell pg_config --pgxs)
include $(PGXS)

[[Category:MOSS]]

MOSS/Distribution Specific Instructions

2011-11-03T05:04:54Z

Marten: /* MacOS X */

This document is meant to collect any known distribution-specific instructions
for installing MOSS. There are two main parts: installing the prerequisite
packages, and setting up the PostgreSQL database. Feel free to add any other
notes you may find useful.

== Prerequisite Packages ==

=== NetBSD pkgsrc ===

Only PostgreSQL and the autotools are needed. You can build the packages
or use the prebuilt packages with pkg_add.

pkg_add automake
pkg_add libtool
pkg_add libpqxx
I recommend starting with libpqxx because it seems to lag the postgresql-client
package, and installing libpqxx will get the correct client.
pkg_add postgresqlNN-server
Get the version number to match the client installed for pqxx.

Now follow the instructions:
* copy /usr/pkg/share/examples/rc.d/pgsql to /etc/rc.d/pgsql
* chmod 555 /etc/rc.d/pgsql
* append pgsql=YES to /etc/rc.conf

=== MacOS X ===

First, you will need the MacOS X developer tools installed.

Second, you will need to install libpqxx, zlib, and postgresql. Here is one approach:

You can use [[http://www.macports.org/ MacPorts]] to install as follows:
sudo port install libpqxx zlib postgresql84 postgresql84-server

Some instruction guides for installing PostgreSQL (such as the README for EnterpriseDB's version) suggest editing /etc/sysctl.conf and increasing the shmall setting from the default (8192 under Mac OS X 10.6, exactly 1/4096th of shmmax). Whatever number you choose for shmall, it should be (a) smaller than shmmax, and (b) divisible by 4096. For example, a valid value might be:
kern.sysv.shmall=65536

MacPorts might not create the user and group accounts for postgres. For some reason, most instructions for installing PostgreSQL from MacPorts seem to gloss over this issue. You may need to manually create the postgres User and Group. This is accomplished in two phases.

First, identify the last user and group IDs already present.
sudo dscl . -list /Users UniqueID | sort -n -k 2 | tail -n 1
sudo dscl . -list /Groups PrimaryGroupID | sort -n -k 2 | tail -n 1
For each, take the number shown and add 1. These are your UniqueID and PrimaryGroupID numbers.

Second, replace the ### in the following commands as indicated to create the user and group.
sudo dscl . -create /Users/postgres UniqueID ###
sudo dscl . -create /Users/postgres PrimaryGroupID ###
sudo dscl . -create /Users/postgres HomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres NFSHomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres RealName "PostgreSQL Administrator"
sudo dscl . -create /Users/postgres Password \*
sudo dscl . -create /Groups/postgres PrimaryGroupID ###
sudo dscl . -create /Groups/postgres Password \*

The following instructions must be performed after installing PostgreSQL. If the 'chown' step fails, then you're probably missing the user and group settings indicated above.
sudo mkdir -p /opt/local/var/db/postgresql84/defaultdb
sudo chown -R postgres:postgres /opt/local/var/db/postgresql84
sudo su postgres -c '/opt/local/lib/postgresql84/bin/initdb -D /opt/local/var/db/postgresql84/defaultdb'
sudo launchctl load -w /Library/LaunchDaemons/org.macports.postgresql84-server.plist

The last line above should cause the server to start on reboot. To start the server now:
sudo su postgres -c '/opt/local/lib/postgresql84/bin/postgres -D /opt/local/var/db/postgresql84/defaultdb'

==== Security Suggestion ====
For some installations of Postgres, experts recommend an additional step:
sudo dscl . -create /Users/postgres UserShell /usr/bin/false
After setting this up, you'll lose the ability to su to the postgres account to run other programs. So, this is a step you might take only after getting everything else working. To revert this step:
sudo dscl . -create /Users/postgres UserShell /bin/bash

== Database Setup ==

=== NetBSD pkgsrc ===

Copy moss_uuidgen.so to /usr/pkg/lib/postgresql/

The database user is <tt>pgsql</tt>. It has root access to the DB by default.
Connect from localhost (the default).

Create the database:
su -m pgsql -c "psql postgres"
create database moss with encoding='UTF8';
\c moss
create role moss with login;
\q
su -m pgsql -c "psql postgres -f moss.sql"

Then set db_user=moss in moss_backend.cfg.

=== MacOS X ===

Copy moss_uuidgen.so to /opt/local/lib/postgresql84/. From the root of your MOSS build tree:

sudo cp postgresql/moss_uuidgen.so /opt/local/lib/postgresql84/

The database user is postgres. Start psql, the postgreSQL command line interface, as user postgres:

sudo su -m postgres -c "/opt/local/lib/postgresql84/bin/psql postgres"

At the postgres prompt:

create database moss with encoding='UTF8' template = template0;
\c moss
create role moss with login;
\q

Then from the root of your MOSS build tree:
sudo su -m postgres -c "/opt/local/lib/postgresql84/bin/psql postgres -f postgresql/moss.sql"

== Additional Notes ==

=== MacOS X ===

The bootstrap.sh file does not currently work because libtoolize is named glibtoolize under MacOS. A patch has been submitted. With the patched boostrap, you'll just need to <code>export LIBTOOLIZE=glibtoolize</code>.

If you installed PostgreSQL and libpqxx from MacPorts, your configure command line will need to look like this:
./configure --with-postgres=/opt/local/lib/postgresql84 --with-libpqxx=/opt/local

In the postgres subdirectory, the Makefile for the UUID generator expects pg_config to be in your PATH.
export PATH=${PATH}:/opt/local/lib/postgresql84/bin

The UUID generator Makefile may also fail because the MacPorts package doesn't automate linking to SSL. Alternate Makefile:
MODULE_big = moss_uuidgen
SHLIB_LINK += -lssl
PGXS := $(shell pg_config --pgxs)
include $(PGXS)

[[Category:MOSS]]

MOSS/Distribution Specific Instructions

2011-11-03T05:00:26Z

Marten: /* MacOS X */

This document is meant to collect any known distribution-specific instructions
for installing MOSS. There are two main parts: installing the prerequisite
packages, and setting up the PostgreSQL database. Feel free to add any other
notes you may find useful.

== Prerequisite Packages ==

=== NetBSD pkgsrc ===

Only PostgreSQL and the autotools are needed. You can build the packages
or use the prebuilt packages with pkg_add.

pkg_add automake
pkg_add libtool
pkg_add libpqxx
I recommend starting with libpqxx because it seems to lag the postgresql-client
package, and installing libpqxx will get the correct client.
pkg_add postgresqlNN-server
Get the version number to match the client installed for pqxx.

Now follow the instructions:
* copy /usr/pkg/share/examples/rc.d/pgsql to /etc/rc.d/pgsql
* chmod 555 /etc/rc.d/pgsql
* append pgsql=YES to /etc/rc.conf

=== MacOS X ===

First, you will need the MacOS X developer tools installed.

Second, you will need to install libpqxx, zlib, and postgresql. Here is one approach:

You can use [[http://www.macports.org/ MacPorts]] to install as follows:
sudo port install libpqxx zlib postgresql84 postgresql84-server

Some instruction guides for installing PostgreSQL (such as the README for EnterpriseDB's version) suggest editing /etc/sysctl.conf and increasing the shmall setting from the default (8192 under Mac OS X 10.6, exactly 1/4096th of shmmax). Whatever number you choose for shmall, it should be (a) smaller than shmmax, and (b) divisible by 4096. For example, a valid value might be:
kern.sysv.shmall=65536

MacPorts might not create the user and group accounts for postgres. For some reason, most instructions for installing PostgreSQL from MacPorts seem to gloss over this issue. You may need to manually create the postgres User and Group. This is accomplished in two phases.

First, identify the last user and group IDs already present.
sudo dscl . -list /Users UniqueID | sort -n -k 2 | tail -n 1
sudo dscl . -list /Groups PrimaryGroupID | sort -n -k 2 | tail -n 1
For each, take the number shown and add 1. These are your UniqueID and PrimaryGroupID numbers.

Second, replace the ### in the following commands as indicated to create the user and group.
sudo dscl . -create /Users/postgres UniqueID ###
sudo dscl . -create /Users/postgres PrimaryGroupID ###
sudo dscl . -create /Users/postgres HomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres NFSHomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres RealName "PostgreSQL Administrator"
sudo dscl . -create /Users/postgres Password \*
sudo dscl . -create /Groups/postgres PrimaryGroupID ###
sudo dscl . -create /Groups/postgres Password \*

The following instructions must be performed after installing PostgreSQL. If the 'chown' step fails, then you're probably missing the user and group settings indicated above.
sudo mkdir -p /opt/local/var/db/postgresql84/defaultdb
sudo chown -R postgres:postgres /opt/local/var/db/postgresql84
sudo su postgres -c '/opt/local/lib/postgresql84/bin/initdb -D /opt/local/var/db/postgresql84/defaultdb'
sudo launchctl load -w /Library/LaunchDaemons/org.macports.postgresql84-server.plist

The last line above should cause the server to start on reboot. To start the server now:
sudo su postgres -c '/opt/local/lib/postgresql84/bin/postgres -D /opt/local/var/db/postgresql84/defaultdb'

==== Security Suggestion ====
For some installations of Postgres, experts recommend an additional step:
sudo dscl . -create /Users/postgres UserShell /usr/bin/false
After setting this up, you'll lose the ability to su to the postgres account to run other programs. So, this is a step you might take only after getting everything else working. To revert this step:
sudo dscl . -create /Users/postgres UserShell /bin/bash

== Database Setup ==

=== NetBSD pkgsrc ===

Copy moss_uuidgen.so to /usr/pkg/lib/postgresql/

The database user is <tt>pgsql</tt>. It has root access to the DB by default.
Connect from localhost (the default).

Create the database:
su -m pgsql -c "psql postgres"
create database moss with encoding='UTF8';
\c moss
create role moss with login;
\q
su -m pgsql -c "psql postgres -f moss.sql"

Then set db_user=moss in moss_backend.cfg.

=== MacOS X ===

{{tba}}

== Additional Notes ==

=== MacOS X ===

The bootstrap.sh file does not currently work because libtoolize is named glibtoolize under MacOS. A patch has been submitted. With the patched boostrap, you'll just need to <code>export LIBTOOLIZE=glibtoolize</code>.

If you installed PostgreSQL and libpqxx from MacPorts, your configure command line will need to look like this:
./configure --with-postgres=/opt/local/lib/postgresql84 --with-libpqxx=/opt/local

In the postgres subdirectory, the Makefile for the UUID generator expects pg_config to be in your PATH.
export PATH=${PATH}:/opt/local/lib/postgresql84/bin

The UUID generator Makefile may also fail because the MacPorts package doesn't automate linking to SSL. Alternate Makefile:
MODULE_big = moss_uuidgen
SHLIB_LINK += -lssl
PGXS := $(shell pg_config --pgxs)
include $(PGXS)

[[Category:MOSS]]

MOSS/Distribution Specific Instructions

2011-11-03T04:35:09Z

Marten: /* MacOS X */

This document is meant to collect any known distribution-specific instructions
for installing MOSS. There are two main parts: installing the prerequisite
packages, and setting up the PostgreSQL database. Feel free to add any other
notes you may find useful.

== Prerequisite Packages ==

=== NetBSD pkgsrc ===

Only PostgreSQL and the autotools are needed. You can build the packages
or use the prebuilt packages with pkg_add.

pkg_add automake
pkg_add libtool
pkg_add libpqxx
I recommend starting with libpqxx because it seems to lag the postgresql-client
package, and installing libpqxx will get the correct client.
pkg_add postgresqlNN-server
Get the version number to match the client installed for pqxx.

Now follow the instructions:
* copy /usr/pkg/share/examples/rc.d/pgsql to /etc/rc.d/pgsql
* chmod 555 /etc/rc.d/pgsql
* append pgsql=YES to /etc/rc.conf

=== MacOS X ===

First, you will need the MacOS X developer tools installed.

Second, you will need to install libpqxx, zlib, and postgresql. Here is one approach:

You can use [[http://www.macports.org/ MacPorts]] to install as follows:
sudo port install libpqxx zlib postgresql84 postgresql84-server

Some instruction guides for installing PostgreSQL (such as the README for EnterpriseDB's version) suggest editing /etc/sysctl.conf and increasing the shmall setting from the default (8192 under Mac OS X 10.6, exactly 1/4096th of shmmax). Whatever number you choose for shmall, it should be (a) smaller than shmmax, and (b) divisible by 4096. For example, a valid value might be:
kern.sysv.shmall=65536

MacPorts might not create the user and group accounts for postgres. For some reason, most instructions for installing PostgreSQL from MacPorts seem to gloss over this issue. You may need to manually create the postgres User and Group. This is accomplished in two phases.

First, identify the last user and group IDs already present.
sudo dscl . -list /Users UniqueID | sort -n -k 2 | tail -n 1
sudo dscl . -list /Groups PrimaryGroupID | sort -n -k 2 | tail -n 1
For each, take the number shown and add 1. These are your UniqueID and PrimaryGroupID numbers.

Second, replace the ### in the following commands as indicated to create the user and group.
sudo dscl . -create /Users/postgres UniqueID ###
sudo dscl . -create /Users/postgres PrimaryGroupID ###
sudo dscl . -create /Users/postgres HomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres RealName "PostgreSQL Administrator"
sudo dscl . -create /Users/postgres Password \*
sudo dscl . -create /Groups/postgres PrimaryGroupID ###
sudo dscl . -create /Groups/postgres Password \*

The following instructions must be performed after installing PostgreSQL. If the 'chown' step fails, then you're probably missing the user and group settings indicated above.
sudo mkdir -p /opt/local/var/db/postgresql84/defaultdb
sudo chown postgres:postgres /opt/local/var/db/postgresql84/defaultdb
sudo su postgres -c '/opt/local/lib/postgresql84/bin/initdb -D /opt/local/var/db/postgresql84/defaultdb'
sudo launchctl load -w /Library/LaunchDaemons/org.macports.postgresql84-server.plist

The last line above should cause the server to start on reboot. To start the server now:
sudo su postgres -c '/opt/local/lib/postgresql84/bin/postgres -D /opt/local/var/db/postgresql84/defaultdb'

==== Security Suggestion ====
For some installations of Postgres, experts recommend an additional step:
sudo dscl . -create /Users/postgres UserShell /usr/bin/false
After setting this up, you'll lose the ability to su to the postgres account to run other programs. So, this is a step you might take only after getting everything else working. To revert this step:
sudo dscl . -create /Users/postgres UserShell /bin/bash

== Database Setup ==

=== NetBSD pkgsrc ===

Copy moss_uuidgen.so to /usr/pkg/lib/postgresql/

The database user is <tt>pgsql</tt>. It has root access to the DB by default.
Connect from localhost (the default).

Create the database:
su -m pgsql -c "psql postgres"
create database moss with encoding='UTF8';
\c moss
create role moss with login;
\q
su -m pgsql -c "psql postgres -f moss.sql"

Then set db_user=moss in moss_backend.cfg.

=== MacOS X ===

{{tba}}

== Additional Notes ==

=== MacOS X ===

The bootstrap.sh file does not currently work because libtoolize is named glibtoolize under MacOS. A patch has been submitted. With the patched boostrap, you'll just need to <code>export LIBTOOLIZE=glibtoolize</code>.

If you installed PostgreSQL and libpqxx from MacPorts, your configure command line will need to look like this:
./configure --with-postgres=/opt/local/lib/postgresql84 --with-libpqxx=/opt/local

In the postgres subdirectory, the Makefile for the UUID generator expects pg_config to be in your PATH.
export PATH=${PATH}:/opt/local/lib/postgresql84/bin

The UUID generator Makefile may also fail because the MacPorts package doesn't automate linking to SSL. Alternate Makefile:
MODULE_big = moss_uuidgen
SHLIB_LINK += -lssl
PGXS := $(shell pg_config --pgxs)
include $(PGXS)

[[Category:MOSS]]

MOSS/Distribution Specific Instructions

2011-11-03T01:49:02Z

Marten: /* MacOS X */

This document is meant to collect any known distribution-specific instructions
for installing MOSS. There are two main parts: installing the prerequisite
packages, and setting up the PostgreSQL database. Feel free to add any other
notes you may find useful.

== Prerequisite Packages ==

=== NetBSD pkgsrc ===

Only PostgreSQL and the autotools are needed. You can build the packages
or use the prebuilt packages with pkg_add.

pkg_add automake
pkg_add libtool
pkg_add libpqxx
I recommend starting with libpqxx because it seems to lag the postgresql-client
package, and installing libpqxx will get the correct client.
pkg_add postgresqlNN-server
Get the version number to match the client installed for pqxx.

Now follow the instructions:
* copy /usr/pkg/share/examples/rc.d/pgsql to /etc/rc.d/pgsql
* chmod 555 /etc/rc.d/pgsql
* append pgsql=YES to /etc/rc.conf

=== MacOS X ===

First, you will need the MacOS X developer tools installed.

Second, you will need to install libpqxx, zlib, and postgresql. Here is one approach:

You can use [[http://www.macports.org/ MacPorts]] to install as follows:
sudo port install libpqxx zlib postgresql84 postgresql84-server

Some instruction guides for installing PostgreSQL (such as the README for EnterpriseDB's version) suggest editing /etc/sysctl.conf and increasing the shmall setting from the default (8192 under Mac OS X 10.6, exactly 1/4096th of shmmax). Whatever number you choose for shmall, it should be (a) smaller than shmmax, and (b) divisible by 4096. For example, a valid value might be:
kern.sysv.shmall=65536

MacPorts might not create the user and group accounts for postgres. For some reason, most instructions for installing PostgreSQL from MacPorts seem to gloss over this issue. You may need to manually create the postgres User and Group. This is accomplished in two phases.

First, identify the last user and group IDs already present.
sudo dscl . -list /Users UniqueID | sort -n -k 2 | tail -n 1
sudo dscl . -list /Groups PrimaryGroupID | sort -n -k 2 | tail -n 1
For each, take the number shown and add 1. These are your UniqueID and PrimaryGroupID numbers.

Second, replace the ### in the following commands as indicated to create the user and group.
sudo dscl . -create /Users/postgres UniqueID ###
sudo dscl . -create /Users/postgres PrimaryGroupID ###
sudo dscl . -create /Users/postgres HomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres RealName "PostgreSQL Administrator"
sudo dscl . -create /Users/postgres Password \*
sudo dscl . -create /Groups/postgres PrimaryGroupID ###
sudo dscl . -create /Groups/postgres Password \*

The following instructions must be performed after installing PostgreSQL. If the 'chown' step fails, then you're probably missing the user and group settings indicated above.
sudo mkdir -p /opt/local/var/db/postgresql84/defaultdb
sudo chown postgres:postgres /opt/local/var/db/postgresql84/defaultdb
sudo su postgres -c '/opt/local/lib/postgresql84/bin/initdb -D /opt/local/var/db/postgresql84/defaultdb'
sudo launchctl load -w /Library/LaunchDaemons/org.macports.postgresql84-server.plist

==== Security Suggestion ====
For some installations of Postgres, experts recommend an additional step:
sudo dscl . -create /Users/postgres UserShell /usr/bin/false
After setting this up, you'll lose the ability to su to the postgres account to run other programs. So, this is a step you might take only after getting everything else working. To revert this step:
sudo dscl . -create /Users/postgres UserShell /bin/bash

== Database Setup ==

=== NetBSD pkgsrc ===

Copy moss_uuidgen.so to /usr/pkg/lib/postgresql/

The database user is <tt>pgsql</tt>. It has root access to the DB by default.
Connect from localhost (the default).

Create the database:
su -m pgsql -c "psql postgres"
create database moss with encoding='UTF8';
\c moss
create role moss with login;
\q
su -m pgsql -c "psql postgres -f moss.sql"

Then set db_user=moss in moss_backend.cfg.

=== MacOS X ===

{{tba}}

== Additional Notes ==

=== MacOS X ===

The bootstrap.sh file does not currently work because libtoolize is named glibtoolize under MacOS. A patch has been submitted. With the patched boostrap, you'll just need to <code>export LIBTOOLIZE=glibtoolize</code>.

If you installed PostgreSQL and libpqxx from MacPorts, your configure command line will need to look like this:
./configure --with-postgres=/opt/local/lib/postgresql84 --with-libpqxx=/opt/local

In the postgres subdirectory, the Makefile for the UUID generator expects pg_config to be in your PATH.
export PATH=${PATH}:/opt/local/lib/postgresql84/bin

The UUID generator Makefile may also fail because the MacPorts package doesn't automate linking to SSL. Alternate Makefile:
MODULE_big = moss_uuidgen
SHLIB_LINK += -lssl
PGXS := $(shell pg_config --pgxs)
include $(PGXS)

[[Category:MOSS]]

Foundry Certificate Installation

2011-10-20T18:26:26Z

Marten: Chrome certificate install fixes

{{draft}}
The OpenUru.org Foundry tools such as JIRA bugtracking use SSL (Secure Sockets Layer) to encrypt transactions and to give confidence that you are connected to the correct server. Currently, this is a "self-signed" certificate and not one that has been validated by the main certificate authorities, so most browsers will display a warning when you navigate to one of the Foundry pages.

You can avoid these warnings by installing the certificate in your browser's certificate store. This can be done when you first visit the foundry, but the methods vary greatly across browsers. It is perhaps easier to manually install the certificate before visting the Foundry. The certificate will also need to be installed in repository tools (Mercurial or Subversion) if you intend using SSL to access the Foundry repositories.

The instructions given here relate to the Windows versions of the applications.

== Obtaining the Certificate ==

(For manual installation into applications not listed below)

Download a copy of the certificate using this link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]

== Browser Installation ==

Please read the instructions so you know what to do '''before''' clicking on the link to the certificate, or right click the link and open it in a new tab or window.

=== Firefox ===
Click on the following link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]
A popup will appear titled "Downloading Certificate". Mark the check box for "Trust this CA to identify web sites" then click "OK" (you may wish to click "View" to check the certificate details first). The certificate is now installed, and when visiting the Foundry you should see the padlock symbol at the bottom right of your browser: hovering the mouse pointer over this should show "Authenticated by OpenUru.org"

'''Note:''' Firefox 3.6.0 contains a bug which may cause loss of data when using JIRA - users should upgrade their Firefox installation to 3.6.2 or later.

=== Internet Explorer ===

Click on the following link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]
A popup will appear titled "File Download - Security Warning". Click "Open" and the certificate details will be displayed in a new popup wher you can inspect them. On the "General" tab, click "Install Certificate...". When the Certificate Import Wizard appears click "Next>", then on the Certificate Store page select "Automatically select the certificate store based on the type of certificate" and click "Next>" and then "Finish". Another popup will appear titled "Security Warning" and asking "Do you want to install this certificate?" - Click "Yes". You should get a message telling you that the import was successful. Click "OK" on any remaining dialog boxes. The certificate is now installed, and when visiting the Foundry you should see the padlock symbol to the right of the URL bar with a blue background.

'''Note:''' If you install the certificate using Internet Explorer as described above, then you should find that the certificate will automatically be trusted by Safari and Chrome browsers on the same machine, since both of these use the Windows Internet Settings.

=== Google Chrome ===
Chrome (under Microsoft Windows) uses the same certificate store as Internet Explorer, so the process is very similar: Click on the following link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]
The "Downloads" popup will appear along with another window asking if you want to open or save the file "foundry.crt". Click "Open" and a new popup will appear titled "File Download - Security Warning". Click "Open" and the certificate details will be displayed in a new popup wher you can inspect them. On the "General" tab, click "Install Certificate...". When the Certificate Import Wizard appears click "Next>", then on the Certificate Store page select "Automatically select the certificate store based on the type of certificate" and click "Next>" and then "Finish". Another popup will appear titled "Security Warning" and asking "Do you want to install this certificate?" - Click "Yes". You should get a message telling you that the import was successful. Click "OK" on any remaining dialog boxes. The certificate is now installed, and when visiting the Foundry the padlock symbol on the left of the URL bar should turn green. However, you may need to restart your browser before the certificate is recognized.

=== Apple Safari ===
On Microsoft Windows, Safari uses the same certificate store as Internet Explorer, so the process is very similar: Click on the following link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]
The "Downloads" popup will appear along with another window asking if you want to open or save the file "foundry.crt". Click "Open" and a new popup will appear titled "File Download - Security Warning". Click "Open" and the certificate details will be displayed in a new popup wher you can inspect them. On the "General" tab, click "Install Certificate...". When the Certificate Import Wizard appears click "Next>", then on the Certificate Store page select "Automatically select the certificate store based on the type of certificate" and click "Next>" and then "Finish". Another popup will appear titled "Security Warning" and asking "Do you want to install this certificate?" - Click "Yes". You should get a message telling you that the import was successful. Click "OK" on any remaining dialog boxes. The certificate is now installed, and when visiting the Foundry you should see the padlock symbol to the right of the URL bar.

=== Opera ===
Using the Opera browser to access an SSL page on the Foundry will cause the browser to raise a "Security Issue" popup box. The text in this box says ''The server's certificate chain is incomplete, and the signer(s) are not registered. Accept?'' You can examine the description of the certificate with the "Security" tab on this popup. If you are satisfied with the information and wish to use the certificate, click the ''Approve'' button, and the certificate will be stored in Opera's trusted certificate list, and you will be able to browse secured pages from the Foundry.

If you wish to manually install the certificate in Opera, click on the certificate link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]. A "Install Certificate" popup window will appear, showing the certificate from '''foundry.openuru.org''' You can click the "View" button to display information about the certificate. You can then click the "Install" button to install the certificate or "Cancel" to ignore the certificate and not change Opera's certificate list.

== Repository Installation ==

=== TortoiseHg 2.0.x (Mercurial) ===
If you have tried to use the "Clone Repository" command to create the Mercurial repository and found that it came back with an error like "SSL: Server certificate verify failed" then try the steps below.
# Open TortoiseHg Workbench
# Click on New Repository in the File Menu
# Browse to the folder that you want to save the source to. This folder must be empty.
# Now the buttons on the toolbar close to the top of the window should be lit up.
# Select the green recycle-like icon that will bring up the synchronize settings in the lower part of the screen under '''Remote Repository'''
# In the drop down box select: '''https'''
# In the first box put '''foundry.openuru.org/hg'''
# In the last box on that line put the project name (e.g CWE) see the [http://www.openuru.org/pages/Development.php Development] page under Foundry Repositories
# Now click on the '''Padlock Button''' next to the drop down box
# Choose the second option '''Verify with stored host fingerprint (good)''' under Secure HTTPS Connection and Click '''Query'''. The fingerprint is (as of this writing): <code>32:1b:b2:1c:9a:fe:d9:17:b0:78:76:ea:87:68:ad:1a:34:ab:a8:8e</code>
# Put your Username (all lowercase) and Password for your JIRA Account in the appropriate boxes and click '''Save'''
# On the right hand side of the screen is a '''Save''' button click it and the Save on the window that pops up
# On the same toolbar used in step 5. Click on the button with the two yellow cylinders and the green arrow pointing towards you. This is the '''Pull incoming changes''' button.
# After the download is complete you must update the local repository before being able to use it. Open the Output Log either by using Ctrl + L or in the View menu as '''Show Output Log'''
# After the % sign on the last line of the Output Log type: <code>hg update</code>
# You should get a command completed successfully line.
# You are now ready to work on/view the code.

=== TortoiseSVN (Subversion) ===
There is no requirement to install the certificate for TortoiseSVN.

=== MacHg (Mercurial) ===
# Append the certificate to the end of your ~/Library/Application Support/MacHg/TrustedCertificates.pem file.

MOSS/Distribution Specific Instructions

2011-10-20T09:14:25Z

Marten: /* MacOS X */ how to build the uuid generator on Mac OS X

This document is meant to collect any known distribution-specific instructions
for installing MOSS. There are two main parts: installing the prerequisite
packages, and setting up the PostgreSQL database. Feel free to add any other
notes you may find useful.

== Prerequisite Packages ==

=== NetBSD pkgsrc ===

Only PostgreSQL and the autotools are needed. You can build the packages
or use the prebuilt packages with pkg_add.

pkg_add automake
pkg_add libtool
pkg_add libpqxx
I recommend starting with libpqxx because it seems to lag the postgresql-client
package, and installing libpqxx will get the correct client.
pkg_add postgresqlNN-server
Get the version number to match the client installed for pqxx.

Now follow the instructions:
* copy /usr/pkg/share/examples/rc.d/pgsql to /etc/rc.d/pgsql
* chmod 555 /etc/rc.d/pgsql
* append pgsql=YES to /etc/rc.conf

=== MacOS X ===

First, you will need the MacOS X developer tools installed.

Second, you will need to install libpqxx, zlib, and postgresql. Here is one approach:

You can use [[http://www.macports.org/ MacPorts]] to install as follows:
sudo port install libpqxx zlib postgresql84 postgresql84-server

Some instruction guides for installing PostgreSQL (such as the README for EnterpriseDB's version) suggest editing /etc/sysctl.conf and increasing the shmall setting from the default (8192 under Mac OS X 10.6, exactly 1/4096th of shmmax). Whatever number you choose for shmall, it should be (a) smaller than shmmax, and (b) divisible by 4096. For example, a valid value might be:
kern.sysv.shmall=65536

MacPorts might not create the user and group accounts for postgres. For some reason, most instructions for installing PostgreSQL from MacPorts seem to gloss over this issue. You may need to manually create the postgres User and Group. This is accomplished in two phases.

First, identify the last user and group IDs already present.
sudo dscl . -list /Users UniqueID | sort -n -k 2 | tail -n 1
sudo dscl . -list /Groups PrimaryGroupID | sort -n -k 2 | tail -n 1
For each, take the number shown and add 1. These are your UniqueID and PrimaryGroupID numbers.

Second, replace the ### in the following commands as indicated to create the user and group.
sudo dscl . -create /Users/postgres UniqueID ###
sudo dscl . -create /Users/postgres PrimaryGroupID ###
sudo dscl . -create /Users/postgres HomeDirectory /opt/local/var/db/postgresql84
sudo dscl . -create /Users/postgres UserShell /usr/bin/false
sudo dscl . -create /Users/postgres RealName "PostgreSQL Administrator"
sudo dscl . -create /Users/postgres Password \*
sudo dscl . -create /Groups/postgres PrimaryGroupID ###
sudo dscl . -create /Groups/postgres Password \*

The following instructions must be performed after installing PostgreSQL. If the 'chown' step fails, then you're probably missing the user and group settings indicated above.
sudo mkdir -p /opt/local/var/db/postgresql84/defaultdb
sudo chown postgres:postgres /opt/local/var/db/postgresql84/defaultdb
sudo su postgres -c '/opt/local/lib/postgresql84/bin/initdb -D /opt/local/var/db/postgresql84/defaultdb'
sudo launchctl load -w /Library/LaunchDaemons/org.macports.postgresql84-server.plist

== Database Setup ==

=== NetBSD pkgsrc ===

Copy moss_uuidgen.so to /usr/pkg/lib/postgresql/

The database user is <tt>pgsql</tt>. It has root access to the DB by default.
Connect from localhost (the default).

Create the database:
su -m pgsql -c "psql postgres"
create database moss with encoding='UTF8';
\c moss
create role moss with login;
\q
su -m pgsql -c "psql postgres -f moss.sql"

Then set db_user=moss in moss_backend.cfg.

=== MacOS X ===

{{tba}}

== Additional Notes ==

=== MacOS X ===

The bootstrap.sh file does not currently work because libtoolize is named glibtoolize under MacOS. A patch has been submitted. With the patched boostrap, you'll just need to <code>export LIBTOOLIZE=glibtoolize</code>.

If you installed PostgreSQL and libpqxx from MacPorts, your configure command line will need to look like this:
./configure --with-postgres=/opt/local/lib/postgresql84 --with-libpqxx=/opt/local

In the postgres subdirectory, the Makefile for the UUID generator expects pg_config to be in your PATH.
export PATH=${PATH}:/opt/local/lib/postgresql84/bin

The UUID generator Makefile may also fail because the MacPorts package doesn't automate linking to SSL. Alternate Makefile:
MODULE_big = moss_uuidgen
SHLIB_LINK += -lssl
PGXS := $(shell pg_config --pgxs)
include $(PGXS)

[[Category:MOSS]]

MOSS/Distribution Specific Instructions

2011-10-20T07:48:24Z

Marten: /* MacOS X */ fixed command line example

MOSS/Distribution Specific Instructions

2011-10-20T07:43:41Z

Marten: /* MacOS X */ add the shmem and user settings for macports

MOSS/Distribution Specific Instructions

2011-10-20T06:35:51Z

Marten: MacOS X fixes... can't mix MacPorts and EnterpriseDB Postgres.

MOSS/Distribution Specific Instructions

2011-10-20T06:17:32Z

Marten: More MacOS X

Talk:Instancing - Bookmarks

2011-10-20T04:51:19Z

Marten: /* Response to 75th's thoughts */ new section

== TOC ==

I've restored the <nowiki>{{TOClimit}}</nowiki> template call with a level limit of 2 (as you had tried originally). I'm not sure if that's really what you meant, since that only gives the top level headings (which are actually level 2 headings). TOClimit without a parameter gives you the level 2 and level 3 headings: [[Template:TOClimit/doc]]. -- [[User:Mac Fife|Mac Fife]] 08:03, 29 January 2009 (UTC)

== 75th Trombone's thoughts ==

''"In this proposal, a player can reach a friend's Age by … [joining] a group where the friend is leader. Use the Group Journey bookmark with any book or Bahro stone that links to the friend's collected and unlocked Age."''

How do you alert users if they attempt to put your bookmark on a Book to an Age that you don't have? If you don't show your bookmarks on such books but do show them on others, how do players know why your bookmark doesn't always appear?

I don't think it's very intuitive to put a piece of cloth with my name on a Book to change where that Book goes; it's much, much more clear what's going on when you actually use my Relto bookshelf.

The main problem I see your proposal solving is letting groups regather after getting separated from the leader. I think the simplest, best, and most understandable way of doing this is providing them an easy way to get back to my Relto and use my unlocked books again.

== Response to 75th's thoughts ==

Replying some 2 years later... since Open Source is finally upon us, I felt like fleshing out my thoughts a bit.

It's clear that I've failed to convey some parts of my concept adequately, that leads to some of the blanks being filled in with things I didn't mean or say... so I will do my best to clarify.

''How do you alert users if they attempt to put your bookmark on a Book to an Age that you don't have? If you don't show your bookmarks on such books but do show them on others, how do players know why your bookmark doesn't always appear?''

A person cannot move another person's bookmark from one book to another. If your question was instead, "How do you alert a user when he or she attempts to use his or her (group) bookmark on a book that the group leader does not possess?", I have an answer for that. The way I had intended this to work was that the group bookmark would not be selectable. It would be present (because if you are in a group, group bookmarks appear, and if you are not in a group, they don't) but it would be disabled in some visual, meaningful way (maybe a symbol on it turns red?). If a user clicks on the disabled bookmark, a pop-up could provide an explanation that the group leader does not possess the book. (I feel there has to be some compromise between an interface that is unobtrusive and doesn't break the 4th wall, and being able to explain to users why they cannot do a thing. Uru is full of enough undocumented user interfaces already. Basic gameplay should not be a puzzle unto itself.)

''I don't think it's very intuitive to put a piece of cloth with my name on a Book to change where that Book goes; it's much, much more clear what's going on when you actually use my Relto bookshelf.''

''The main problem I see your proposal solving is letting groups regather after getting separated from the leader.''

Cloths wouldn't have names on them, nor do they really change "where a book goes"; laying a bookmark across a Myst book does not cause it to link to Tomahna instead. There would be a "Solo journey" bookmark and a "Group journey" bookmark, not even represented with words but by symbols (single hand vs two hands), and by laying one across a book, it changes the instancing rules. Though I didn't say it before, I think the mechanics of these bookmarks would need to be introduced to a new player in some story-integral way to address the "is this intuitive?" issue.

I agree that what happens when you use your Relto bookshelf is nice and clear, but unfortunately, Relto's behavior cannot be applied as a model throughout the game, and I would object to being required to travel to Relto to be part of a group (and I'm sure I would not be alone in my protest).

My proposal is intended to solve more than mere group mechanics. I'm trying to lay down not just a consistent approach to instancing, but also a logical one that separates Yeesha magic from D'ni technology. This is a huge sticking point for me.

Why am I able to reach my private instances from Nexus? Why am I able to share invites so that other people can reach my instances through the Nexus? These are gameplay mechanics that Cyan added to avoid the "must always go to Relto to be in a group" problem, but it breaks the rules. The books in Relto can use Yeesha magic, that they even appear there at all is Yeesha magic, but Nexus is technology; it shouldn't have multiple Teledahn books leading to different instances.

The idea that the user has 2 magic bookmarks, given to him or her by Yeesha, solves this issue universally throughout the game. Any book you lay a bookmark over would be touched by Yeesha's magic; suddenly, it can lead you to a private version all your own, or shared just with your friends. Remove the bookmark, and it's a normal linking book again like those in Myst and Riven, and touching it will only take you to the "real" or "prime" version of the Age.

MOSS/Distribution Specific Instructions

2011-10-20T00:10:18Z

Marten:

MOSS/Distribution Specific Instructions

2011-10-20T00:01:39Z

Marten: Mac OS X info

MOSS/Project Ideas

2011-10-19T23:49:45Z

Marten:

The initial list was generated over the lengthy period of MOSS's initial
development. These project ideas mostly cover missing functionality. None of
the missing functionality is known to cause gameplay issues so these did not
really seem like bugs. These ideas are grouped by general type of change
required, and sort of by increasing approximate difficulty level and sort of by
decreasing value.

Bigger ideas, such as entirely new functionality now made possible by the
release of the client, could go here too. Be realistic, though. Remember that
protocol changes are not to be made lightly, because it causes an
incompatibility problem. It is probably better to propose large changes in
discussion format on the forums. Do not ''expect'' someone else to take up and
implement your proposal.

The whole idea of this list is to provide some ideas for anyone wishing to dive
into MOSS. Sometimes a little direction helps.

== Terminology ==
The terms "frontend" and "backend" are used throughout this document. If the meaning is not clear from context, the terminology is explained in the [[MOSS-Developer_Notes#terminology | Developer Notes]].

The "vault" is basically the database, though it could be abstractly thought of as a collection of trees of vault nodes. Generally when referring to it as a set of node trees, "vault" is written and when referring to it as something with tables and rows, "DB" is written. The "vault server" is that portion of the backend concerned with handling the Vault* messages and working with the database.

== Fix bugs ==

The bug tracker is here: https://foundry.openuru.org/jira/browse/MOSS

== Detail work (little Uru-specific knowledge required) ==

* Try disabling the Nagle algorithm on sockets. This should result in less latency to the client when small messages are involved. Make sure to test the whole game thoroughly.

* Figure out and implement a good way to use autoconf to compile in default pathnames. This would apply to the default config file, key file, moss_serv binary, and log/auth/game/file directory locations. The idea is if I say --prefix=/foo the defaults become /foo/etc/moss.cfg and so forth instead of ./etc/moss.cfg. Don't forget autoconf lets you override the etcdir, bindir, etc. separately.

* Treat SDL filenames case-insensitively. This is very annoying in Unix, since it requires using readdir() and strcasecmp() instead of just open().

* Make it so the game/state directory location can be separately configured. This is so the whole MOSS install can be read-only and just the log directory and game/state moved somewhere read-write. (The easy workaround is to symlink a writable directory to game/state.)

* Log the PID of all forked servers in moss.log.

* See if we can switch to libevent for inter-thread communication instead of raw signals. This should be fairly portable and take advantage of the different per-OS lightweight signalling mechanisms.

* Allow ''skipping'' overlong messages (messages MOSS thinks are too big). This requires, upon catching the exception, tossing out the message, and if it has not all been read in yet, keeping track of how much more to toss in the future. The RC4 state must be updated too for the tossed message length.

* It would be nice to use atomic operations for refcounts instead of having to use (bigger, slower) mutexes for them. This does make MOSS not architecture-independent, which is part of why I have been resisting it. (See also signal handling next.)

* Signal handlers and the operations to read and reset the values in the main loops should be using atomic operations.

* Catch and handle std::bad_alloc whenever possible.

== Fairly contained changes ==

* Make it so game servers can be forked as separate processes. This helps a lot for debugging and also would help for age development, making it easier to change SDL and retest. Otherwise you have to shut down the whole frontend server or wait out the age's linger time. This work was started but not completed, and that code can be found inside <tt>FORK_GAME_TOO</tt> #ifdefs. If you do this, I suggest you consider separating <tt>FORK_GAME_TOO</tt> from <tt>FORK_ENABLE</tt> so that one could have forked game servers and *not* forked auth/file servers.

* In the getpublicagelist() SQL function, there is a comment about the 50-hood limit. The current code returns the first 50 hoods. We should return the most recently used 50 hoods. The hard part is knowing which those are. This is mostly if not wholly DB/SQL work.

* Age population limits are unimplemented. The value is in the vault, but the server does not look at it.

* Figure out how to throw out clones and SDL when a player leaves the age. Please see the "clean up clone, SDL" section in GameServer::conn_shutdown(). Right now this is full of special cases: it handles the Kemo bugs and and Quabs specially (a different thing for each). It may be that this is required for best behavior, but I still feel like I've missed something despite heavy scrutiny of the data. This is more of a research project and not much of a code project.

* MOUL parsed SDL nodes on the way into the vault. It probably only updated the node with fields having the Dirty bit set. In addition it added timestamps to the fields because the client does not put in the timestamps (reasonably so, as its time may be wrong). MOSS currently saves the SDL wholesale. This basically works, but with the timestamps properly added, the game server can merge the vault, age, and global SDL in any order and without strange rules. Note: if you do this, you also need to write a script or some other way to update all the SDL nodes in existing MOSS DBs.

* The kickable SDL filtering algorithm is the same one I put in Alcugs ages ago. It is better than nothing but not as good as Plasma's. You will see more warping of kickables than with Cyan's server. This project is to come up with a better way of deciding what physical SDL to send to all the clients, based on those messages all the clients are sending to the server.

* The server is probably supposed to use RelevanceRegion information to avoid sending SDL updates to clients who don't share a relevance region with the originating client. (The idea being to reduce network traffic, since hopefully the client already avoids rendering/physics on things in irrelevant regions.) Things work if the server doesn't filter, so MOSS doesn't. Also, I do not have strong evidence to believe this supposition is actually correct. Which is the other reason MOSS doesn't do it. Finding out, and implementing it if so, would be a nice project.

* Figure out what the server is supposed to do with plSetNetGroupIDMsg and do it. Right now MOSS just drops it to no apparent ill effect. I am deeply suspicious of this message due to seeing it at aurally unpleasant times in UU. (Old, old notes: "may have to do with infinitely looping scraping noises".)

* <tt>kCli2Auth_SendFriendInviteRequest</tt> is not fully supported (it is dropped on the floor).

== Bigger changes ==

* The following messages are unimplemented.
** <tt>kCli2Auth_VaultSetSeen</tt> -- unimplemented in client
** <tt>kCli2Auth_ScoreDelete</tt> -- never saw one, so couldn't implement it
** <tt>kCli2Auth_ScoreSetPoints</tt> -- never saw one, so couldn't implement it
** <tt>kCli2Auth_ScoreGetRanks</tt> -- never saw one, so couldn't implement it
** <tt>kCli2Csr_PingRequest</tt> -- no recorded Csr messages
** <tt>kCli2Csr_RegisterRequest</tt>
** <tt>kCli2Csr_LoginRequest</tt>
** <tt>kCsr2Cli_PingReply</tt>
** <tt>kCsr2Cli_RegisterReply</tt>
** <tt>kCsr2Cli_LoginReply</tt>

* Add hood randomization to DRC hoods. Player-created hoods are randomized by the Python in the Nexus when the hood is created. DRC hoods, however, are created by the server. In MOSS's case, they are created entirely by SQL code. So adding DRC hood randomization means noticing when the DB has created a new DRC hood, creating and modifying SDL in the backend, and then finding and modifying the age SDL node for that new hood. All before responding to the client creating the new avatar and thus the new DRC hood.

* The MessageQueue class has a concept of priorities. The idea was to enable dropping of lower-priority messages if a queue to a given client starts to back up. (The lowest priority being voice chat, then avatar movements, with world state changes being highest.) The measurement of queue length or throughput necessary for that is not implemented. So, neither is the dropping. (There is the very beginnings of some if <tt>DO_PRIORITIES</tt> is #defined.) As such, queue users don't do a good job of priority-setting, although VOICE and FRONT are properly used. The idea wasn't to order the queue (except for FRONT), but to skip sending, say, a VOICE message when we encounter one, if the queue congestion measure says to.

* '''Vault security'''
: The MOSS vault is as insecure as the MOUL vault. Need I say more? Here are some starter thoughts.
:* MOSS should parse incoming SDL messages and sanity-check them. See also [[#SDL_timestamps | adding timestamps]].
:* MOSS could probably verify other blob contents too.
:* Anyone can save anything to any node, and can fetch any node if they know its type and ID. We can deny these requests if the user shouldn't have access. Possibly [[MOSS-Developer_Notes#notifier | the notifier field]] can help.
:* Much more, I'm sure. Better vault security ''is'' possible.

* Eliminate excessive byteswapping of opaque server IDs in BackendMessages. This is to say, in the backend server, when reading in the messages, it byte-swaps the IDs to store them, only ever uses them in equality tests with other IDs, and then byte-swaps them back when sending new messages. (On a little-endian box there's no swapping so it does not cost much, but it's the principle of the matter.) Unfortunately this really needs to be tested on a big-endian machine.

* Try changing the File server to do [[MOSS-Setup#ackless | ackless downloads]], too. Maybe only if there is only one download at a time, though.

== Scalability issues ==

Performance and scalability are always interesting questions. And frequently ignored, because they only matter for larger installations.

These are ideas unimplemented because they only really matter for large
shards. Large as in having, let's say, 50+ concurrent '''busy''' users. (50
people standing in the city chatting doesn't actually do much.) Maybe MOSS is
okay with that number now, in which case "large" is more. It is entirely
unknown.

* Performance testing. Instrumentation. There should be a load generator to do this. This was not high on the list during development, with a user base of 3.

* See the last paragraph in the comments at the top of FileTransaction.h about how multiple file transactions of the same file should share a single opened file.

* Allow speculative pre-caching of AgeInfoNodes and PlayerInfoNodes when node changed notifications come from the vault server and are forwarded to any connected client. Cache in the auth server, vault server, or both. The goal is to reduce latency on those requests the client freezes for.

* The backend protocol supports game servers requesting batches of GameMgr IDs. However, there is no code on either side to actually do so. The idea for this was that more populated ages, like the city, would benefit from doing batch requests. Every person who links in with a marker game needs a new global game ID, and it would be nice to cut out any extra backend round trips for links, even though this particular round trip does not block the link process (aside from being something the backend is doing when it could be doing something else).

* Database performance could be measured and the SQL or even tables optimized.

* MOSS currently uses a single blocking connection to the DB. Implement and investigate performance of multiple DB connections, or asynchronous ones. Maybe the backend server has to become threaded to gain the best advantage.

* In a big shard, we may need to split the backend server work up. The [[MOSS-Developer_Notes#backend_typecodes | backend protocol]] is designed to support separating backend work between threads. The "classes" of backend messages in a bitfield are meant as a way to quickly route a backend message to an appropriate backend thread or process.

== Frontend/backend interactions ==

* Add encryption to the backend protocol. This itself is not a big deal (though you have to pick a good key negotiation, and do not forget to consider authentication mechanisms), but it does mean all the BackendMessage fill_buffer() code paths would be newly exercised, so a lot of regression testing would be in order.

* It would be much easier on the DB if updates to markers are batched by the game server. This especially applies to capturing markers. See the comments in the setmarkerto() and startmarkergame() SQL functions.

* The backend protocol allows for frontends hosting ages to specify only a subset of ages that can be hosted there. This is unused right now; the message has a field saying, "this is the length of the following age restriction list" and it is always zero. When there are no restrictions the backend can request any frontend to host any age.
** The need for splitting hostable ages is unclear, but in a very large shard you might, for example, put all city instances, or even only the public one, on a separate server. It would also allow someone to join a shard and host just their own age, or whatever.
** Since the frontend never sends restrictions, the backend currently has no way to store and use them. So there is work on both sides.
** Presumably which ages a frontend server can host would be a configuration option but it could be done instead by restricting the contents of the game/age directory. That would not allow even finer-grained restrictions, but this whole project kind of needs a real use case to flesh out what is needed.

* Having one backend TCP connection per frontend server is probably not a good thing, in terms of efficiency, or of scalability with a cluster of machines. We could change it to have one backend connection per frontend ''process'' and funnel everything through it. The mostly-implemented but unused and untested MultiWriterMessageQueue was meant, in part, to support this (there are multiple threads writing, but only one thread reading, which writes to the socket).

: Then when messages are received in the frontend there needs to be some way of passing the message to the right thread and signaling them something is present to be handled. This is all unimplemented but the format of the backend messages is meant to take care of this case (in particular, the two "server IDs" in the header are for dispatching messages to the correct thread).

: However, essentially the same changes would be necessary if the backend server is folded into the main server so there is only one process; then "sending" messages to the backend server is just putting them on the (shared) queue that would have been used to funnel everything through one connection, and "receiving" them is just taking them off that queue since there's no TCP connection to deal with.

== New functionality ==

* I am guessing Cyan's server handles the GameMgr stuff with server-side scripting. At the time MOSS was implemented there was no expectation that new game types may be added so adding in a scripting language was not worth the problems incumbent with doing so. Also the overall value of scripting is not clear (especially for the cost in server complication). However, it could be done. The project would have to include embedding the scripting and then rewriting stuff using scripts.
: Please note, a lot of effort went into getting the Heek right, handling ties, allowing people to accidentally stand up and sit back down in the game, and probably other details I forgot. If you want to script Heek, it really ought to still work as well.

* Really adventurous hardcore project: destroy KI hacks. The server would have to be able to analyze all game traffic to decide whether it looks okay. To do it right the server would have to have and understand PRP files and do physics. Also "console" commands have to be wisely filtered. If you're daunted, join the club.

* Add a data export API; see Blizzard's Armory as an example. This could enable players to have web-visible "Achievements" and even allow for automation of integration with social media. This can add value to the game without requiring any client changes. A well-designed website taking advantage of this API might:
** Permit players to control privacy settings on whether their profiles should be public or private (default should be private!)
** View/Display their current game accomplishments (relto pages, sparks, ages completed)
** Enable automated posting to social media when the player accomplishes a new goal

== Redesigns ==
{{tba}}

[[Category:MOSS]]

Foundry Certificate Installation

2011-10-19T22:25:29Z

Marten: Added MacHG cert instruction.

{{draft}}
The OpenUru.org Foundry tools such as JIRA bugtracking use SSL (Secure Sockets Layer) to encrypt transactions and to give confidence that you are connected to the correct server. Currently, this is a "self-signed" certificate and not one that has been validated by the main certificate authorities, so most browsers will display a warning when you navigate to one of the Foundry pages.

You can avoid these warnings by installing the certificate in your browser's certificate store. This can be done when you first visit the foundry, but the methods vary greatly across browsers. It is perhaps easier to manually install the certificate before visting the Foundry. The certificate will also need to be installed in repository tools (Mercurial or Subversion) if you intend using SSL to access the Foundry repositories.

The instructions given here relate to the Windows versions of the applications.

== Obtaining the Certificate ==

(For manual installation into applications not listed below)

Download a copy of the certificate using this link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]

== Browser Installation ==

Please read the instructions so you know what to do '''before''' clicking on the link to the certificate, or right click the link and open it in a new tab or window.

=== Firefox ===
Click on the following link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]
A popup will appear titled "Downloading Certificate". Mark the check box for "Trust this CA to identify web sites" then click "OK" (you may wish to click "View" to check the certificate details first). The certificate is now installed, and when visiting the Foundry you should see the padlock symbol at the bottom right of your browser: hovering the mouse pointer over this should show "Authenticated by OpenUru.org"

'''Note:''' Firefox 3.6.0 contains a bug which may cause loss of data when using JIRA - users should upgrade their Firefox installation to 3.6.2 or later.

=== Internet Explorer ===

Click on the following link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]
A popup will appear titled "File Download - Security Warning". Click "Open" and the certificate details will be displayed in a new popup wher you can inspect them. On the "General" tab, click "Install Certificate...". When the Certificate Import Wizard appears click "Next>", then on the Certificate Store page select "Automatically select the certificate store based on the type of certificate" and click "Next>" and then "Finish". Another popup will appear titled "Security Warning" and asking "Do you want to install this certificate?" - Click "Yes". You should get a message telling you that the import was successful. Click "OK" on any remaining dialog boxes. The certificate is now installed, and when visiting the Foundry you should see the padlock symbol to the right of the URL bar with a blue background.

'''Note:''' If you install the certificate using Internet Explorer as described above, then you should find that the certificate will automatically be trusted by Safari and Chrome browsers on the same machine, since both of these use the Windows Internet Settings.

=== Google Chrome ===
Chrome (under Microsoft Windows) uses the same certificate store as Internet Explorer, so the process is very similar: Click on the following link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]
The "Downloads" popup will appear along with another window asking if you want to open or save the file "foundry.crt". Click "Open" and a new popup will appear titled "File Download - Security Warning". Click "Open" and the certificate details will be displayed in a new popup wher you can inspect them. On the "General" tab, click "Install Certificate...". When the Certificate Import Wizard appears click "Next>", then on the Certificate Store page select "Automatically select the certificate store based on the type of certificate" and click "Next>" and then "Finish". Another popup will appear titled "Security Warning" and asking "Do you want to install this certificate?" - Click "Yes". You should get a message telling you that the import was successful. Click "OK" on any remaining dialog boxes. The certificate is now installed, and when visiting the Foundry you should see the padlock symbol to the right of the URL bar.

=== Apple Safari ===
On Microsoft Windows, Safari uses the same certificate store as Internet Explorer, so the process is very similar: Click on the following link: [http://foundry.openuru.org/assets/Foundry/foundry.crt Foundry Certificate]
The "Downloads" popup will appear along with another window asking if you want to open or save the file "foundry.crt". Click "Open" and a new popup will appear titled "File Download - Security Warning". Click "Open" and the certificate details will be displayed in a new popup wher you can inspect them. On the "General" tab, click "Install Certificate...". When the Certificate Import Wizard appears click "Next>", then on the Certificate Store page select "Automatically select the certificate store based on the type of certificate" and click "Next>" and then "Finish". Another popup will appear titled "Security Warning" and asking "Do you want to install this certificate?" - Click "Yes". You should get a message telling you that the import was successful. Click "OK" on any remaining dialog boxes. The certificate is now installed, and when visiting the Foundry you should see the padlock symbol to the right of the URL bar.

=== Opera ===
{{tba}}

== Repository Installation ==

=== TortoiseHg 2.0.x (Mercurial) ===
If you have tried to use the "Clone Repository" command to create the Mercurial repository and found that it came back with an error like "SSL: Server certificate verify failed" then try the steps below.
# Open TortoiseHg Workbench
# Click on New Repository in the File Menu
# Browse to the folder that you want to save the source to. This folder must be empty.
# Now the buttons on the toolbar close to the top of the window should be lit up.
# Select the green recycle-like icon that will bring up the synchronize settings in the lower part of the screen under '''Remote Repository'''
# In the drop down box select: '''https'''
# In the first box put '''foundry.openuru.org/hg'''
# In the last box on that line put the project name (e.g CWE) see the [http://www.openuru.org/pages/Development.php Development] page under Foundry Repositories
# Now click on the '''Padlock Button''' next to the drop down box
# Choose the second option '''Verify with stored host fingerprint (good)''' under Secure HTTPS Connection and Click '''Query'''. The fingerprint is (as of this writing): <code>32:1b:b2:1c:9a:fe:d9:17:b0:78:76:ea:87:68:ad:1a:34:ab:a8:8e</code>
# Put your Username (all lowercase) and Password for your JIRA Account in the appropriate boxes and click '''Save'''
# On the right hand side of the screen is a '''Save''' button click it and the Save on the window that pops up
# On the same toolbar used in step 5. Click on the button with the two yellow cylinders and the green arrow pointing towards you. This is the '''Pull incoming changes''' button.
# After the download is complete you must update the local repository before being able to use it. Open the Output Log either by using Ctrl + L or in the View menu as '''Show Output Log'''
# After the % sign on the last line of the Output Log type: <code>hg update</code>
# You should get a command completed successfully line.
# You are now ready to work on/view the code.

=== TortoiseSVN (Subversion) ===
There is no requirement to install the certificate for TortoiseSVN.

=== MacHg (Mercurial) ===
# Append the certificate to the end of your ~/Library/Application Support/MacHg/TrustedCertificates.pem file.

Talk:75th Instancing

2009-02-12T05:20:58Z

Marten: New page: Questions: * (Marten) How does sharing work with this instancing plan? Examples: Can private instances be accessed through nexus? When traveling from Eder Gira to Eder Kemo, and one is...

Questions:

* (Marten) How does sharing work with this instancing plan? Examples: Can private instances be accessed through nexus? When traveling from Eder Gira to Eder Kemo, and one is in a friend's private Gira, does one land in the friend's Kemo without using "share book" ?

Observations/Objections:

* (Marten) Regarding the problem of "controlling who gets end-of-Age rewards" - this plan doesn't seem to solve that at all, it works just the same as MOUL from my reading of it. In MOUL, everyone in garden Ages got the reward together, so that's exactly the same. In MOUL, the problems involving rewards involved Ahnonay and then K'veer. Ahnonay was a private Age, not 'hood instanced and not public. Players had to invite others to complete the Age, but only the Age owner could obtain the final rewards from the Age. This annoyed some people. Then, the age of Myst was distributed through K'veer, which was a public Age but one that could only be reached if one had solved Ahnonay, and MYST was added to Relto's bookshelf and invites could be sent for it. (K'veer is not noted as being private in your list of private Ae'gura areas.) People who had not earned K'veer, and thus did not have access to MYST, were able to get to MYST through the Relto bookshelves of friends who had completed Ahnonay. Apparently this upset some people as well - including Cyan, who then disabled the ability to send invitations to MYST.

Instancing - Bookmarks

2009-02-08T08:09:56Z

Marten: /* Neighborhood */

Note: This page is a work in progress as I detail thoughts on my Instancing proposal.
-- Marten

TODO:
* Identify and add any missing Location/Link pairs
* Add detailed linking information for remaining Ages
* Identify how existing Yeesha bookmarks work with the proposal
* Discuss issues and possible solutions to [[http://forums.openuru.org/viewtopic.php?p=799#p799 Kenguin's Issues List]]
* Note which instances are "default" in which situations
* Resolve any lingering inconsistencies
* Begin related proposal for [[KI Interface:Group Management]]

{{TOClimit|2}}

==Objective==
Replace the Instancing system with a consistent model that gives players greater control. Under the MOUL model, some areas of the game could only be shared by neighbors; under the proposed model, players will be able to invite friends to share all areas of the game.

==Prerequisites==
* Performance Improvements for large groups in one Age
* Queuing system for high-population areas
* Grouping ("Party") System implemented into KI

==Origin of Concept==
First, this proposal is an attempt to incorporate the model of Instancing used in other popular multiplayer online games. A detailed description of Instancing as it applies in most MMOs can be found at http://en.wikipedia.org/wiki/Instance_dungeons, but the key idea is that players do not need to be independently invited to every instance they wish to visit together; players may ally themselves with friends to form a group or party such that all members automatically enter an instance together.

Second, this proposal is inspired by some unused assets hidden in the game files for Uru. One of the more intriguing assets is series of [http://mystonline.com/forums/viewtopic.php?t=16333 three hanging banners] (one blue, one red, and one purple) that can appear in the Museum area of Ae'gura. Each of the pedestals under the banners has a set of matching ribbons, although not all pedestals have all ribbons. The sequence of books and ribbons was as follows:
* Gahreesen: Red and Blue
* Teledahn: Purple, Red, Blue
* Kadish: Purple and Blue
* Ahnonay Cathedral: Purple and Blue
* Uran Silo: Purple and Blue
Each banner has [http://mystonline.com/forums/viewtopic.php?p=256592#256592 one of two symbols] on it. The first symbol is named "Yeesha's Story" and it appears on the blue and purple banners. The second symbol is named "Journey Story" and appears on the red banner. This Bookmark Instance proposal is based upon personal musings of how these ribbons may have been intended to work.

== Application: Rules ==

=== Acquisition and Use ===

A set of bookmarks are acquired by the player at the beginning of the game, perhaps in Cleft as an alternative to the Relto book, or with a Relto book. Some sort of tutorial will need to be added to explain the function of the bookmarks.

The bookmarks may be applied to books and Bahro stones; they may not, for obvious reasons, be applied to portals of more ethereal nature.

Two bookmark ribbons appear when the player lifts a book or Bahro stone to examine it. The bookmarks function in this manner:
* Solo Journey (solo hand symbol) - when active, the player will link to his or her own private Age. The Solo Journey bookmark should always be available.
* Group Journey (paired hand symbols) - when active, the player and his or her companions will link to the same Age, which will be the private Age of the "expedition leader." The Group Journey bookmark is only available for a book or Bahro Stone if the player has joined a group, and the leader must have collected and unlocked the Age in his or her Relto.
* No bookmark (drc symbol) - when neither bookmark is active, the player will link to the authentic (public) instance of the Age. This instance may be unavailable if it is at player capacity (see "Managing Access to Full Areas" below), and although this proposal does not mandate it, the public Age might also be unavailable if the player has not completed one or more tasks in his or her private version of the Age.

There will few exceptions where the bookmarks do not apply in the above manner.

Here is a comparison of the how this model replaces the sharing of Instances as it worked in Myst Online.

In Myst Online, a player could reach a friend's Age by one of these methods:
* Meet the friend, link to the friend's Relto, then pull the unlocked book from the bookshelf
* Meet the friend at a copy of the book in a public space. Accept a sharing of the book from the friend.
* Receive an invitation from the friend. Link to Nexus, and access the book.

In this proposal, a player can reach a friend's Age by:
* Join a group where the friend is leader. Use the Group Journey bookmark with ''any'' book or Bahro stone that links to the friend's collected and unlocked Age.

=== The Authentic (Public) Age ===

The Authentic instance of an Age is the legitimate place, typically unmodified by Bahro or Yeesha, open for all explorers. This version of the Age generally lacks rewards. With few exceptions, players will not be able to obtain relto pages, clothing, or puzzle rings from the authentic instance. These Ages are places to hang out, explore, and have parties without needing to invite anyone.

=== The Journey (Private) Age ===

The Journey Age is the private instance controlled by an individual or by the leader of a group of explorers who have banded together. The Journey Age contains the Bahro doors, cloths, and rewards that represent progress in the game.

=== Privacy Control ===

When in a group, the tab at the top of a book in the leader's Relto bookshelf will enable or disable the group journey bookmark for all links to that Age. Consequently, if the leader has not acquired a book, any group members using that book will find the group bookmark disabled for that Age.

=== Managing Access to Full Areas ===

The Bookmark Instancing system depends upon some new or extended method of managing access to high-population areas. Though perhaps deserving of its own proposal, here are a few comments on such a method.

In Prologue and in Myst Online, access to the "real" D'ni City was controlled through the Nexus. Direct linking to the city was not possible; the City books in Relto & Kadish Tolesa and the City Bahro Stone in Neighborhood would link players to a Neighborhood-instanced City. (There was a bug in Myst Online that allowed players to circumvent the intended behavior and link to the main city, but that is not relevant to the discussion of how Cyan meant for the system to work.) When it worked, this system prevented the city from becoming overcrowded.

The original system did not provide a way for players to know when an empty spot had opened in the City. Furthermore, the Bookmark Instancing proposal complicates matters by permitting players to link to public areas from any book - not just Nexus controlled books.

For the Bookmarks proposal to be minimally viable, when the Public instance of an Age is full, the player should not be permitted to link to the that instance, even if he or she has an open book leading to that place. (If an In-Cavern reason is desired for being unable to link, it could simply be that when an area is too crowded, it is not safe to link into that area, and perhaps the link becomes unstable.) The link in the book could appear as a swirling black void, unless one of Yeesha's bookmarks is applied.

This minimal system still leaves much to be desired. A better system would permit background downloading of an Age as well as for waiting on an empty spot in a filled-to-maximum-capacity area. Players attempting to use a book linking to a full area would be notified that they are unable to link to the Age (for whatever reason). The player would be given the option to be notified later when the Age is available. If the Age is downloaded but the public area is full, the player could also still link to a private instance.

An even more advanced solution would introducing queuing, and could permit a player to immediately link to an area that he or she has been waiting to visit. However, this solution is likely to be unsatisfactory to players who want canon rules enforced on actual gameplay, rather than "ICly" explaining that they had linked back to Relto first before linking to the destination Age.

== Application: Specifics (List of Locations and Age Links) ==

=== Self ===
* Relto
** There is no single "authentic" original Relto. Each Relto is its own unique place, and so there is no need for a Solo Journey bookmark with this book.
** When the player is part of a group, as group leader, he or she can control whether people can link to his or her Relto by manipulating the Group bookmark in the Relto book. This will enable or disable the Group bookmark in group members' Relto books. If the player is not a member of a group, the Group bookmark does not appear.

=== Relto===
*Neighborhood
** Each Neighborhood is considered a public place. No private instances exists for these books. The Solo and Group bookmarks do not appear when opening the Neighborhood book in Relto, and all links take the player to the neighborhood for which the player is a member.
*Nexus
** Nexus is a public place that operates in a way that prevents two explorers from occupying the same "cell." The Solo and Group bookmarks do not appear when opening the Nexus book.
*Ae'gura (many links)
** Authentic, Solo Journey, and Group Journey are available.
*Cleft
** Book only available after Original Journey Ages are complete. Authentic, Solo Journey, and Group Journey are available. Dropping through the cleft in Relto to complete Original Journey will take the player to a Solo Journey Cleft. Solo/Group Journey Cleft may be necessary to complete puzzles e.g. link to K'veer.
*Gahreesen
** Authentic, Solo Journey, and Group Journey are available. Authentic Gahreesen might be similar to Neighborhood-instanced Gahreesen from Myst Online.
*Teledahn
** Authentic, Solo Journey, and Group Journey are available.
*Kadish Tolesa
** Authentic, Solo Journey, and Group Journey are available.
*Eder Gira
** Authentic, Solo Journey, and Group Journey are available.
*Eder Kemo
** Authentic, Solo Journey, and Group Journey are available.
*Negilahn/Dereno/Payiferen/Tetsonot
** Authentic, Solo Journey, and Group Journey are available.
*Er'cana
** Authentic, Solo Journey, and Group Journey are available.
*Ahnonay Cathedral
** Authentic, Solo Journey, and Group Journey are available.
*Ahnonay
** Authentic, Solo Journey, and Group Journey are available.
*Minkata
** Authentic, Solo Journey, and Group Journey are available. Authentic Minkata might be Nighttime only and lacking Bahro stones, or could still be manipulated but would lack symbols
*Jalak Dador
** Authentic, Solo Journey, and Group Journey are available.
*Myst
** Authentic, Solo Journey, and Group Journey are available, although Authentic could probably become cramped quickly if only the Library is accessible.

===Neighborhood===
*Gahreesen
** Authentic, Solo Journey, and Group Journey are available. See notes for Relto.
*Eder Delin
** Authentic, Solo Journey, and Group Journey are available. Solo Journey would still include Bahro doors but would obviously not be solvable.
*Eder Tsogal
** Authentic, Solo Journey, and Group Journey are available. Solo Journey would still include Bahro doors but would obviously not be solvable.
*Great Zero
:In Prologue, Great Zero was a Nexus link. Players linking to Great Zero found themselves in a private instance.

:In MOUL, Great Zero was moved to the Neighborhood so that neighbors could gather at the Great Zero. Unfortunately, being able to link from Neighborhood to Great Zero violates the rule against intra-Age linking.

:Although this Proposal does not mandate it, with Bookmark Instancing, players could link from Nexus into the public Great Zero, a group Great Zero, or a totally private Great Zero by using the appropriate Instance bookmark; maintaining the book in the Neighborhood is no longer needed for group Great Zero gatherings. However, if the book is moved to Nexus, the stained glass art for Great Zero no longer has a home.

* Great Stair Bahro Stone
** Authentic, Solo Journey, and Group Journey are available.

===Nexus===
* City Links
* All Ages available from Relto (except Nexus itself)
* Watcher's Sanctuary
* Kirel
* Guild Pubs

Although not mandated by this proposal, the KI and Nexus could interact according to these rules: Ages visited with a KI would be added to the list of books available through Nexus. Ages visited before picking up the KI would not be added. "Unapproved Ages" might also not be added (as the book would not be added to the Nexus library), and the KI could display ??? while in these Ages (as it would not know the name to display).

===D'ni===
====Ae'gura====
*Nexus
*Ferry: Teledahn Dock Bahro Stone
*Takotah: Descent Bahro Stone
*Museum: Negilahn
*Museum: Dereno
*Museum: Payiferen
*Museum: Tetsonot
*Gallery: Kadish Tolesa
*Library: Minkata
*Library: Jalak Dador
*Library: Kadish Tolesa Bahro Stone

====Baron's Office====
*Teledahn
*Teledahn Mushroom Bahro Stone

====Spyroom====
*Teledahn
*Phil's Relto

====Watcher's Sanctuary====
*Er'cana
*Ahnonay Cathedral

====K'veer====
*Nexus
*Myst

====Uran Silo====
*Er'cana

===Gahreesen===
*Neighborhood (Balcony) Bahro Stone
*D'ni (Ae'gura Balcony 1) Bahro Stone
*Nexus
*Wall Nexus
*Teledahn

===Teledahn===
*D'ni (Baron's Office)
*D'ni (Spyroom) - book or stone?
*Gahreesen Bahro Stone

===Kadish Tolesa===
*D'ni (Ae'gura Balcony 2) Bahro Stone
*D'ni (Ae'gura Gallery)
*Kadish Tolesa Alternate

===Eder Gira===
*Eder Kemo
*D'ni (Ae'gura Takotah Roof) Bahro Stone

===Eder Kemo===
*Eder Gira
*Neighborhood (Classroom Roof) Bahro Stone

====Negilahn/Dereno/Payiferen/Tetsonot====
*Nexus

===Er'cana===
*D'ni (Uran Silo)
*Upper Bahro Cave Bahro Stone

===Ahnonay Cathedral===
*Ahnonay

===Ahnonay===
*Ahnonay Cathedral
*Lower Bahro Cave Bahro Stone

===Eder Delin/Eder Tsogal===
*Neighborhood
** The Neighborhood book in Eder Delin/Eder Tsogal must be replaced with a Nexus book. A Neighborhood book should only link to a specific neighborhood and should not work differently for different players.
*Nexus
** Replaces Neighborhood book. The Solo and Group bookmarks do not appear when opening the Nexus book.

Instancing - Bookmarks

2009-02-08T08:09:19Z

Marten: /* Neighborhood */

Note: This page is a work in progress as I detail thoughts on my Instancing proposal.
-- Marten

TODO:
* Identify and add any missing Location/Link pairs
* Add detailed linking information for remaining Ages
* Identify how existing Yeesha bookmarks work with the proposal
* Discuss issues and possible solutions to [[http://forums.openuru.org/viewtopic.php?p=799#p799 Kenguin's Issues List]]
* Note which instances are "default" in which situations
* Resolve any lingering inconsistencies
* Begin related proposal for [[KI Interface:Group Management]]

{{TOClimit|2}}

==Objective==
Replace the Instancing system with a consistent model that gives players greater control. Under the MOUL model, some areas of the game could only be shared by neighbors; under the proposed model, players will be able to invite friends to share all areas of the game.

==Prerequisites==
* Performance Improvements for large groups in one Age
* Queuing system for high-population areas
* Grouping ("Party") System implemented into KI

==Origin of Concept==
First, this proposal is an attempt to incorporate the model of Instancing used in other popular multiplayer online games. A detailed description of Instancing as it applies in most MMOs can be found at http://en.wikipedia.org/wiki/Instance_dungeons, but the key idea is that players do not need to be independently invited to every instance they wish to visit together; players may ally themselves with friends to form a group or party such that all members automatically enter an instance together.

Second, this proposal is inspired by some unused assets hidden in the game files for Uru. One of the more intriguing assets is series of [http://mystonline.com/forums/viewtopic.php?t=16333 three hanging banners] (one blue, one red, and one purple) that can appear in the Museum area of Ae'gura. Each of the pedestals under the banners has a set of matching ribbons, although not all pedestals have all ribbons. The sequence of books and ribbons was as follows:
* Gahreesen: Red and Blue
* Teledahn: Purple, Red, Blue
* Kadish: Purple and Blue
* Ahnonay Cathedral: Purple and Blue
* Uran Silo: Purple and Blue
Each banner has [http://mystonline.com/forums/viewtopic.php?p=256592#256592 one of two symbols] on it. The first symbol is named "Yeesha's Story" and it appears on the blue and purple banners. The second symbol is named "Journey Story" and appears on the red banner. This Bookmark Instance proposal is based upon personal musings of how these ribbons may have been intended to work.

== Application: Rules ==

=== Acquisition and Use ===

A set of bookmarks are acquired by the player at the beginning of the game, perhaps in Cleft as an alternative to the Relto book, or with a Relto book. Some sort of tutorial will need to be added to explain the function of the bookmarks.

The bookmarks may be applied to books and Bahro stones; they may not, for obvious reasons, be applied to portals of more ethereal nature.

Two bookmark ribbons appear when the player lifts a book or Bahro stone to examine it. The bookmarks function in this manner:
* Solo Journey (solo hand symbol) - when active, the player will link to his or her own private Age. The Solo Journey bookmark should always be available.
* Group Journey (paired hand symbols) - when active, the player and his or her companions will link to the same Age, which will be the private Age of the "expedition leader." The Group Journey bookmark is only available for a book or Bahro Stone if the player has joined a group, and the leader must have collected and unlocked the Age in his or her Relto.
* No bookmark (drc symbol) - when neither bookmark is active, the player will link to the authentic (public) instance of the Age. This instance may be unavailable if it is at player capacity (see "Managing Access to Full Areas" below), and although this proposal does not mandate it, the public Age might also be unavailable if the player has not completed one or more tasks in his or her private version of the Age.

There will few exceptions where the bookmarks do not apply in the above manner.

Here is a comparison of the how this model replaces the sharing of Instances as it worked in Myst Online.

In Myst Online, a player could reach a friend's Age by one of these methods:
* Meet the friend, link to the friend's Relto, then pull the unlocked book from the bookshelf
* Meet the friend at a copy of the book in a public space. Accept a sharing of the book from the friend.
* Receive an invitation from the friend. Link to Nexus, and access the book.

In this proposal, a player can reach a friend's Age by:
* Join a group where the friend is leader. Use the Group Journey bookmark with ''any'' book or Bahro stone that links to the friend's collected and unlocked Age.

=== The Authentic (Public) Age ===

The Authentic instance of an Age is the legitimate place, typically unmodified by Bahro or Yeesha, open for all explorers. This version of the Age generally lacks rewards. With few exceptions, players will not be able to obtain relto pages, clothing, or puzzle rings from the authentic instance. These Ages are places to hang out, explore, and have parties without needing to invite anyone.

=== The Journey (Private) Age ===

The Journey Age is the private instance controlled by an individual or by the leader of a group of explorers who have banded together. The Journey Age contains the Bahro doors, cloths, and rewards that represent progress in the game.

=== Privacy Control ===

When in a group, the tab at the top of a book in the leader's Relto bookshelf will enable or disable the group journey bookmark for all links to that Age. Consequently, if the leader has not acquired a book, any group members using that book will find the group bookmark disabled for that Age.

=== Managing Access to Full Areas ===

The Bookmark Instancing system depends upon some new or extended method of managing access to high-population areas. Though perhaps deserving of its own proposal, here are a few comments on such a method.

In Prologue and in Myst Online, access to the "real" D'ni City was controlled through the Nexus. Direct linking to the city was not possible; the City books in Relto & Kadish Tolesa and the City Bahro Stone in Neighborhood would link players to a Neighborhood-instanced City. (There was a bug in Myst Online that allowed players to circumvent the intended behavior and link to the main city, but that is not relevant to the discussion of how Cyan meant for the system to work.) When it worked, this system prevented the city from becoming overcrowded.

The original system did not provide a way for players to know when an empty spot had opened in the City. Furthermore, the Bookmark Instancing proposal complicates matters by permitting players to link to public areas from any book - not just Nexus controlled books.

For the Bookmarks proposal to be minimally viable, when the Public instance of an Age is full, the player should not be permitted to link to the that instance, even if he or she has an open book leading to that place. (If an In-Cavern reason is desired for being unable to link, it could simply be that when an area is too crowded, it is not safe to link into that area, and perhaps the link becomes unstable.) The link in the book could appear as a swirling black void, unless one of Yeesha's bookmarks is applied.

This minimal system still leaves much to be desired. A better system would permit background downloading of an Age as well as for waiting on an empty spot in a filled-to-maximum-capacity area. Players attempting to use a book linking to a full area would be notified that they are unable to link to the Age (for whatever reason). The player would be given the option to be notified later when the Age is available. If the Age is downloaded but the public area is full, the player could also still link to a private instance.

An even more advanced solution would introducing queuing, and could permit a player to immediately link to an area that he or she has been waiting to visit. However, this solution is likely to be unsatisfactory to players who want canon rules enforced on actual gameplay, rather than "ICly" explaining that they had linked back to Relto first before linking to the destination Age.

== Application: Specifics (List of Locations and Age Links) ==

=== Self ===
* Relto
** There is no single "authentic" original Relto. Each Relto is its own unique place, and so there is no need for a Solo Journey bookmark with this book.
** When the player is part of a group, as group leader, he or she can control whether people can link to his or her Relto by manipulating the Group bookmark in the Relto book. This will enable or disable the Group bookmark in group members' Relto books. If the player is not a member of a group, the Group bookmark does not appear.

=== Relto===
*Neighborhood
** Each Neighborhood is considered a public place. No private instances exists for these books. The Solo and Group bookmarks do not appear when opening the Neighborhood book in Relto, and all links take the player to the neighborhood for which the player is a member.
*Nexus
** Nexus is a public place that operates in a way that prevents two explorers from occupying the same "cell." The Solo and Group bookmarks do not appear when opening the Nexus book.
*Ae'gura (many links)
** Authentic, Solo Journey, and Group Journey are available.
*Cleft
** Book only available after Original Journey Ages are complete. Authentic, Solo Journey, and Group Journey are available. Dropping through the cleft in Relto to complete Original Journey will take the player to a Solo Journey Cleft. Solo/Group Journey Cleft may be necessary to complete puzzles e.g. link to K'veer.
*Gahreesen
** Authentic, Solo Journey, and Group Journey are available. Authentic Gahreesen might be similar to Neighborhood-instanced Gahreesen from Myst Online.
*Teledahn
** Authentic, Solo Journey, and Group Journey are available.
*Kadish Tolesa
** Authentic, Solo Journey, and Group Journey are available.
*Eder Gira
** Authentic, Solo Journey, and Group Journey are available.
*Eder Kemo
** Authentic, Solo Journey, and Group Journey are available.
*Negilahn/Dereno/Payiferen/Tetsonot
** Authentic, Solo Journey, and Group Journey are available.
*Er'cana
** Authentic, Solo Journey, and Group Journey are available.
*Ahnonay Cathedral
** Authentic, Solo Journey, and Group Journey are available.
*Ahnonay
** Authentic, Solo Journey, and Group Journey are available.
*Minkata
** Authentic, Solo Journey, and Group Journey are available. Authentic Minkata might be Nighttime only and lacking Bahro stones, or could still be manipulated but would lack symbols
*Jalak Dador
** Authentic, Solo Journey, and Group Journey are available.
*Myst
** Authentic, Solo Journey, and Group Journey are available, although Authentic could probably become cramped quickly if only the Library is accessible.

===Neighborhood===
*Gahreesen
** Authentic, Solo Journey, and Group Journey are available. See notes for Relto.
*Eder Delin
** Authentic, Solo Journey, and Group Journey are available. Solo Journey would still include Bahro doors but would obviously not be solvable.
*Eder Tsogal
** Authentic, Solo Journey, and Group Journey are available. Solo Journey would still include Bahro doors but would obviously not be solvable.
*Great Zero
:In Prologue, Great Zero was a Nexus link. Players linking to Great Zero found themselves in a private instance.
* Great Stair Bahro Stone
** Authentic, Solo Journey, and Group Journey are available.

:In MOUL, Great Zero was moved to the Neighborhood so that neighbors could gather at the Great Zero. Unfortunately, being able to link from Neighborhood to Great Zero violates the rule against intra-Age linking.

:Although this Proposal does not mandate it, with Bookmark Instancing, players could link from Nexus into the public Great Zero, a group Great Zero, or a totally private Great Zero by using the appropriate Instance bookmark; maintaining the book in the Neighborhood is no longer needed for group Great Zero gatherings. However, if the book is moved to Nexus, the stained glass art for Great Zero no longer has a home.

===Nexus===
* City Links
* All Ages available from Relto (except Nexus itself)
* Watcher's Sanctuary
* Kirel
* Guild Pubs

Although not mandated by this proposal, the KI and Nexus could interact according to these rules: Ages visited with a KI would be added to the list of books available through Nexus. Ages visited before picking up the KI would not be added. "Unapproved Ages" might also not be added (as the book would not be added to the Nexus library), and the KI could display ??? while in these Ages (as it would not know the name to display).

===D'ni===
====Ae'gura====
*Nexus
*Ferry: Teledahn Dock Bahro Stone
*Takotah: Descent Bahro Stone
*Museum: Negilahn
*Museum: Dereno
*Museum: Payiferen
*Museum: Tetsonot
*Gallery: Kadish Tolesa
*Library: Minkata
*Library: Jalak Dador
*Library: Kadish Tolesa Bahro Stone

====Baron's Office====
*Teledahn
*Teledahn Mushroom Bahro Stone

====Spyroom====
*Teledahn
*Phil's Relto

====Watcher's Sanctuary====
*Er'cana
*Ahnonay Cathedral

====K'veer====
*Nexus
*Myst

====Uran Silo====
*Er'cana

===Gahreesen===
*Neighborhood (Balcony) Bahro Stone
*D'ni (Ae'gura Balcony 1) Bahro Stone
*Nexus
*Wall Nexus
*Teledahn

===Teledahn===
*D'ni (Baron's Office)
*D'ni (Spyroom) - book or stone?
*Gahreesen Bahro Stone

===Kadish Tolesa===
*D'ni (Ae'gura Balcony 2) Bahro Stone
*D'ni (Ae'gura Gallery)
*Kadish Tolesa Alternate

===Eder Gira===
*Eder Kemo
*D'ni (Ae'gura Takotah Roof) Bahro Stone

===Eder Kemo===
*Eder Gira
*Neighborhood (Classroom Roof) Bahro Stone

====Negilahn/Dereno/Payiferen/Tetsonot====
*Nexus

===Er'cana===
*D'ni (Uran Silo)
*Upper Bahro Cave Bahro Stone

===Ahnonay Cathedral===
*Ahnonay

===Ahnonay===
*Ahnonay Cathedral
*Lower Bahro Cave Bahro Stone

===Eder Delin/Eder Tsogal===
*Neighborhood
** The Neighborhood book in Eder Delin/Eder Tsogal must be replaced with a Nexus book. A Neighborhood book should only link to a specific neighborhood and should not work differently for different players.
*Nexus
** Replaces Neighborhood book. The Solo and Group bookmarks do not appear when opening the Nexus book.

Instancing - Bookmarks

2009-02-08T08:06:54Z

Marten: /* Managing Access to Full Areas */

Note: This page is a work in progress as I detail thoughts on my Instancing proposal.
-- Marten

TODO:
* Identify and add any missing Location/Link pairs
* Add detailed linking information for remaining Ages
* Identify how existing Yeesha bookmarks work with the proposal
* Discuss issues and possible solutions to [[http://forums.openuru.org/viewtopic.php?p=799#p799 Kenguin's Issues List]]
* Note which instances are "default" in which situations
* Resolve any lingering inconsistencies
* Begin related proposal for [[KI Interface:Group Management]]

{{TOClimit|2}}

==Objective==
Replace the Instancing system with a consistent model that gives players greater control. Under the MOUL model, some areas of the game could only be shared by neighbors; under the proposed model, players will be able to invite friends to share all areas of the game.

==Prerequisites==
* Performance Improvements for large groups in one Age
* Queuing system for high-population areas
* Grouping ("Party") System implemented into KI

==Origin of Concept==
First, this proposal is an attempt to incorporate the model of Instancing used in other popular multiplayer online games. A detailed description of Instancing as it applies in most MMOs can be found at http://en.wikipedia.org/wiki/Instance_dungeons, but the key idea is that players do not need to be independently invited to every instance they wish to visit together; players may ally themselves with friends to form a group or party such that all members automatically enter an instance together.

Second, this proposal is inspired by some unused assets hidden in the game files for Uru. One of the more intriguing assets is series of [http://mystonline.com/forums/viewtopic.php?t=16333 three hanging banners] (one blue, one red, and one purple) that can appear in the Museum area of Ae'gura. Each of the pedestals under the banners has a set of matching ribbons, although not all pedestals have all ribbons. The sequence of books and ribbons was as follows:
* Gahreesen: Red and Blue
* Teledahn: Purple, Red, Blue
* Kadish: Purple and Blue
* Ahnonay Cathedral: Purple and Blue
* Uran Silo: Purple and Blue
Each banner has [http://mystonline.com/forums/viewtopic.php?p=256592#256592 one of two symbols] on it. The first symbol is named "Yeesha's Story" and it appears on the blue and purple banners. The second symbol is named "Journey Story" and appears on the red banner. This Bookmark Instance proposal is based upon personal musings of how these ribbons may have been intended to work.

== Application: Rules ==

=== Acquisition and Use ===

A set of bookmarks are acquired by the player at the beginning of the game, perhaps in Cleft as an alternative to the Relto book, or with a Relto book. Some sort of tutorial will need to be added to explain the function of the bookmarks.

The bookmarks may be applied to books and Bahro stones; they may not, for obvious reasons, be applied to portals of more ethereal nature.

Two bookmark ribbons appear when the player lifts a book or Bahro stone to examine it. The bookmarks function in this manner:
* Solo Journey (solo hand symbol) - when active, the player will link to his or her own private Age. The Solo Journey bookmark should always be available.
* Group Journey (paired hand symbols) - when active, the player and his or her companions will link to the same Age, which will be the private Age of the "expedition leader." The Group Journey bookmark is only available for a book or Bahro Stone if the player has joined a group, and the leader must have collected and unlocked the Age in his or her Relto.
* No bookmark (drc symbol) - when neither bookmark is active, the player will link to the authentic (public) instance of the Age. This instance may be unavailable if it is at player capacity (see "Managing Access to Full Areas" below), and although this proposal does not mandate it, the public Age might also be unavailable if the player has not completed one or more tasks in his or her private version of the Age.

There will few exceptions where the bookmarks do not apply in the above manner.

Here is a comparison of the how this model replaces the sharing of Instances as it worked in Myst Online.

In Myst Online, a player could reach a friend's Age by one of these methods:
* Meet the friend, link to the friend's Relto, then pull the unlocked book from the bookshelf
* Meet the friend at a copy of the book in a public space. Accept a sharing of the book from the friend.
* Receive an invitation from the friend. Link to Nexus, and access the book.

In this proposal, a player can reach a friend's Age by:
* Join a group where the friend is leader. Use the Group Journey bookmark with ''any'' book or Bahro stone that links to the friend's collected and unlocked Age.

=== The Authentic (Public) Age ===

The Authentic instance of an Age is the legitimate place, typically unmodified by Bahro or Yeesha, open for all explorers. This version of the Age generally lacks rewards. With few exceptions, players will not be able to obtain relto pages, clothing, or puzzle rings from the authentic instance. These Ages are places to hang out, explore, and have parties without needing to invite anyone.

=== The Journey (Private) Age ===

The Journey Age is the private instance controlled by an individual or by the leader of a group of explorers who have banded together. The Journey Age contains the Bahro doors, cloths, and rewards that represent progress in the game.

=== Privacy Control ===

When in a group, the tab at the top of a book in the leader's Relto bookshelf will enable or disable the group journey bookmark for all links to that Age. Consequently, if the leader has not acquired a book, any group members using that book will find the group bookmark disabled for that Age.

=== Managing Access to Full Areas ===

The Bookmark Instancing system depends upon some new or extended method of managing access to high-population areas. Though perhaps deserving of its own proposal, here are a few comments on such a method.

In Prologue and in Myst Online, access to the "real" D'ni City was controlled through the Nexus. Direct linking to the city was not possible; the City books in Relto & Kadish Tolesa and the City Bahro Stone in Neighborhood would link players to a Neighborhood-instanced City. (There was a bug in Myst Online that allowed players to circumvent the intended behavior and link to the main city, but that is not relevant to the discussion of how Cyan meant for the system to work.) When it worked, this system prevented the city from becoming overcrowded.

The original system did not provide a way for players to know when an empty spot had opened in the City. Furthermore, the Bookmark Instancing proposal complicates matters by permitting players to link to public areas from any book - not just Nexus controlled books.

For the Bookmarks proposal to be minimally viable, when the Public instance of an Age is full, the player should not be permitted to link to the that instance, even if he or she has an open book leading to that place. (If an In-Cavern reason is desired for being unable to link, it could simply be that when an area is too crowded, it is not safe to link into that area, and perhaps the link becomes unstable.) The link in the book could appear as a swirling black void, unless one of Yeesha's bookmarks is applied.

This minimal system still leaves much to be desired. A better system would permit background downloading of an Age as well as for waiting on an empty spot in a filled-to-maximum-capacity area. Players attempting to use a book linking to a full area would be notified that they are unable to link to the Age (for whatever reason). The player would be given the option to be notified later when the Age is available. If the Age is downloaded but the public area is full, the player could also still link to a private instance.

An even more advanced solution would introducing queuing, and could permit a player to immediately link to an area that he or she has been waiting to visit. However, this solution is likely to be unsatisfactory to players who want canon rules enforced on actual gameplay, rather than "ICly" explaining that they had linked back to Relto first before linking to the destination Age.

== Application: Specifics (List of Locations and Age Links) ==

=== Self ===
* Relto
** There is no single "authentic" original Relto. Each Relto is its own unique place, and so there is no need for a Solo Journey bookmark with this book.
** When the player is part of a group, as group leader, he or she can control whether people can link to his or her Relto by manipulating the Group bookmark in the Relto book. This will enable or disable the Group bookmark in group members' Relto books. If the player is not a member of a group, the Group bookmark does not appear.

=== Relto===
*Neighborhood
** Each Neighborhood is considered a public place. No private instances exists for these books. The Solo and Group bookmarks do not appear when opening the Neighborhood book in Relto, and all links take the player to the neighborhood for which the player is a member.
*Nexus
** Nexus is a public place that operates in a way that prevents two explorers from occupying the same "cell." The Solo and Group bookmarks do not appear when opening the Nexus book.
*Ae'gura (many links)
** Authentic, Solo Journey, and Group Journey are available.
*Cleft
** Book only available after Original Journey Ages are complete. Authentic, Solo Journey, and Group Journey are available. Dropping through the cleft in Relto to complete Original Journey will take the player to a Solo Journey Cleft. Solo/Group Journey Cleft may be necessary to complete puzzles e.g. link to K'veer.
*Gahreesen
** Authentic, Solo Journey, and Group Journey are available. Authentic Gahreesen might be similar to Neighborhood-instanced Gahreesen from Myst Online.
*Teledahn
** Authentic, Solo Journey, and Group Journey are available.
*Kadish Tolesa
** Authentic, Solo Journey, and Group Journey are available.
*Eder Gira
** Authentic, Solo Journey, and Group Journey are available.
*Eder Kemo
** Authentic, Solo Journey, and Group Journey are available.
*Negilahn/Dereno/Payiferen/Tetsonot
** Authentic, Solo Journey, and Group Journey are available.
*Er'cana
** Authentic, Solo Journey, and Group Journey are available.
*Ahnonay Cathedral
** Authentic, Solo Journey, and Group Journey are available.
*Ahnonay
** Authentic, Solo Journey, and Group Journey are available.
*Minkata
** Authentic, Solo Journey, and Group Journey are available. Authentic Minkata might be Nighttime only and lacking Bahro stones, or could still be manipulated but would lack symbols
*Jalak Dador
** Authentic, Solo Journey, and Group Journey are available.
*Myst
** Authentic, Solo Journey, and Group Journey are available, although Authentic could probably become cramped quickly if only the Library is accessible.

===Neighborhood===
*Gahreesen
** Authentic, Solo Journey, and Group Journey are available. See notes for Relto.
*Eder Delin
** Authentic, Solo Journey, and Group Journey are available. Solo Journey would still include Bahro doors but would obviously not be solvable.
*Eder Tsogal
** Authentic, Solo Journey, and Group Journey are available. Solo Journey would still include Bahro doors but would obviously not be solvable.
*Great Zero
:In Prologue, Great Zero was a Nexus link. Players linking to Great Zero found themselves in a private instance.

:In MOUL, Great Zero was moved to the Neighborhood so that neighbors could gather at the Great Zero. Unfortunately, being able to link from Neighborhood to Great Zero violates the rule against intra-Age linking.

:Although this Proposal does not mandate it, with Bookmark Instancing, players could link from Nexus into the public Great Zero, a group Great Zero, or a totally private Great Zero by using the appropriate Instance bookmark; maintaining the book in the Neighborhood is no longer needed for group Great Zero gatherings. However, if the book is moved to Nexus, the stained glass art for Great Zero no longer has a home.

===Nexus===
* City Links
* All Ages available from Relto (except Nexus itself)
* Watcher's Sanctuary
* Kirel
* Guild Pubs

Although not mandated by this proposal, the KI and Nexus could interact according to these rules: Ages visited with a KI would be added to the list of books available through Nexus. Ages visited before picking up the KI would not be added. "Unapproved Ages" might also not be added (as the book would not be added to the Nexus library), and the KI could display ??? while in these Ages (as it would not know the name to display).

===D'ni===
====Ae'gura====
*Nexus
*Ferry: Teledahn Dock Bahro Stone
*Takotah: Descent Bahro Stone
*Museum: Negilahn
*Museum: Dereno
*Museum: Payiferen
*Museum: Tetsonot
*Gallery: Kadish Tolesa
*Library: Minkata
*Library: Jalak Dador
*Library: Kadish Tolesa Bahro Stone

====Baron's Office====
*Teledahn
*Teledahn Mushroom Bahro Stone

====Spyroom====
*Teledahn
*Phil's Relto

====Watcher's Sanctuary====
*Er'cana
*Ahnonay Cathedral

====K'veer====
*Nexus
*Myst

====Uran Silo====
*Er'cana

===Gahreesen===
*Neighborhood (Balcony) Bahro Stone
*D'ni (Ae'gura Balcony 1) Bahro Stone
*Nexus
*Wall Nexus
*Teledahn

===Teledahn===
*D'ni (Baron's Office)
*D'ni (Spyroom) - book or stone?
*Gahreesen Bahro Stone

===Kadish Tolesa===
*D'ni (Ae'gura Balcony 2) Bahro Stone
*D'ni (Ae'gura Gallery)
*Kadish Tolesa Alternate

===Eder Gira===
*Eder Kemo
*D'ni (Ae'gura Takotah Roof) Bahro Stone

===Eder Kemo===
*Eder Gira
*Neighborhood (Classroom Roof) Bahro Stone

====Negilahn/Dereno/Payiferen/Tetsonot====
*Nexus

===Er'cana===
*D'ni (Uran Silo)
*Upper Bahro Cave Bahro Stone

===Ahnonay Cathedral===
*Ahnonay

===Ahnonay===
*Ahnonay Cathedral
*Lower Bahro Cave Bahro Stone

===Eder Delin/Eder Tsogal===
*Neighborhood
** The Neighborhood book in Eder Delin/Eder Tsogal must be replaced with a Nexus book. A Neighborhood book should only link to a specific neighborhood and should not work differently for different players.
*Nexus
** Replaces Neighborhood book. The Solo and Group bookmarks do not appear when opening the Nexus book.