Dedicated Server Hosting Guide

Introduction

In this guide, we will walk you through a 5-step process to establish a dedicated server for New Citizen. We'll cover everything from the initial setup to having a functional server that you can join and oversee for your community. Initially, we'll provide an overview of the essential steps to get your server online. Subsequently, we'll delve into the specifics of server management, including editing player data, assigning administrative privileges to specific users, and exploring various configuration options.

For running a dedicated server, we recommend utilizing either a VPS or a dedicated server situated near your location. It's worth noting that our servers implement a ping limiter for in-game joinings.

(1) How to install the latest server files

To obtain the most recent server files for New Citizen, it's essential to possess a copy of the game on Steam. After acquiring the game, navigate to your Steam library. Search for New Citizen, ensuring that your Steam filter is set to display tools. Locate the Steam application named (New Citizen Dedicated Servers) and download it. Be sure to update all the files, similar to the process for updating any other game on Steam.

(2) How to update the latest server files

Similar to updating any game on Steam, you'll notice an update button when a game is outdated. For every essential update we release for New Citizen, the corresponding server files will be updated accordingly. It is the responsibility of the server owner to ensure they are using the latest server files to prevent potential bugs or complete malfunctions of the server.

(3) Database setup/install

To set up the MySQL server on your VPS, it's crucial to download and install both the MySQL Server and MySQL Workbench. Please use the following link for the download: https://dev.mysql.com/downloads/windows/installer/8.0.html.
During the installation process, ensure that you select both MySQL Server and MySQL Workbench, along with Connector/C++.

While installing MySQL Server, you'll be prompted to enter the user's name and password. The default user is 'root,' and the password set in the game is 'Aa123456.' Server settings can be configured in the ServerConfig.json file, located within the SpecPixel_RP folder.

As the game lacks the permission to create a database, it's necessary to manually create a database named "roleplay" (matching the name specified in the Server Config JSON file under the DBName field). To accomplish this in the Workbench, right-click on the Schemas panel, select "Create Schema," enter "roleplay" (not case-sensitive), click apply, and follow the wizard to complete the database creation process.

Upon uploading the server version to your VPS, generate a shortcut from the server executable file. Right-click on the shortcut and choose "Properties." In the target field, add two switches, namely -server and -log, to the end.

Initiating the server version of the game is straightforward using the shortcut, which seamlessly starts a Steam session. If you desire to customize the port, modify the shortcut by adding -port=XXXX to the end of the target field. For example, to designate port 18087, adjust the shortcut as follows: -server -log -port=18087.

(4) Server configuration

You are able to modify the server configuration file by directly accessing the serverconfig.json file located in the primary directory of the server files.

(5) Firewall (Important)

Setting up your server involves configuring specific ports to ensure smooth operation with Steam. Follow these steps to open the necessary ports on your router or firewall:

UDP Ports for Steam Operation:
Ensure the following UDP remote ports are open: 27015-27050. These ports are crucial for seamless communication with Steam.
‍
HTTP and HTTPS Ports for Steam Login and Content Download:
To log into Steam and download content, open the following ports:
- HTTP (TCP remote port 80)
- HTTPS (TCP remote port 443)
‍
Additional Rules for Specific Ports:
Add rules to grant access to the following ports for comprehensive functionality:
- Port 27015 (UDP and TCP)
- Port 7777 (UDP and TCP)

By configuring the firewall settings to allow traffic through these specified ports, you ensure that your server operates effectively with Steam.