Read through this guide before starting to ensure an understanding of the process.
-Please direct any questions to our support channel in [discord].
+Please direct any questions to our server support channel in [discord].
The current c/c++ support standard of the EQEmulator server code base mandates the use of Visual Studio 2015 [check version] or later compilers.
@@ -44,10 +46,10 @@ -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.
+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.
-
+
Registry values are only allocated 1024 bytes of storage. However, environmental variables may contain up to 2048 bytes through the use of an alias.
@@ -58,7 +60,7 @@Some of the pre-requisits for compiling binaries are the same as running a server.
+Some of the pre-requisites for compiling binaries are the same as running a server.
If you have already installed any of the following, the download and installation requirement should be omitted.
@@ -84,6 +86,8 @@ +Note: TortoiseGit is a menu-driven, addon-on gui interface for Git. Though optional, this instructional provides for its use.
+Some programs may be able to use newer versions, or even the 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.
@@ -92,7 +96,9 @@During the install process, ensure the option for 'Desktop development with C++' is checked. This is required by CMake to determine available compiler options. CMake file generation will fail if this option is not enabled.
+During the install process, ensure the option for 'Desktop development with C++' is checked.
+ +This package is required to compile c/c++ code and by CMake to determine available compiler options. It will cause CMake file generation to fail if not enabled.
@@ -160,23 +166,63 @@
Option 1, Retrieve the code as a one-time download (not recommended)
Option 1, Retrieve the code as a one-time download (unmanaged - not recommended)
Option 2, Create a local repository from the parent EQEmulator project that can be updated, managed and maintained (recommended)
Option 3, Create a local repository from a fork of the EQEmulator project that you manage (recommended 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] account.
-[walk-through for option 2]
+If you choose options 1 or 2, create a sub-directory called 'git-eqemulator' in the root directory of c: drive.
+ +If you choose 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')
+ +The purpose of this directory is to facilitate code management. We'll refer to this as the 'account' directory.
+ +For option 1:
+ +Download [Server-master.zip]
Place it inside of the account directory
Unpack its contents
Rename the local code directory from 'Server-master' to 'Server'
Move on to Download Dependencies
For other options, go to the EQEmulator server code repository web page at 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 account. You should be redirected to your fork's main repository page.
+ +
+
+Finally, click the clone 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.
+ +
+
+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.
Library dependencies can be downloaded directly from [here].
+Library dependencies can be downloaded from [here].
Inside of your local code directory, you will find a sub-directory called 'dependencies`.
@@ -202,9 +248,14 @@ + +