Getting started with Vintage Story

This guide helps you set up your Vintage Story server on ServerPrism. It covers everything from ordering your server to configuring it and inviting players.

Ordering on ServerPrism

1. Select a plan: Vintage Story servers typically need 2 GB RAM for a small group of players. For larger worlds or more concurrent players, consider 4 GB or 8 GB RAM.
2. Choose a region: Select the data center closest to you and your players for the best performance.
3. Deploy: Once your order is complete, ServerPrism automatically deploys your server with the latest Vintage Story runtime.

First boot

After deployment, your server will start automatically. The first boot can take a few minutes as the server generates the world and necessary configuration files. You can monitor its progress using the Console in your ServerPrism panel (https://serverprism.com/dashboard).

The server is ready when you see messages indicating successful world generation and that it's listening for connections, often ending with a line like Server is listening on port: [your_port].

Connecting / inviting players

Players connect to your Vintage Story server using its IP address and port. You can find these details on the Overview page of your server in the ServerPrism panel.

1. Launch Vintage Story: Open the game on your computer.
2. Multiplayer: From the main menu, click on Multiplayer.
3. Direct Connect: Click on Direct Connect.
4. Enter Server Address: Input your server's IP address followed by a colon and the port number (e.g., 192.0.2.1:42420).
5. Connect: Click Connect to join your server.

Note: You can also set up a free subdomain for your server from your ServerPrism customer dashboard, making it easier for players to remember the address.

Configuration basics

Most server settings are managed through serverconfig.json and worldconfig.json. You can access and edit these files using the File Manager in your ServerPrism panel.

1. Navigate to the serverdata folder: This folder contains your server's configuration files.
2. Edit serverconfig.json: This file controls general server settings. Key settings you might want to change include:
   • ServerName: The name displayed in the server list.
   • MaxClients: The maximum number of players allowed on your server.
   • Password: Set a password for your server if you want it to be private. Leave blank for no password.
   • WelcomeMessage: A message displayed to players when they join.
3. Edit worldconfig.json: This file contains world-specific settings, such as:
   • Seed: The seed used for world generation.
   • SpawnPosition: The starting coordinates for new players.
   • GameMode: Change between Survival, Creative, or Spectator.

After making changes, save the files and restart your server from the ServerPrism panel for the changes to take effect.

Common issues

• Players cannot connect:
  • Ensure the server is running and not in a 'Stopped' state in the ServerPrism panel.
  • Double-check the IP address and port entered by players. Make sure there are no typos.
  • Verify that your server isn't password-protected if players are not entering one.
• Server not starting:
  • Check the Console for error messages. Common issues include corrupted configuration files or insufficient RAM for the world size. If you see OutOfMemoryException, consider upgrading your plan from the ServerPrism dashboard.
  • If the issue persists, submit a support ticket at https://serverprism.com/tickets with your server ID and any relevant console logs.
• Changes to serverconfig.json not applying:
  • Always restart your server after editing configuration files. Simply saving the file is not enough.
  • Ensure you saved the file correctly in the File Manager.

Next steps

• Modding: Vintage Story has a vibrant modding community. You can manually upload mods to your server's Mods folder using SFTP or the File Manager. Always ensure client-side mods are also installed by players if required.
• Backups: Regularly back up your server's world data from the ServerPrism panel to prevent data loss.
• Support: If you encounter persistent issues or need assistance, contact ServerPrism support through a ticket at https://serverprism.com/tickets. Please include your server ID and a detailed description of the problem.