terraria-server

Installation

Please make sure you have Python and Visual Studio with C++ development

If you want to use a custom server :

1. Download a Terraria server (Server for Terraria)
2. Extract the zip
3. Go to the only folder
4. Take the content of Windows and drop it into a folder in your project

Class: TerrariaServer

TerrariaServer is a class that manages the terraria server itself, captures the process STDOUT

import { TerrariaServer } from 'terraria-server';

// Or

const { TerrariaServer } = require('terraria-server')

Config: Config

// Without custom server
const server = new TerrariaServer({
    version: "1.4.4.9",
    worldId: 1,
    maxPlayers: 16,
    port: 7777,
    autoForwardPort: true,
    password: "",
    motd: ""
})

await server.download()

server.start()

server.on('start', () => console.log('Server Started'))

// With custom server
const server = new TerrariaServer({
    path: "./server",
    file: "start-server.bat",
    worldId: 1,
    maxPlayers: 16,
    port: 7777,
    autoForwardPort: true,
    password: "",
    motd: ""
})

server.start()

server.on('start', () => console.log('Server Started'))

Methods

server.download(): Promise<void>

server.start(): Promise<void>

server.stop(): Promise<void>

server.restart(): Promise<void>

server.command(command: string): Promise<string>

server.say(message: string): void

Events

server.on('start', () => void)

server.on('stop', () => void)

server.on('message', (message: string, player: string) => void)

server.on('console', (data: string) => void)

server.on('join', (player: string) => void)

server.on('leave', (player: string) => void)

Properties

server.config: Config

server.ready: boolean

server.readyTimestamp: number | null

server.uptime: number | null

server.players: Promise<Player[]>

Interface: Config

The config object is used to configure the Terraria server

const config = {
    version: TerrariaVersion,
    path: string,
    file: string,
    worldId: number,
    maxPlayers: number,
    port: number,
    autoForwardPort: boolean,
    password: string,
    motd: string
}

new TerrariaServer(config)