mirror of
https://github.com/EQEmu/Server.git
synced 2026-09-08 10:16:37 +00:00
Destroyed Ground Up Windows Install Rework (markdown)
TurmoilToad
@@ -1,448 +0,0 @@
|
||||
**This guide provides instructions for compiling 32-bit Windows server binaries and setting up a local development server.**
|
||||
|
||||
**Read through this guide before starting to ensure an understanding of the process.**
|
||||
|
||||
**The target computer must have an active internet connection at the time of installation.**
|
||||
|
||||
**Please direct any questions to our server support channel in [[discord](https://discord.gg/QHsm7CD)].**
|
||||
|
||||
_Note: Screenshots may vary depending on options selected and program graphical user interface changes._
|
||||
|
||||
---
|
||||
|
||||
# Contents
|
||||
|
||||
- [Compiler Setup](#compiler-setup)
|
||||
* [Verify System Environment Variable %Path% Length](#verify-system-environment-variable--path--length)
|
||||
* [Required Programs](#required-programs)
|
||||
* [Install Visual Studio](#install-visual-studio)
|
||||
* [Install Perl](#install-perl)
|
||||
* [Install CMake](#install-cmake)
|
||||
* [Install Git](#install-git)
|
||||
* [Install TortoiseGit](#install-tortoisegit)
|
||||
* [Restart Computer](#restart-computer)
|
||||
* [Acquiring the Code](#acquiring-the-code)
|
||||
* [Install Submodules](#install-submodules)
|
||||
* [Install Dependencies](#install-dependencies)
|
||||
* [Install VCPkg](#install-vcpkg)
|
||||
* [Running CMake](#running-cmake)
|
||||
* [Compiling Code](#compiling-code)
|
||||
* [Code Maintenance](#code-maintenance)
|
||||
- [Local Server Setup](#local-server-setup)
|
||||
|
||||
<small><i><a href='http://ecotrust-canada.github.io/markdown-toc/'>Table of contents generated with markdown-toc</a></i></small>
|
||||
|
||||
|
||||
---
|
||||
|
||||
# Compiler Setup
|
||||
|
||||
The current c/c++ support standard of the EQEmulator server code base mandates the use of Visual Studio 2017 or later compilers.
|
||||
|
||||
Visual Studio 2017 is the current EQEmulator standard for binary compilation. Please ensure that your system meets the [[Visual Studio 2017 Minimum System Requirements](https://docs.microsoft.com/en-us/visualstudio/productinfo/vs2017-system-requirements-vs#visual-studio-2017-system-requirements)].
|
||||
|
||||
Visual Studio 2019 may also be used..though, less is known about the stability of this platform with the EQEmulator code base.
|
||||
|
||||
This setup assumes an install on a 64-bit Windows operating system with 32-bit target binaries.
|
||||
|
||||
<br/>
|
||||
|
||||
## Verify System Environment Variable %Path% Length
|
||||
|
||||
Sometimes an automated server installation will fail due to the %Path% variable being full. This can happen with a manual installation as well.
|
||||
|
||||
Since this guide installs more programs than are required for server operation alone, verifying the length of %Path% is critical before we start.
|
||||
|
||||
<br/>
|
||||
|
||||
The easiest way to find it is to:
|
||||
|
||||
* Click on your `Start` button
|
||||
|
||||
* Type "environment variable" into your `Search programs and files` text box
|
||||
|
||||
* Click on `Edit system environment variables`
|
||||
|
||||
* Click the `Environment Variables` button on the window that pops up
|
||||
|
||||
* Ensure the variable `Path` is selected in the system variables section (bottom text box)
|
||||
|
||||
* Click the `Edit` button
|
||||
|
||||
<br/>
|
||||
|
||||
You may check the length of your %Path% variable by copying the `Variable value` contents and pasting them into a text editor that supports "selection" count.
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
Registry values are only allocated 1024 bytes of storage. However, environmental variables may contain up to 2048 bytes through the use of an alias.
|
||||
|
||||
If your selection count is greater than 768 characters, you may need to setup an alias to prevent corruption of the %Path% variable.
|
||||
|
||||
<br/>
|
||||
|
||||
## Required Programs
|
||||
|
||||
Some of the pre-requisites for compiling binaries are the same as running a server.
|
||||
|
||||
<br/>
|
||||
|
||||
If you have already installed any of the following, the download and installation requirement should be omitted:
|
||||
|
||||
* Visual Studio 2017 Community Edition [[select Visual Studio 2017 Community Edition](https://visualstudio.microsoft.com/vs/older-downloads/)]
|
||||
|
||||
_Note: Microsoft now requires a user account to download Visual Studio. Clicking the Visual Studio link above will take you to the "older versions" page. Clicking the_ `Download` _button on that page will prompt you to log in or create an account._
|
||||
|
||||
* Visual Studio 2019 Community Edition [[alternative download](https://visualstudio.microsoft.com/vs/)]
|
||||
|
||||
_Note: Only install one version of Visual Studio_
|
||||
|
||||
<!-- * MariaDB (64-bit) [[download](https://downloads.mariadb.org/interstitial/mariadb-10.4.6/winx64-packages/mariadb-10.4.6-winx64.msi/from/http%3A//mirror.nodesdirect.com/mariadb/)] -->
|
||||
|
||||
* Perl v5.12.3.1204 (32-bit) [[download](https://github.com/EQEmu/eqemu.github.com/raw/master/downloads/ActivePerl-5.12.3.1204-MSWin32-x86-294330.msi)]
|
||||
|
||||
* CMake (64-bit) [[download](https://github.com/Kitware/CMake/releases/download/v3.14.5/cmake-3.14.5-win64-x64.msi)]
|
||||
|
||||
* Git (64-bit) [[download](https://git-scm.com/download/win)]
|
||||
|
||||
* TortoiseGit (64-bit - optional) [[download](https://download.tortoisegit.org/tgit/2.8.0.0/TortoiseGit-2.8.0.0-64bit.msi)]
|
||||
|
||||
_Note: TortoiseGit is a menu-driven, add-on gui interface for Git. Though optional, this instructional provides for its use._
|
||||
|
||||
<br/>
|
||||
|
||||
Some programs may be able to use newer versions, or even their lastest releases, without issue. But, this is not the case with Perl and (later) dependencies.
|
||||
|
||||
The above list of programs is known to work for compiling working server binaries.
|
||||
|
||||
<br/>
|
||||
|
||||
## Install Visual Studio
|
||||
|
||||
During the install process, ensure the option for `Desktop development with C++` is checked.
|
||||
|
||||
|
||||
|
||||
_Note: This package is required by Visual Studio to compile c/c++ code and by CMake to determine available compiler options. It will also cause CMake file generation to fail, if not enabled._
|
||||
|
||||
If you selected Visual Studio 2017 Community Edition, you will need to update to the most current version.
|
||||
|
||||
_Note: This requirement is not needed for Visual Studio 2019 installations..but, it is a good idea to have the most up-to-date compiler features._
|
||||
|
||||
<br/>
|
||||
|
||||
<!-- ## Install MariaDB
|
||||
|
||||
This installation is self-explanatory.
|
||||
|
||||
_Note: You will need to keep track of your username and password. They will be needed anytime that you access the database as well as for setting up the server configuration files._
|
||||
|
||||
<br/>
|
||||
|
||||
At the end of the installation process, you will be prompted to install HeidiSQL. It is **HIGHLY** recommended that you install this program.
|
||||
|
||||
<br/> -->
|
||||
|
||||
## Install Perl
|
||||
|
||||
This installation is self-explanatory.
|
||||
|
||||
_Note: It is recommended that you install in the root folder (_`c:\`_) to avoid possible issues._
|
||||
|
||||
<br/>
|
||||
|
||||
## Install CMake
|
||||
|
||||
This installation is self-explanatory.
|
||||
|
||||
<br/>
|
||||
|
||||
## Install Git
|
||||
|
||||
This installation is self-explanatory.
|
||||
|
||||
<br/>
|
||||
|
||||
## Install TortoiseGit
|
||||
|
||||
This installation is self-explanatory.
|
||||
|
||||
<br/>
|
||||
|
||||
## Restart Computer
|
||||
|
||||
You will need to restart your computer to ensure that all of the %Path% additions are loaded into memory.
|
||||
|
||||
<br/>
|
||||
|
||||
## Acquiring the Code
|
||||
|
||||
At this point, you will need to make a decision on how you want to manage your code.
|
||||
|
||||
<br/>
|
||||
|
||||
There are two options:
|
||||
|
||||
1. Create a local repository from the parent EQEmulator project that can be updated, managed and maintained (recommended)
|
||||
|
||||
2. Create a local repository from a fork of the EQEmulator project that you manage (optional - select only if you want to contribute back to the parent project)
|
||||
|
||||
_Note: If you choose to create a fork of the EQEmulator repository, you will need to create a_ [[github.com](https://github.com/)] _account._
|
||||
|
||||
<br/>
|
||||
|
||||
If you chose option 1, create a sub-folder called `git-eqemulator` in the root folder of c: drive.
|
||||
|
||||
If you chose option 2, create a sub-folder called `git-<git-username>` in the root folder of c: drive. (example: git username is `Pavlov`, folder name would be `git-pavlov`)
|
||||
|
||||
The purpose of this folder is to facilitate code management. We'll refer to this as the `account` folder.
|
||||
|
||||
<br/>
|
||||
|
||||
Go to the EQEmulator server code repository web page at [https://github.com/EQEmu/Server](https://github.com/EQEmu/Server).
|
||||
|
||||
<br/>
|
||||
|
||||
If you chose option 2 and are creating a fork, click on the fork button to add the repository to your github account. You should be redirected to your fork's main repository page.
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
Finally, click the `Clone or download` button, then `Open in Desktop` button to create a local code repository on your computer. Select `TortoiseGit` for the program to use. When prompted for where to create it, select the `account` folder created above.
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
You should now have a managed local code repository on your computer.
|
||||
|
||||
_Note: It is helpful to create a shortcut to the_ `account` _folder and place it on your desktop._
|
||||
|
||||
<br/>
|
||||
|
||||
## Install Submodules
|
||||
|
||||
To install the required submodules:
|
||||
|
||||
* Open your `account` folder
|
||||
|
||||
* Right-click the `Server` folder and select `Git Sync`
|
||||
|
||||
* Find the `Submodule` button and click the attached arrow to activate the drop-down menu
|
||||
|
||||
|
||||
|
||||
* Select `Submodule Init` - this should initiate the action
|
||||
|
||||
* Click the `Submodule` button arrow again to activate the menu
|
||||
|
||||
* Select `Submodule Update` - again, initiating action
|
||||
|
||||
<br/>
|
||||
|
||||
Submodules are now installed.
|
||||
|
||||
<br/>
|
||||
|
||||
## Install Dependencies
|
||||
|
||||
To install the required dependencies:
|
||||
|
||||
* Download the [[dependencies](https://github.com/EQEmu/eqemu.github.com/raw/master/downloads/WindowsDependencies_x86.zip)] file
|
||||
|
||||
* Navigate down to `c:\<account>\Server\dependencies`
|
||||
|
||||
* Copy the downloaded file into the folder
|
||||
|
||||
* Unpack the file
|
||||
|
||||
<br/>
|
||||
|
||||
Dependencies are now installed.
|
||||
|
||||
<br/>
|
||||
|
||||
## Install VCPkg
|
||||
|
||||
To install VCPkg:
|
||||
|
||||
* Download the [[vcpkg](https://github.com/EQEmu/Server/releases/download/v1.2/vcpkg-export-x86.zip)] file
|
||||
|
||||
* Navigate down to `c:\<account>\Server`
|
||||
|
||||
* Create a folder called `vcpkg`
|
||||
|
||||
* Navigate down to `c:\<account>\Server\vcpkg`
|
||||
|
||||
* Copy the downloaded file into the folder
|
||||
|
||||
* Unpack the file
|
||||
|
||||
<br/>
|
||||
|
||||
VCPkg is now installed.
|
||||
|
||||
<br/>
|
||||
|
||||
## Running CMake
|
||||
|
||||
CMake's default options are adequate to configure and generate the files needed for Visual Studio.
|
||||
|
||||
<br/>
|
||||
|
||||
There are two folder locations that you will need to provide:
|
||||
|
||||
* `Where is the source code:`
|
||||
|
||||
* `Where to build the binaries:`
|
||||
|
||||
<br/>
|
||||
|
||||
For the source code, type-in or navigate to your `c:/<account>/Server` folder.
|
||||
|
||||
The easiest way to define the build folder is to copy the source path and paste it in. Then, add `/build` to the end of the path so that you have `c:/<account>/Server/build`.
|
||||
|
||||
</br>
|
||||
|
||||
Once CMake knows where to look, click the `Configure` button. You will get a pop-up window stating that the `build` folder does not exist. Click `OK` to create it.
|
||||
|
||||
<br/>
|
||||
|
||||
The next window will be for compiler selection. Ensure that the version of Visual Studio that you installed is selected (`Visual Studio 15 2017` or `Visual Studio 16 2019`). Click the radio button next to `Specify toolchain file for cross-compiling`. Finally, click `Finish` to proceed.
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
CMake will need the location of the VCPkg. Navigate down to the `C:/<account>/Server/vcpkg/vcpkg-export-20180828-145854/scripts/buildsystems/vcpkg.cmake` file and click ok. CMake will begin by configuring the VCPkg dependencies.
|
||||
|
||||
_Note: Cmake will remember this location after the first assignment._
|
||||
|
||||
<br/>
|
||||
|
||||
You should now have a list of unconfigured options (in red) displayed in the main window of CMake:
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
The following list contains the most common options of interest to the majority of users:
|
||||
|
||||
* `EQEMU_BUILD_CLIENT_FILES` [_enabled_] Builds binaries used to import/export client support files
|
||||
|
||||
* `EQEMU_BUILD_LOGIN` [_disabled_] Builds the login server (this guide makes use of the login server - change this option to _**enabled**_)
|
||||
|
||||
* `EQEMU_BUILD_LUA` [_enabled_] Compiles server code with Lua support
|
||||
|
||||
* `EQEMU_BUILD_PERL` [_enabled_] Compiles server code with Perl support
|
||||
|
||||
* `EQEMU_DEBUG_LEVEL` [_5_] Determines what additional messaging and debugging code is enabled/disabled (_12_ is max)
|
||||
|
||||
* `EQEMU_ENABLE_BOTS` [_disabled_] Compiles server code with Bot support (user choice)
|
||||
|
||||
_Note: Ensure that you set_ `EQEMU_BUILD_LOGIN` _to **enabled**_.
|
||||
|
||||
<br/>
|
||||
|
||||
Once you have set the options that you would like for your server, click `Configure` again.
|
||||
|
||||
<br/>
|
||||
|
||||
Since we set an option (login server) that requires additional settings, more unconfigured options have appeared. In this case, the open ssl library:
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
These new options are only file path definitions. No additional changes need to be made. Click `Configure` one last time.
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
_Note: Regardless of option settings, anytime that you have red (unconfigured) entries in your options list, you will need to click_ `Configure` _to ensure that the settings are applied to the current CMake file generation template._
|
||||
|
||||
<br/>
|
||||
|
||||
You can now click the `Generate` button.
|
||||
|
||||
If file generation was successful, you should see "Generating done" at the bottom of the CMake window.
|
||||
|
||||
<br/>
|
||||
|
||||
You are now ready to open Visual Studio and compile your code!
|
||||
|
||||
<br/>
|
||||
|
||||
## Compiling Code
|
||||
|
||||
To open the CMake-generated solution file:
|
||||
|
||||
* Navigate through the desktop `account` folder shortcut to `c:\<account>\Server\build`
|
||||
|
||||
* Right-click the `EQEmu.sln` file
|
||||
|
||||
* Select `Open with` >> (`Microsoft Visual Studio 2017` or `Microsoft Visual Studio 2019`)
|
||||
|
||||
<br/>
|
||||
|
||||
Upon loading, Intellisense will begin mapping out the entire project. Allow a few seconds for this process to finish. The lower left-hand corner will display "Ready" when this process has completed.
|
||||
|
||||
<br/>
|
||||
|
||||
Visual Studio does not honor CMake's `CMAKE_BUILD_TYPE` variable. You will need to manually set this to the desired build type before compiling your code.
|
||||
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
There are 4 options:
|
||||
|
||||
* `Debug` - not recommended for production servers unless conditions warrant its use (i.e., load testing, trouble-shooting, etc...)
|
||||
|
||||
* `RelWithDebugInfo` - standard compile for production servers (provides debug symbols without the added overhead of extra code, memory buffers and stl assertions)
|
||||
|
||||
* `Release` - similar to `RelWithDebugInfo`..but, without access to debug symbols (not recommended)
|
||||
|
||||
* `MinSizeRel` - Same as `Release` with the exception of trading off faster code for smaller size (not recommended)
|
||||
|
||||
_Note:_ `Debug` _is preferred for a local test server._
|
||||
|
||||
<br/>
|
||||
|
||||
To compile your server code, you have two choices:
|
||||
|
||||
* Use the menu path under the top menu (`Build` >> `Build`)
|
||||
|
||||
* Use the menu path by right-clicking under `Solution Explorer` (`Solution 'EQEmu'` >> `Build`)
|
||||
|
||||
|
||||
|
||||
_Note: Both paths result in the same action. Use whichever you are more comfortable with._
|
||||
|
||||
<br/>
|
||||
|
||||
The compiled code will be located in the `c:\<account>\Server\build\bin\<build_type>` folder.
|
||||
|
||||
<br/>
|
||||
|
||||
## Code Maintenance
|
||||
|
||||
* Working Tree Changes
|
||||
|
||||
* Master Branch Code Updates
|
||||
|
||||
* Dependencies and Submodules Updates
|
||||
|
||||
* Branches and Stashes
|
||||
|
||||
* Reverting Changes
|
||||
|
||||
* Resetting to Previous Commits
|
||||
|
||||
---
|
||||
|
||||
# Local Server Setup
|
||||
Reference in New Issue
Block a user