UOX3 is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
* * * In addition to that license, if you are running this program or modified versions of it on a public system you HAVE TO make the complete source of the version used by you available or provide people with a location to download it. * * *
To install UOX3, first download the All-In-One UOX3 package from the Downloads-page at UOX3.org. You'll need a program capable of unpacking .ZIP files to extract the files from the package, so if you don't already have one, and your Operative System doesn't natively support these files, go download WinZip.
Note that there may be newer UOX3 versions available since the the latest release, these versions can be accessed by downloading the sourcecode from the CVS and compiling it yourself, or by downloading an experimental build. It's recommended that you download the latest experimental build if it's much newer than the latest release-version, to get the latest fixes and additions to UOX3.
Once that is out of the way, doubleclick on the All-In-One zip-file and click the 'Extract' button, or click on the Actions-menu and select "Extract" from there. Now enter a path to where you want the UOX3 files to be unpacked. Popular choices include C:\UOX3 or D:\UOX3. Once all the files have been extracted, proceed to the next section of this document.
After extracting the UOX3 files, browse your way to the newly created UOX3 folder using Explorer or My Computer, then double-click the UOX.INI file (if no file-extensions show up for your files, double-click the one named UOX listed as a "Configurations Settings"-file) to open it in a text-editor.
Configuration Step 1 - Name and IP, please
The UOX.INI contains a multitude of settings, but you should concentrate on only two for now, simply to get your server up and running as it should. The first thing you should do is set the name and IP-address of your UOX3 shard, so locate the [play server list] section, which by default will look something like this:
[play server list]
SERVERLIST=Default UOX3 Server,127.0.0.1,2593
Replace "Default UOX3 Server" with the name you want for your shard. If you're running UOX3 on the same computer as the UO Client, then you don't have to change the default IP address (127.0.0.1) to be able to login. But if you plan on making your server available for others on the Internet, or over a LAN, you might want to either change the IP-address to your Internet/LAN-ip, or add additional SERVERLIST= entries, like this (replace the actual IP-addresses for Online/LAN-server with yours):
[play server list]
Configuration Step 2 - Datadirectory Path
Next thing on our list is to make sure that UOX3 can properly access the necessary data-files it needs to run, so locate the [directories] section of the file. Only one directory-path needs to be changed - the path to the DATADIRECTORY, which should point to your Ultima Online folder. By default Ultima Online is installed to something similar to C:\program files\ultima online\, but if you installed it elsewhere, make sure you enter the correct path here. Examples of different paths to the Datadirectory:
(In the last example, the following files from the UO folder would be copied to a "datafiles"-folder inside the UOX3 folder: map0.mul, staidx0.mul, statics0.mul, map0.mul, tiledata.mul, multi.mul and multi.idx)
When done, save and close UOX.INI.
Configuration Step 3 - Account Setup
The last thing you'll need to do before you're done configuring UOX3, is to locate ACCOUNTS.ADM in UOX3\ACCOUNTS\ and open it using your favourite text-editor - for instance Notepad. The first thing you'll see in that file, is the commented (prefixed by //) example-account. Scroll down past that until you reach the first uncommented account-section, named SECTION ACCOUNT 0.
That account is your shard's ADMIN-account, and you should change the username and password from admin/admin to something a bit harder to guess. Don't make it too hard though, as this is the account you will be logging in with when you need to administer your shard. Any characters created using this account will automatically gain GameMaster-privileges and will have access to all commands in UOX3.
After you've changed the default username and password, the first account should look something like this:
SECTION ACCOUNT 0
CHARACTER-1 0xffffffff [UNKNOWN]
CHARACTER-2 0xffffffff [UNKNOWN]
CHARACTER-3 0xffffffff [UNKNOWN]
CHARACTER-4 0xffffffff [UNKNOWN]
CHARACTER-5 0xffffffff [UNKNOWN]
That is all you have to change, UOX3 will handle the rest - such as changing the path to the account-data, and more. So save and close the accounts.adm file.
If you want additional user accounts now or in the future, you can set up those in the NEWACCOUNTS.ADM file, which should be located in the same folder as ACCOUNTS.ADM. If it's not there, create an empty one yourself.
These additional user accounts must be added using the following format; one account per line, minimum four letters in usernames/passwords. Remember to press 'Enter' after the final line!):
UOX3 reads NEWACCOUNTS.ADM during/after worldsaves, and will then automatically add the new accounts to the ACCOUNTS.ADM-file.
You can now start up your UOX3 shard either by double-clicking on UOX3.EXE in your UOX3 folder, or by starting it from a command prompt - which is recommended since then the UOX3 window won't close if there's an error. If everything goes according to plan, you should see no errors during startup (ignore any instances of [Skipped]), and UOX3 will come to a halt at the following lines.
| UOX: Startup Complete
| Thread: CheckConsoleThread has started
If you do see any errors, and UOX3 never reaches the above mentioned lines, then you should revisit the earlier sections of this guide to see where you might have done something wrong.
One thing you should take note of right now, is that by default your shard will be empty of any Non-Player Characters (NPCs) and decorative/usable items such as roadsigns, doors and containers. You can fix this by either populating your world manually after logging in, or by downloading premade spawn and/or worldfiles from the UOX3 Downloads-page.
Should you need to shut down UOX3 for any reason, it's important that you do it correctly to avoid the loss of characters/items/changes to your world. If you simply close UOX3 by clicking the 'X' in the top right corner of the console window, any changes since the last worldsave will be lost!
To properly shut down UOX3, either use the in-game command 'SHUTDOWN # where # is the number of seconds until the shutdown occurs (will be globally announced), or press '*' in the console window to disable safe-mode, followed by either 'Q' or the 'Esc'-key.
This will prompt UOX3 to perform a worldsave before shutting down properly.
If no errors occur during startup, and your shard is up and running (keep the UOX3 window running!), it's time to configure the UO client.
For further customization of your shard, check out the server-settings-page, which contains all the details about the various settings available in UOX.INI.