Setup

Setup

This Page will detail on how you can set up Server Eye.

Installing the Mod (Server-side)

1. Install Forge or NeoForge on your Server
2. Get the Mod from Modrinth and Github releases
3. Place the file into your mods folder
4. Start up your Server for the Config to be generated

Configuring the Server

You can find Server Eye's Config file under Files > config > server_eye.common.toml.

[server_eye]
	#Add modIds here to blacklist them. Players with these mods will be kicked.
	blacklistedMods = []
	#Add player names here to whitelist them. Whitelisted players will not be kicked, even if they have blacklisted mods.
	whitelistedPlayers = []
	#If enabled, Players with blacklisted mods will not be kicked, and it will only be logged to the Console.
	logOnly = false
	#How many seconds to wait for a player's mod list before kicking them. Set to 0 to disable this check.
	#Range: 0 ~ 300
	timeoutSeconds = 10

Blacklisting Mods

You can Blacklist Mods by adding there modId as a String into the blacklistedMods table, you can find an example below.

#Add modIds here to blacklist them. Players with these mods will be kicked.
blacklistedMods = ["freecam", "xray", "examplemod"]

Note

A modId is always lowercase

Getting a Mod's modId

There are a few ways to get a Mod's modId, one being the inbuild Mod Menu within Forge and NeoForge.

Using the inbuild Mod Menu

Whitelisting Players

You can Whitelist Players to be ignored by Server Eye's Mod list check by adding them to the whitelistedPlayers table. You can see an example on how to add Players below.

#Add player names here to whitelist them. Whitelisted players will not be kicked, even if they have blacklisted mods.
whitelistedPlayers = ["Player1", "Player2"]

Note

You can at this time only Whitelist Usernames

Timeout Seconds

The time (in seconds) before a Player is kicked from the Server for timing out. Setting the value to 0 will disable Timeout Checks.

#How many seconds to wait for a player's mod list before kicking them. Set to 0 to disable this check.
#Range: 0 ~ 300
timeoutSeconds = 10

Important

The timeout feature prevents Players using modified Server Eye Clients from not sending the Mod list to the Server. Only disable if it is causing problems

Log Only mode

Disables Players being kicked from the Server, instead only logging if the Player has Blacklisted Mods to the Console.

#If enabled, Players with blacklisted mods will not be kicked, and it will only be logged to the Console.
logOnly = false

Installing the Mod (Client-side)

1. Get the Mod from Modrinth and Github releases
2. Place the file into your mods folder