mirror of
https://github.com/EQEmu/Server.git
synced 2026-04-14 11:52:25 +00:00
Updated Ground Up Windows Install Rework (markdown)
Uleat
parent
49994807f4
commit
f44cce1347
@ -2,8 +2,31 @@
|
||||
|
||||
**Read through this guide before starting to ensure an understanding of the process.**
|
||||
|
||||
**Please direct any questions to our server support channel in
|
||||
[[discord](https://discord.gg/QHsm7CD)].**
|
||||
**Please direct any questions to our server support channel in [[discord](https://discord.gg/QHsm7CD)].**
|
||||
|
||||
---
|
||||
|
||||
# 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 MariaDB](#install-mariadb)
|
||||
* [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 Dependencies](#install-dependencies)
|
||||
* [Install Submodules](#install-submodules)
|
||||
* [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>
|
||||
|
||||
---
|
||||
|
||||
@ -17,12 +40,16 @@ If your system does not meet the above requirements, or you are/would like to us
|
||||
|
||||
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
|
||||
@ -37,18 +64,26 @@ The easiest way to find it is to:
|
||||
|
||||
* 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/)]
|
||||
@ -63,16 +98,18 @@ If you have already installed any of the following, the download and installatio
|
||||
|
||||
* Git (64-bit) [[download](https://git-scm.com/download/win)]
|
||||
|
||||
_Note: Should you wish to download the repository code with no further chance of updating or restoration, this requirement may be omitted._
|
||||
|
||||
* 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. If Git is not installed, this installation should be omitted._
|
||||
_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.
|
||||
@ -81,114 +118,176 @@ During the install process, ensure the option for `Desktop development with C++`
|
||||
|
||||
_Note: This package is required by Visual Studio to compile c/c++ code and by CMake to determine available compiler options. It will cause CMake file generation to fail, if not enabled._
|
||||
|
||||
<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 directory (_`c:\`_) to avoid possible issues._
|
||||
_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.
|
||||
|
||||
There are three options:
|
||||
<br/>
|
||||
|
||||
1. Retrieve the code as a one-time download (unmanaged - not recommended)
|
||||
There are two options:
|
||||
|
||||
1. Create a local repository from the parent EQEmulator project that can be updated, managed and maintained (**recommended**)
|
||||
1. Create a local repository from the parent EQEmulator project that can be updated, managed and maintained (recommended)
|
||||
|
||||
1. 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)
|
||||
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._
|
||||
_Note: If you choose to create a fork of the EQEmulator repository, you will need to create a_ [[github.com](https://github.com/)] _account._
|
||||
|
||||
If you chose options 1 or 2, create a sub-directory called `git-eqemulator` in the root directory of c: drive.
|
||||
<br/>
|
||||
|
||||
If you chose option 3, create a sub-directory called `git-<git-username>` in the root directory of c: drive. (example: git username is `Pavlov`, directory name would be `git-pavlov`)
|
||||
If you chose options 1, create a sub-folder called `git-eqemulator` in the root folder of c: drive.
|
||||
|
||||
The purpose of this directory is to facilitate code management. We'll refer to this as the `account` directory.
|
||||
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`)
|
||||
|
||||
For option 1:
|
||||
The purpose of this folder is to facilitate code management. We'll refer to this as the `account` folder.
|
||||
|
||||
* Download [[Server-master.zip](https://github.com/EQEmu/Server/archive/master.zip)]
|
||||
<br/>
|
||||
|
||||
* Place it inside of the `account` directory
|
||||
Go to the EQEmulator server code repository web page at [https://github.com/EQEmu/Server](https://github.com/EQEmu/Server).
|
||||
|
||||
* Unpack its contents
|
||||
<br/>
|
||||
|
||||
* Rename the local code directory from `Server-master` to `Server`
|
||||
|
||||
* Move on to [[Download Dependencies](Ground-Up-Windows-Install-Rework#download-dependencies)]
|
||||
|
||||
For options 2 & 3, go to the EQEmulator server code repository web page at [https://github.com/EQEmu/Server](https://github.com/EQEmu/Server).
|
||||
|
||||
If you chose option 3 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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
Finally, click the `Clone or download` button, then `Open in Desktop` button to create a local code repository on your computer. When prompted for where to create it, select the `account` directory created above.
|
||||
<br/>
|
||||
|
||||
Finally, click the `Clone or download` button, then `Open in Desktop` button to create a local code repository on your computer. 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` _directory and place it on your desktop._
|
||||
_Note: It is helpful to create a shortcut to the_ `account` _folder and place it on your desktop._
|
||||
|
||||
## Download Dependencies
|
||||
<br/>
|
||||
|
||||
Library dependencies can be downloaded from [[here](https://github.com/EQEmu/eqemu.github.com/raw/master/downloads/WindowsDependencies_x86.zip)].
|
||||
## Install Dependencies
|
||||
|
||||
Inside of your local code directory, you will find a sub-directory called `dependencies`.
|
||||
To install the required dependencies:
|
||||
|
||||
Just place this download inside of the `dependencies` folder and unpack its contents.
|
||||
* 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 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/>
|
||||
|
||||
## Running CMake
|
||||
|
||||
CMake's default options are adequate to configure and generate the files needed for Visual Studio.
|
||||
|
||||
There are two directory locations that you will need to provide:
|
||||
<br/>
|
||||
|
||||
There are two folder locations that you will need to provide:
|
||||
|
||||
* `Where is the source code:`
|
||||
|
||||
* `Where to build the binaries:`
|
||||
|
||||
For the source code, type-in or navigate to your `c:/<account>/Server` directory.
|
||||
<br/>
|
||||
|
||||
The easiest way to define the build directory 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`.
|
||||
For the source code, type-in or navigate to your `c:/<account>/Server` folder.
|
||||
|
||||
Once CMake knows where to look, click the `Configure` button. You will get a pop-up window stating that the `build` directory does not exist. Click `OK` to create it.
|
||||
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 `Visual Studio 15 2017` is selected, then click `Finish` to proceed.
|
||||
|
||||
|
||||
|
||||
<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
|
||||
@ -205,41 +304,63 @@ The following list contains the most common options of interest to the majority
|
||||
|
||||
_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 Visual Studio solution file that we created with CMake, navigate through the desktop `account` folder shortcut to `c:\<account>\Server\build`
|
||||
To open the CMake-generated solution file:
|
||||
|
||||
There, you will find the `EQEmu.sln` file.
|
||||
* Navigate through the desktop `account` folder shortcut to `c:\<account>\Server\build`
|
||||
|
||||
Right-click it and select `Open with` >> `Microsoft Visual Studio 2017`
|
||||
* Right-click the `EQEmu.sln` file
|
||||
|
||||
* Select `Open with` >> `Microsoft Visual Studio 2017`
|
||||
|
||||
<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 and trouble-shooting)
|
||||
* `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)
|
||||
|
||||
@ -249,21 +370,37 @@ There are 4 options:
|
||||
|
||||
_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 under the top menu (`Build` >> `Build`)
|
||||
|
||||
* Use the menu path by right-clicking under `Solution Explorer`. `Solution 'EQEmu'` >> `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._
|
||||
|
||||
The compiled code will be located in the `c:\<account>\Server\build\bin\<build_type>` directory.
|
||||
<br/>
|
||||
|
||||
The compiled code will be located in the `c:\<account>\Server\build\bin\<build_type>` folder.
|
||||
|
||||
<br/>
|
||||
|
||||
## Code Maintenance
|
||||
|
||||
[final thoughts...]
|
||||
* Working Tree Changes
|
||||
|
||||
* Master Branch Code Updates
|
||||
|
||||
* Dependencies and Submodules Updates
|
||||
|
||||
* Branches and Stashes
|
||||
|
||||
* Reverting Changes
|
||||
|
||||
* Resetting to Previous Commits
|
||||
|
||||
---
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user