palwrldcmdsgo

package module
v1.1.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2025 License: MIT Imports: 2 Imported by: 0

README

Dedicated Source RCON API Wrapper for Palworld

The Source RCON Protocol from SteamCMD allows the moderation of a server without requiring an admin to log onto Palworld. The commands below mimic the commands entered into the in-game chatbox. RCON must be enabled for the server.

Getting Started

Install
Usage

In main.go:

package main

import (
	"log"

	"github.com/JengaMasterG/palwrldcmdsgo"
)

var IPAddress, password = "IPAddress", "password"

func main() {
	response, err := palwrldcmdsgo.Test(IPAddress, password)
	if err != nil {
		log.Printf(`WARN: %v`, err)
		log.Print("FATAL: Palworld connection failed!")
	} else {
		log.Print(`INFO: Palworld connection test successful!`)
		log.Print(`INFO: `, response)
	}
}

Before Executing:

  • Replace Public_IP:Port with the server's public IP address and RCON port.
  • Replace AdminPassword with the server's Admin Password.

Running the main.go with go run . will run the Test function to see if the server is running.

Helpful Resources

Palworld Tech Guide

Palworld Commands

Documentation

Overview

RCON commands used for Palworld. The Source RCON Protocol from SteamCMD allows the moderation of a server without

requiring an admin to log onto Palworld. The commands below mimic the commands entered into the in-game chatbox.
RCON must be enabled for the server. Replace "Public_IP:Port" with the server's public IP address and RCON port
and "AdminPassword" with the server's Admin Password before executing.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BanPlayer

func BanPlayer(IPAddress string, password string, steamID string) (string, error)

func Broadcast

func Broadcast(IPAddress string, password string, message string) error

func DoExit

func DoExit(IPAddress string, password string) (string, error)

func Info

func Info(IPAddress string, password string) (string, error)

func KickPlayer

func KickPlayer(IPAddress string, password string, steamID string) (string, error)

func Save

func Save(IPAddress string, password string) (string, error)

func ShowPlayers

func ShowPlayers(IPAddress string, password string) (string, error)

func Shutdown

func Shutdown(IPAddress string, password string, seconds string, message string) (string, error)

func Test

func Test(IPAddress string, password string) (string, error)

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL