diff options
| author | Shiroe <krejza9@gmail.com> | 2022-05-05 22:10:19 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-05 22:10:19 +0200 |
| commit | 521679303ae80f485ddb7f30d6a0b101e43e83ba (patch) | |
| tree | 8286ed92f32511002cf6596667bf514c4ff29a5a | |
| parent | f24c135ebecadad4281f3c5a33e29144e75b8a6e (diff) | |
| download | wiki-521679303ae80f485ddb7f30d6a0b101e43e83ba.tar.gz wiki-521679303ae80f485ddb7f30d6a0b101e43e83ba.tar.bz2 wiki-521679303ae80f485ddb7f30d6a0b101e43e83ba.zip | |
chore: vsc manual (#615)
* Update creature_template.md
Add explanation for detection_range
* add vcs_requirements.md
* Update vcs_requirements.md
image correction
* add windows-vsc-core-installation.md
naming fix
* Update vsc_requirements.md
Remove unnecessary blank lines
* Update windows-vsc-core-installation.md
remove br , blank line
path correction
* Update vsc_requirements.md
fix Core Installation link
* Update and rename vsc_requirements.md to vsc-requirements.md
* Update windows-vsc-core-installation.md
Co-authored-by: Kitzunu <24550914+Kitzunu@users.noreply.github.com>
| -rw-r--r-- | docs/vsc-requirements.md | 80 | ||||
| -rw-r--r-- | docs/windows-vsc-core-installation.md | 140 | ||||
| -rw-r--r-- | images/vcs_extension_pack_install.png | bin | 0 -> 103284 bytes | |||
| -rw-r--r-- | images/visualstudio_tools.png | bin | 0 -> 105611 bytes | |||
| -rw-r--r-- | images/vsc_extensions.png | bin | 0 -> 14952 bytes |
5 files changed, 220 insertions, 0 deletions
diff --git a/docs/vsc-requirements.md b/docs/vsc-requirements.md new file mode 100644 index 0000000..c950563 --- /dev/null +++ b/docs/vsc-requirements.md @@ -0,0 +1,80 @@ +# VSC Requirements + +| Installation Guide | | +| :- | :- | +| [<< Start: Installation Guide](installation.md) | [Step 2: VSC Core Installation >>](windows-vsc-core-installation.md) | + +| | +| :- | +| Boost ≥ 1.70 - 1.74 | +| MySQL ≥ 5.7.0 | +| OpenSLL ≥ 1.0.x | +| CMake ≥ 3.16 | +| MS Visual Studio Build Tools | + +1. Git Extensions + + 1. You will need Git installed. You can get the latest version here https://git-scm.com/download/win + +1. Install [Visual Studio 2019 Build Tools](https://docs.microsoft.com/en-us/visualstudio/install/create-an-offline-installation-of-visual-studio?view=vs-2019) + + You will need to install the C++ compiler. + + To do this, select **Desktop development for C++** under **Workloads -> Desktop & Mobile**. + + <a href="../images/visualstudio_tools.png" target="_blank"> + <img src="../images/visualstudio_tools.png" height="50%" width="50%"> + </a> + +1. [Visual Studio Code](https://code.visualstudio.com/) + + 1. Download and install the **Latest Version** + 1. Install extensions + 1. Click **View**->**Extensions** + + <a href="../images/vsc_extensions.png.png" target="_blank"><img src="../images/vsc_extensions.png"></a> + 1. In Search bar type **C/C++ Extension Pack** + 1. Click on green install button + + <a href="../images/visualstudio_tools.png" target="_blank"><img src="../images/vcs_extension_pack_install.png" height="50%" width="50%"></a> + +1. [CMake](https://cmake.org/) + + 1. Download and install the **Latest Release** win32-x86.exe file, **NEVER the RC (Release Candidate) versions.** + + 1. We recommend to compile in 64 bits mode. + +1. MySQL development files + + 1. These files are shipped with MySQL Server, search for them at program files directory, MySQL\MySQL Server 8.0\lib / MySQL\MySQL Server 5.7\lib. + +1. [OpenSSL](http://www.slproweb.com/products/Win32OpenSSL.html) Download the 64bit version. Or you can get both if you plan to compile both 32 and 64bit, they can coexist side by side. + + 1. Find the 64bit version by finding the latest 1.0.x or 1.1.x Win64 OpenSSL that is NOT the "light" version. (Example: Win64 OpenSSL v1.1.1g) + + 1. Find the 32bit version by finding the latest 1.0.x or 1.1.x Win32 OpenSSL that is NOT the "light" version. (Example: Win32 OpenSSL v1.1.1g) + + 1. *Note #1: If you get a "Missing Microsoft Visual C++ 2008 Redistributable" error message while installing OpenSSL,* + *download the [Microsoft Visual C++ 2008 Redistributable Package (x64)](http://www.microsoft.com/en-us/download/details.aspx?id=29) (1.7MB Installer) and install it.* + *If you need 32bit support, download and install the [Microsoft Visual C++ 2008 Redistributable Package (x86)](http://www.microsoft.com/en-us/download/details.aspx?id=15336).* + + 1. *Note #2: While installing OpenSSL, choose The OpenSSL binaries (/bin) directory (NOT "The Windows system directory")* + *when given the choice on where to copy the OpenSSL DLLs. These DLLs will need to be located easily for [Core Installation](windows-core-installation).* + +1. [Boost](https://www.boost.org/). + + 1. Download the prebuilt Windows Binary for Visual Studio Tools + + 1. `1.70.0` is the minimum version required for Visual Studio Tool, but Version `1.74.0`is recommended + + 1. 64bit: https://sourceforge.net/projects/boost/files/boost-binaries/1.74.0/boost_1_74_0-msvc-14.2-64.exe/download + + 1. 32bit: https://sourceforge.net/projects/boost/files/boost-binaries/1.74.0/boost_1_74_0-msvc-14.2-32.exe/download + + 1. Add an environment variable to "System" variable named "BOOST_ROOT" and as value your Boost installation directory, e.g `E:/Programs/boost_1_74_0`. Important is to use '**/**', not '**\\**' when pointing to directory. (Make sure that it does not have a trailing slash (end of path). If you still get problems, add the same variable in the `USER` variables section too, like shown in the image below.) + + <a href="../images/boost.jpg" target="_blank"> + <img src="../images/boost.jpg" height="50%" width="50%"> + </a> + + 1. Notice that this image shows the version number `1.72.0` - use your actual version number in your settings. diff --git a/docs/windows-vsc-core-installation.md b/docs/windows-vsc-core-installation.md new file mode 100644 index 0000000..420ea43 --- /dev/null +++ b/docs/windows-vsc-core-installation.md @@ -0,0 +1,140 @@ +# Windows VSC Core Installation + +| Installation Guide | | +| :- | :- | +| [<< Step 1: VSC Requirements](vsc-requirements.md) | [Step 3: Server Setup >>](server-setup.md) | + +## Required software + +See [Requirements](requirements.md) before you continue. + +## Pulling & Compiling the source + +### Pulling the code + +1. Create the directory where the source files will be located. In this guide we will use **C:\Azerothcore**. + +1. Right-click on the folder and select **GitExt Clone...** + +1. Fill in the data as follow: + +``` +Repository to clone: https://github.com/azerothcore/azerothcore-wotlk +Destination: C:\Azerothcore +Subdirectory to create: <none>* +Branch: master +Repository type: Personal repository +``` + +Click **Clone**. Within a few minutes Azerothcore's sourcefiles will be cloned into **C:\Azerothcore**. + +### Configuring and generating Visual C++ solution with CMake + +Before you begin, create a new directory called **Build**. In this guide we will use **C:\Build**. + +1. Open CMake + +1. Click **Browse Source...** → Select the source directory (**C:\Azerothcore**) + +1. Click **Browse Build...** → Select the build directory (**C:\Build**) + +1. Click **Configure**. + +1. In the dropdown menu, choose the version of the compiler you downloaded in [Requirements](windows-requirements.md) section. Be sure to choose **Win64** version if you work on a 64-bit compilation. + +1. Make sure that **Use default native compilers** is checked. + +1. Click **Finish**. + +1. Make sure **TOOLS** is checked. This will compile the extractors needed later in the setup. + +1. Click **Configure** again. As long as you have error(s) typed in red in the log window you will need to check your parameters and re-run it. + +1. Click **Generate**. This will install the selected build files into your **C:\Build** folder. + +#### Some error fixes + +- If MySQL is not found by CMake it is required to set **MYSQL_INCLUDE_DIR = C:/XX/MySQL/MySQL Server X.X/include** and **MYSQL_LIBRARY = C:/XX/MySQL/MySQL Server X.X/lib(_XX)/libmysql.lib**. + + - XX depends on which MySQL version you use. + + - (If you do not see the MYSQL fields in CMake, tick the Advanced box). + +- If you get linker errors (e.g "error LNK2019: unresolved external symbol mysql_server_init"), make sure MYSQL_LIBRARY is set to the libmysql.lib that matches your compile mode (x64 vs 32 bits). + + - (If you do not see the MYSQL fields in CMake, tick the Advanced box). + +- If you get an error that *CMake could NOT find OpenSSL*: + + - Check the **Advanced** checkbox. + + - Find the two OPENSSL entries in the list and point to the correct directories: + + - OPENSSL_ROOT_DIR is the installation path (by default, **C:/OpenSSL-Win32** or **C:/OpenSSL-Win64**) + + - OPENSSL_INCLUDE_DIR is the "include" folder in installation path (by default, **C:/OpenSSL-Win32/include** or **C:/OpenSSL-Win64/include**) + +### Compiling the Source + +1. In Visual Studio Code open directory with AC source. +1. In the menu at the bottom, click **all** (wait a few seconds) and select **ALL_BUILD** on the top dialog. +1. click **BUILD** + +Build time differs from machine to machine, but you can expect it to take between 5 and 30 minutes. + +When the build is complete you will find a message in the output that looks similar to this: + +``` +Build finished with exit code 0 +``` + +You will find your freshly compiled binaries in the **C:\Build\bin\Release** or **C:\Build\bin\Debug** folder. These are all used to run your server at the end of this instruction. + +You will need the following files in order for the core to function properly: + +``` +\configs\ +authserver.exe +authserver.pbd +worldserver.exe +worldserver.pdb +libmysql.dll +libeay32.dll / libcrypto-1_1.dll / libcrypto-1_1-x64.dll +ssleay32.dll / libssl-1_1.dll / libssl-1_1-x64.dll +``` + +In the **configs** folder you should find: + +``` +authserver.conf.dist +worldserver.conf.dist +``` + +There are three DLL files that need to be manually added to this folder, and you need to copy them from the following installation/bin directories: + +**libmysql.dll** → C:\Program Files\MySQL\MySQL Server 8.x\lib\ + +*Note: You need the exact version of libmysql to correspond to the MySQL you have downloaded. Due to this you cannot download the DLL from the web and need to take it out of the folder.* + +OpenSLL _before_ version 1.1.0: + +**libeay32.dll** +**ssleay32.dll** → C:\OpenSSL-Win64\ or C:\OpenSSL-Win32\ *(depends on if your core is 64-bit or 32-bit)*. + +OpenSSL 1.1.0 and more recent installed, names have changed: + +**libssl-1_1.dll** +**libcrypto-1_1.dll** → C:\OpenSSL-Win32\bin + +**libssl-1_1-x64.dll** +**libcrypto-1_1-x64.dll** → C:\OpenSSL-Win64\bin + +#### About compilation log and report + +pdb files only exist if you compile on Debug or RelWithDebInfo modes, it's not mandatory but it's recommended to compile core on at least RelWithDebInfo mode to get proper crashlogs. If you compile on Release mode the pdb files aren't needed. + +To report crash logs it's MANDATORY to compile on Debug or RelWithDebInfo mode. + +| Installation Guide | | +| :- | :- | +| [<< Step 1: VSC Requirements](vsc-requirements.md) | [Step 3: Server Setup >>](server-setup.md) | diff --git a/images/vcs_extension_pack_install.png b/images/vcs_extension_pack_install.png Binary files differnew file mode 100644 index 0000000..a457554 --- /dev/null +++ b/images/vcs_extension_pack_install.png diff --git a/images/visualstudio_tools.png b/images/visualstudio_tools.png Binary files differnew file mode 100644 index 0000000..b15b73e --- /dev/null +++ b/images/visualstudio_tools.png diff --git a/images/vsc_extensions.png b/images/vsc_extensions.png Binary files differnew file mode 100644 index 0000000..3e28199 --- /dev/null +++ b/images/vsc_extensions.png |
