/UOX3

Ultima Offline eXperiment 3 - the original open source Ultima Online server emulator - v0.99.4

Primary LanguageC++OtherNOASSERTION

UOX3

License: GPL v2

master Windows x86 Build

develop Windows x86 Build - develop

Ultima Offline eXperiment 3 - the original open source Ultima Online server emulator, allowing people to run their own, custom UO shards since 1997. News, releases, forums, additional documentation and more can be found at https://www.uox3.org

Supported UO Client versions: ~4.0.0p to ~7.0.86.2 (with encryption removed by Razor or similar tool). For additional details on UO client compatibility, check http://www.uox3.org/forums/viewtopic.php?f=1&t=2289

Join the UOX3 Discord for support and/or a quick chat!

How to compile UOX3...

...under Linux or macOS

Step 1: Clone the UOX3 Git Repository

Using git and Terminal

First step, open a new terminal and enter the commands below:

  1. (Linux) sudo apt install git - This will install git if not already installed (Ubuntu/Debian-based Linux variants). If you're using a non-Debian flavour of Linux, use the default package manager that comes with it to install git instead.
  2. (macOS) xcode-select --install - This will install git if not already installed, along with required make and gcc tools
  3. git clone https://github.com/UOX3DevTeam/UOX3.git - This will clone the stable master branch of the UOX3 git repository into a subdirectory of the current directory you're in, named UOX3. The latest verified compatible version of SpiderMonkey (v1.7) is also included.
Checking out Other Branches

If you'd rather grab another branch of the git repository, like the develop branch where most updates get pushed first before being merged into the master branch, you can use the following command after completing the previous step: git checkout develop

(macOS alternative) GitHub Desktop
  1. Download and install the macOS version of GitHub Desktop.
  2. Run GitHub Desktop and click File->Clone Repository from the menu.
  3. Click the URL tab, enter https://github.com/UOX3DevTeam/UOX3.git, then provide a local path for where you want the UOX3 git repository cloned on your drive.
  4. Hit the Clone button!

Step 2: Compile UOX3

GNU Make and GCC

You'll need a couple tools before you can compile UOX3 on Linux, like GNU Make (v4.2.1 or higher recommended) and gcc. Install these through your favourite package manager or through your flavour of Linux' variant of the following terminal command (specific to Debian/Ubuntu Linux flavours):

  1. (Linux only) sudo apt install build-essential

Once these are in place, navigate to the UOX3 project folder in your terminal and execute the following commands from the project's root directory, in order:

  1. chmod +x automake.sh - Makes the automake.sh bash script executable.
  2. ./automake.sh - First compiles the SpiderMonkey JS library bundled with UOX3, then compiles the actual UOX3 build, before copying the compiled binary to the root UOX3 project directory.
Manual Instructions

If you don't wish to rely on the automake.sh script, but want control over the process yourself, follow these steps (same as what automake.sh does):

  • cd spidermonkey
  • make -f Makefile.ref DEFINES=-DHAVE_VA_LIST_AS_ARRAY CC=gcc

