Configuring

Server Configuration

The server configuration is generated upon the first start of Open Shen.

Settings

• debug.enableDebug: [false] - Enables debug mode.
• debug.debugLevel: [1] - The debug logging level.
• debug.useRawPackets: [false] - Uses raw packet responses ('.bin' files) instead of decoded packets ('.json' files).
• debug.logPackets: [false] - Saves a log of packets & their data to a file.
  • Requires debug.enableDebug to be enabled.
• server.udpPort: [22102] - This is the port the server will bind and listen on for UDP traffic.
• server.clientVersion: ["2.0"] - The Yuan Shen client version that the client is expected to be running.
  • This determines the packet IDs used by Open Shen.
• logger.ignoredPacketIds: [(blank array)] - A list of packet IDs that will be ignored when logging packets.
  • Requires debug.logPackets to be enabled.
• data.dataProvider: ["sqlite3"] - The data provider to use.
  • Data providers can be added by plugins.
  • The default data providers are: sqlite3, mysql, and mongo.
• providerCredentials: [{}] - This data is passed to the data provider when it is created.
  • Certain providers will require different values.
• version: [(current config version)] - The configuration version.
  • DO NOT change this, or your config will possibly reset.

Version Configuration

Version configurations contain critical data for Open Shen. If you can't find a value for the required field, ask in the Discord server.

Example Version File

{
  "versionInfo": "(information about the requested server region for the client)",
  "loginData": {
    "isUseAbilityHash": true
  },
  "packetIds": {
    "1": "PingRsp"
  }
}

Fields

• versionInfo: Sent in the /region HTTP response. Contains information about the "server region" for the client.
  • Contains data such as the server IP & port, and the client version data.
• loginData: Sent in the PlayerLoginRsp packet. Contains information about the required client version.
• packetIds: Used when receiving/sending packets. A mapping of protobuffer definitions to packet ID numbers.
  • These are version specific and are found in protobuffer definitions under CMD_ID.