Volume 2 Server Setup

From Project: Ouroboros
Jump to navigation Jump to search

This guide will help you get started in running your own City of Heroes server on your local host (127.0.0.1). It assumes that you will run the City of Heroes client on the same machine as the server. Once you have that working, you can move on to the following guide which explains how to modify your server to allow external access from game clients on other machines.

Recommended hardware and settings

  1. The main requirement for City of Heroes is having a decent amount of RAM. The minimum amount for a small personal server is about 8 GB of RAM, with 32 GB of RAM being the recommended amount.
    • If you are running with less than the recommended 32 GB of RAM, it is also recommended that you increase your Windows paging file to simulate having more RAM (Control Panel->System and Security->System->Advanced System Settings->Advanced->Performance Settings->Advanced->Virtual Memory->Change). Setting your paging file to 32768 MB works well for a server with 8 GB of RAM.
    • To support a larger number of players connecting, you will need to add more RAM to your server, though it currently isn't clear at what numbers of players these recommended values become insufficient.
    • For the purposes of this guide, I am using 64.0 GB (G. Skill Trident Z Royal Silver 3200Mhz PC4-25600).
  2. The server is CPU-intensive, having a decent CPU is important.
    • This setup has been tested with multiple configurations with the oldest recommended being an Intel Core i7 6th Generation Processor.
    • For the purposes of this guide, I am using the Intel Core i9-9900K Processor.
  3. Running the server on a solid state drive instead of a spinning disc hard drive is recommended.
  4. If you are installing the server on a computer that you own, your router will need to support NAT loopback if you want game clients to be able to connect to it from both inside and outside of your LAN.
    • For the purposes of this guide, I am using an ASUS ROG GT-AX11000 gaming router.

Required software

Download all of the following files:

  1. SQL Server 2017 Express Edition
  2. SQL Server Management (SSMS) 18.3.1
  3. The latest stable release of the CoX/Source files from http://build.ourodev.com/archives/Source.master.7z. These are the compiled files from the OuroDev build machine. Extract the contents of the zip file into C:\Ouroboros. (or if you want to compile the source files yourself, follow the Volume 2 Build instructions, then copy the contents of the Source\bin directory to C:\Ouroboros)
  4. Database schema definitions. For now, get them from https://git.ourodev.com/CoX/Source/src/tag/v2-i1.0.0/Assets/DBSchemas (or if you have cloned the CoX/Assets repository from Git, you can get them from C:\Git\CoX\Source\Assets\DBSchemas)
  5. Sample server config files. For now, get them from https://git.ourodev.com/CoX/Source/src/tag/v2-i1.0.0/Assets/ConfigFiles (or if you have cloned the CoX/Assets repository from Git, you can get them from C:\Git\CoX\Source\Assets\ConfigFiles)
  6. the Issue 24 client and data files - this is not the SCORE client/data.
  7. CoHDev_Source_Files_Current(Updated).zip.
  8. ServerData.7z.

Optional but recommended tools

Download all of the following:

  1. (Optional) Install 7zip (https://www.7-zip.org/download.html)
    • Useful if you do not already have a tool to handle zip files
  2. (Optional) Install Notepad++ (https://notepad-plus-plus.org/downloads/v7.7.1/)
    • Useful for editing config files.

Install SQL Server 2017 Express

You can install SQL Server pretty much on the default settings.
Select Basic under installation type:
SQL Server Install 2017 Express.png
Agree to the EULA if you want to use SQL Server.
SQL Server Install 2017 Express - 2.png
Tell the server where to install files. I changed this for ease on my system.
SQL Server Install 2017 Express - 3.png
It should begin installing and eventually you should see "Install has completed successfully". Click close.
SQL Server Install 2017 Express - 4.png

Install SQL Server Management(SSMS)

You can install SQL Server Management on default settings.
Select the location you'd like to install SSMS to. The default is fine.
SSMS Install - 1.png
It will take awhile to install and you'll see a little progress bar letting you know whats going on
SSMS Install - 2.png
Eventually it will ask you to reboot the system. Might as well as do that now.
SSMS Install - 3.png

Setup server files

  1. At this point, you should have C:\Ouroboros containing exes and dlls
  2. Create a directory in C:\Ouroboros called data.
  3. Open ServerData.7z and extract all files into C:\Ouroboros\data (the newly created directory).
  4. Open CoHDev_Source_Files_Current(Updated).zip.
    1. Extract "i24 Server and Client Piggs (extracted with CoHTools)" into C:\Ouroboros\data.
    2. Copy maps.db from "map.db (modified, working on current VS2010 build)" and place it in C:\Ouroboros\data\server\db, overwriting the old maps.db
  5. Copy the piggs folder from your i24 client directory and place them in C:\Ouroboros\. You should end up with C:\Ouroboros\piggs\ populated.
  6. If installing v2i1, create a directory in your C: drive called "CoH_Data" and another directory inside that, called "attributes" (C:\CoH_Data\attributes). In later versions, this isn't necessary.
  7. Run the following in a command prompt. If it gives you an error message, check the Troubleshooting section. It is essential to run this after all the above steps, because it will overwrite some of the files.
    cd c:\Ouroboros
    .\mapserver.exe -productionmode -templates
  8. If installing v2i1, copy all files from C:\CoH_Data\attributes and place them into C:\Ouroboros\data\server\db\templates. If installing a later version, the files should be placed there automatically.
  9. If you didn't get them from a downloaded release, copy all sample config files from Source/Assets/ConfigFiles into c:\Ouroboros (for example: Source/Assets/ConfigFiles/data/server/db will become C:/Ouroboros/data/server/db)

Database setup

 Note: If you have a problem downloading these files, copy and paste the contents into notepad++, and then save the file into the “TMP” folder you created with the same name, for example (cohdb.sql)
  1. Download the latest database schema definitions from the link below.
  2. You will need to choose a password for the database user. In these examples it will be "YOURL33TPASS!".
  3. Launch SQL Server Management Studio from the start menu
  4. Hit "Connect" on the screen that pops up, with default settings:
    SQL Connect.png
  5. We need to enable the sa login so that server can login to the database.
    1. If you look to the left panel you will see the object explorer and your connection. Right click it and select properties.
      SQL Properties.png
    2. When this window comes up hit Security to the left and enable "sql server and windows authentication". Then click ok.
      SQL Security.png
    3. In the same panel you used before navigate to Security -> Logins then right click and enter properties the sa user.
      SA Properties.png
    4. In this window set the password to the same password you set back at step 4
      Login Props.png
    5. Choose Status from the left panel in this same window and set login to enabled and hit ok.
      Login Status.png
    6. Right click the connection in the object explorer again and click Restart.
      SQL Restart.png
  6. Next we need to apply the schema for the databases which require this to be done manually (account, auction, auth, and chat)
    1. Click File -> Open -> File, navigate to the dbschemas that you downloaded at the start, and select cohauc.sql
      SSMS File Open.png
      SSMS Open DBSchema.png
    2. You will see a create database statement near the top of the file, with two lines that include a filename parameter.
      SSMS DBSchema SQL SRV STR.png
    3. Delete these lines, so that the statement is just:
      CREATE DATABASE [cohauc]
    4. Click the Execute button
      SSMS Execute.png
    5. Repeat these steps for cohacc.sql, cohauth.sql and cohchat.sql. Do not use cohdb.sql

Initial database entries

Each dbserver instance is a "shard". This needs to be manually added to authserver. In SQL Server Management Studio, expand "Databases", then right click on cohauth and select "New Query" from the menu. Several pieces of data are needed for this.

  • The IP address (ip) which clients will use to connect to your server. In this example, we will use 127.0.0.1
  • The source IP (inner_ip) from which dbserver will connect to authserver. In this example, we will use 127.0.0.1
  • The shard name (name) that you will use for dbserver. This will be Paragon by default. You can change it later once you have it working with the default name.
  • The auth shard number that you are using in turnstile_server.cfg. By default this is 1.

In the new query window, enter:

INSERT INTO cohauth.dbo.server (id, name, ip, inner_ip, ageLimit, pk_flag, server_group_id) VALUES (1, 'Paragon', '127.0.0.1', '127.0.0.1', 0, 0, 1);
INSERT INTO cohauth.dbo.worldstatus (idx, status) VALUES (1, 1);

Then press 'Execute'.

You will also want to create an account so that you can test connecting to the database. For now, use the instructions in I25_FAQ#How_do_I_create_an_account.3F

Server database connection configuration

Note: In order for the correct server name to appear when connecting to the server, browse to "C:\Ouroboros\etc" and edit the "config.txt" file. Find  "ProtocolVersion" and replace that line with "ProtocolVersion = 190516"

Navigate to C:\Ouroboros\data\server\db. In each of the following files, look for an SqlLogin line, and change the Pwd= value to your password. Using our example YOURL33TPASS!:

SqlLogin "DRIVER={SQL Server Native Client 11.0};Server=localhost\SQLEXPRESS;Uid=sa;Pwd=YOURL33TPASS!;"
  • account_server.cfg
  • auction_server.cfg
  • chat_server.cfg
  • servers.cfg

In servers.cfg, also fix SqlInit to be:

SqlInit "create database cohdb;"

For authserver, we have to configure the connection via ODBC data sources.

  1. Launch "ODBC Data Sources (32-bit)" from the start menu, or run directly from C:\Windows\SysWOW64\odbcad32.exe. (Do not use the 64-bit version)
  2. Click File DSN then click add to the right.
    ODBC File DSN.png
  3. Choose ODBC Driver 17 for SQL Server.
    ODBC Add Auth 1.png
  4. Click Next.
  5. Enter AuthDB into the box
    ODBC Add Auth 2.png
  6. Click Next, then Finish.
  7. One of the boxes on the next page will say "Which SQL Server do you want to connect to?". Type localhost\SQLEXPRESS
    ODBC Add Auth 3.png
  8. Click Next
  9. Choose "With SQL Server authentication using a login ID and password entered by the user". Enter "sa" for the username, and the password that you chose:
    ODBC Add Auth 4.png
  10. Click Next
  11. Enable "Change the default database to" and select "cohauth".
    ODBC Add Auth 5.png
  12. Click Next
  13. Default settings are fine on the last page
    ODBC Add Auth 6.png
  14. Click Finish
  15. A box will appear with the settings you have selected. Click "Test Data Source"
    ODBC Add Auth 7.png
  16. You should see "TESTS COMPLETED SUCCESSFULLY!" in the output. If not, go back and check your settings.
    ODBC Add Auth 8.png
  17. Click OK, then OK again.

Then we have to enter the username and password again into authserver itself. Start authserver.exe, and the first time that you run it, this window will appear. Enter "sa" and the password that you chose:

Authserver-login.PNG

This username and password is saved in the registry key HKEY_CURRENT_USER\Software\NCSoft\GLOBALAUTH

Configure firewall

If you are running Windows Firewall, you need to configure it to allow traffic through to your CoH server.

  1. Open the start menu, type firewall, and click on Windows Defender Firewall. (or get at it through Control Panel>System and Security>Windows Defender Firewall)
  2. Click on Advanced settings
  3. Click on Inbound Rules
  4. Click on New Rule...
  5. For Rule Type, select Port, and Next
  6. Select TCP, Specific local ports, Enter 2106, and then Next
  7. Allow the connection, Next
  8. Leave all the checkboxes selected, Next
  9. Name the rule CoH TCP, Finish
  10. Repeat the above steps to make a second new rule, but make it UDP instead of TCP, and for ports 7000-7200. Name it CoH UDP.

Launch server

The following server applications need to be manually started, in this order:

  1. authserver.exe
  2. dbserver.exe
  3. launcher.exe

The rest of the servers are started by loadBalanceShardSpecific.cfg.

Connecting a client

Launch the client by opening a command window, and typing:

cd C:\Ouroboros
Ouroboros -auth 127.0.0.1 -console

Login with the account you created, click on the Paragon shard, make a character and enter into the game. If all of that works correctly, then you can stop here if all you want is to play City of Heroes on your own machine by yourself. Otherwise, move on to Volume 2 Modifying Server For External Access.

Troubleshooting

  • ERROR: Failed to open attribute file vars.attribute for writing. You may get this error when running mapserver -productionmode -templates. If you are installing v2i1, this means you didn't create the C:\CoH_Data\attributes folder before running the command. If you are installing a later version than v2i1, it is likely trying to access C:\Ouroboros\data\server\db\templates instead. It is supposed to create that folder automatically if it doesn't exist. If you are getting this error message anyways, try manually creating the C:\Ouroboros\data\server\db\templates folder and then rerun mapserver -productionmode -templates.
  • ERROR: 'gzip' is not recognized as an internal or external command, operable program or batch file. If you get this message, it is usually accompanying a different error message. This happens because the server is trying to compress the dump files that it creates when some errors are found. You can safely ignore any messages about a missing gzip.exe, but if you would like to make these errors not happen any more you can place a gzip.exe and a zip.exe in any folder which is in your Path windows system environment variable. Look for a standard windows gzip.exe download, and you can also download info-zip and use the zip.exe which comes with it.
  • ERROR: Loading templates... If you get errors when you launch dbserver.exe when it tries to load templates, something went wrong with the steps involving running mapserver.exe -productionmode -templates in Setup server files, and it can't find the template files in C:\Ouroboros\data\server\db\templates.
  • ERROR: Version difference between client/server. This is a mismatch between the client version and the Version parameter in the C:\Ouroboros\version.ini file
  • ERROR: Can't connect to DBserver. Double-check your firewall settings. Try turning off Windows Firewall completely to see if that lets you connect. If so, then turn Windows Firewall back on and investigate your Inbound firewall rules for CoH.