Set Up Field Module on Server

Overview

The Field module needs to be set up on HTTP, UDP, and TCP servers.

By managing Field's memory data through the HTTP server and exposing built-in commands via UDP and TCP servers, you can make them available for use.

Setup

Add the following to the main function of the HTTP server.

package main

import "github.com/Diarkis/diarkis/diarkisexec"

func main() {
	logConfigPath := "/configs/shared/log.json"
	meshConfigPath := "/configs/shared/mesh.json"

	diarkisexec.SetupDiarkis(logConfigPath, meshConfigPath, &diarkisexec.Modules{
		Field: &diarkisexec.Options{ConfigPath: "/configs/shared/field.json", ExposeCommands: true},
	})

	diarkisexec.SetupDiarkisHTTPServer("/configs/http/main.json")
	diarkisexec.StartDiarkis()
}

To expose built-in commands to clients, you can set it up using the diarkisexec package.

Similarly, add it to the main function of the UDP and TCP servers. Below is a sample setup for a UDP server. The setup function of diarkisexec must be executed before calling diarkisexec.StartDiarkis().

For more details, please refer to the API Reference for diarkisexec.

package main

import "github.com/Diarkis/diarkis/diarkisexec"

func main() {
	logConfigPath := "/configs/shared/log.json"
	meshConfigPath := ""

	diarkisexec.SetupDiarkis(logConfigPath, meshConfigPath, &diarkisexec.Modules{
		Field: &diarkisexec.Options{ConfigPath: "/configs/shared/field.json", ExposeCommands: true},
	})
	diarkisexec.SetupDiarkisUDPServer("/configs/udp/main.json")
	diarkisexec.StartDiarkis()
}

It is recommended to first use the server template to easily launch the server. Diarkis Server Template

Last updated

Was this helpful?