Linux

  • ar -r libjs32.a Linux_All_DBG.OBJ/*.o
  • cp Linux_All_DBG.OBJ/jsautocfg.h ./

macOS

  • ar rcs libjs32.a Darwin_DBG.OBJ/*.o
  • cp Darwin_DBG.OBJ/jsautocfg.h ./

At this point, now cd to the root UOX3 project directory and build UOX3:

  • cd ../source
  • make

Once done compiling, you will find the compiled uox3 binary in the root UOX3 directory. You can copy this binary to the directory you intend to run your UOX3 shard from, along with all the files and folders contained in the UOX3/data subdirectory.

It is recommended to run your UOX3 shard from a separate, dedicated directory instead of the data directory in your local UOX3 git repository, to avoid potential git conflicts and accidental overwrites when pulling updates to UOX3 from GitHub in the future.

Copying Required Files to Dedicated UOX3 Directory

This is an example of how to copy all required files to a directory called UOX3 in your user account's home directory

  1. navigate to root UOX3 project directory
  2. mkdir ~/UOX3
  3. cp uox3 ~/UOX3
  4. cp -r data/* ~/UOX3
  5. cd ~/UOX3

Once you have all the required files in place, you can follow the regular steps listed under Installation and Setup > Configuring Your UOX3 Shard in the UOX3 documentation (see docs folder, or visit https://www.uox3.org/docs/index.html#configureUOX3) to finish your UOX3 setup.

...under Windows

Step 1: Clone the UOX3 Git Repository

  1. Download and install GitHub Desktop. If you already have another tool for git installed, you can use that instead.
  2. Run GitHub Desktop (or your preferred git tool) and click File->Clone Repository from the menu.
  3. Click the URL tab, enter https://github.com/UOX3DevTeam/UOX3.git, then provide a local path for where you want the UOX3 git repository cloned on your drive.
  4. Hit the Clone button to clone the stable master branch of the UOX3 git repository to the specified local path, along with the latest verified compatible version of SpiderMonkey (v1.7).

Step 2: Compile UOX3

Option A) Visual Studio 2017/2019 (Free Community edition)

This option will let you use Visual Studio solution/project files to compile both UOX3 and SpiderMonkey with Visual Studio's default VC++ compiler. Note that you can download the Free Community edition of Visual Studio if you don't have it already. This approach also embeds SpiderMonkey directly inside UOX3 for a slightly larger (~1-2MB) executable, instead of requiring a separate DLL file, and comes with options for compiling either 32-bit or 64-bit (default) versions of UOX3.

SpiderMonkey

  1. Navigate to the UOX3\spidermonkey folder and open SpiderMonkey.sln in Visual Studio.
  2. Make sure you have js32 selected in the Solution Explorer, then select Release and either x64 (64-bit) or Win32 (32-bit) in the Solution Configuration/Platform dropdown menus
  3. Click Build > Build js32 from the menu.
  4. Visual Studio will compile SpiderMonkey and create spidermonkey\Release\x64 (64-bit) or spidermonkey\Release\x86 (32-bit) folders with the compiled js32.lib library file contained within. No further actions are necessary here, so you can close the SpiderMonkey VS Solution.

UOX3

  1. Open UOX3_Official.sln from the UOX3\source folder.
  2. Make sure you have UOX3_Official selected in the Solution Explorer, then select either Release or Debug, and either x64 (64-bit) or Win32 (32-bit) in the Solution Configuration/Platform dropdown menus, or via Build -> Configuration Manager.
  3. Select Build -> Build UOX3_Official to start compiling UOX3. When done, you'll find UOX3.exe either in UOX3\source\Release\x64 (or \x86) or in UOX3\source\Debug\x64 (or \86), depending on your choices in the previous step.
Adding SpiderMonkey references in Configuration Manager

If VS give you link errors when attempting to build UOX3, references to SpiderMonkey might have gone missing! Try the following steps to add them back.

  1. Right click on UOX3_Official in the Solution Explorer, and select Properties.
  2. With the desired configuration (ex: Release, x64) selected at the top of the panel, add references to SpiderMonkey in these sections:
  • VC++ Directories > Include Directories (add path to SpiderMonkey root folder)
  • VC++ Directories > Library Directories (add path to SpiderMonkey release\x64 or \x86 folder depending on desired configuration)
  • VC++ Directories > Source Directories (add path to SpiderMonkey root folder)
  • Linker > Additional Library Dependencies (add path to SpiderMonkey release\x64 or \x86 folder depending on desired configuration) Press apply! Repeat process for both Release and Debug configurations (chosen at top of panel), then retry the UOX3 build process!

Option B) Visual Studio 2017/2019 and CMake (Free Community edition)

Visual Studio 2017/2019 and CMake

This option requires installing the Visual Studio toolset named Linux development with C++ and the component called Visual C++ tools for CMake and Linux. Use the Visual Studio Installer to modify your install of Visual Studio if you don't already have these installed! This approach compiles SpiderMonkey to a separate DLL (js32.dll) file that needs to live inside the same folder as the main UOX3 executable, and currently only supports compiling a 32-bit version of UOX3.

  1. Start Visual Studio and use File > Open > CMake and select CMakeLists.txt in the root project folder (Example: D:\UOX3). Don't open the similarly named file in the source folder directly.
  2. After Visual Studio is done loading the project and has generated some necessary files, select CMake > Change CMake Settings > UOX3 from the toolbar menu, and select either x86-Debug or x86-Release depending on what kind of build you want to make - or do this using the Solution Configuration select menu.
  3. When Visual Studio is done switching to the new configuration, select CMake > Build All from the toolbar menu to start compiling UOX3.
  4. When done, you'll find uox3.exe and js32.dll in a subfolder named out of the root project folder, more specifically /UOX3/out/build/x86-Debug or x86-Release, based on the selected configuration.
  5. Note that the js32.dll file must be copied to the same folder as UOX3.exe.

Once done compiling, you can copy your new uox3.exe (and if using CMake, js32.dll) file from the appropriate output folders (depending on which method and configuration you used) to the root folder of your actual UOX3 project. You'll also need to copy the files and folders contained within the data subfolder of the UOX3 repository, if you don't already have these.

It is recommended to run your UOX3 shard from a separate, dedicated folder instead of the data folder in your local UOX3 git repository, to avoid potential git conflicts and accidental overwrites when pulling updates to UOX3 from GitHub in the future.

Once you have all the required files in place, you can follow the regular steps listed under Installation and Setup > Configuring Your UOX3 Shard in the UOX3 documentation (see docs folder, or visit https://www.uox3.org/docs/index.html#configureUOX3) to finish your UOX3 setup!