Headless Client/Commands

From Neos Wiki
Jump to navigation Jump to search
Other languages:
English • ‎čeština • ‎日本語 • ‎한국어

The following commands are available on the headless client interface:

If you need to include spaces (e.g. for a username), wrap the argument in quotes. Example: acceptFriendRequest "Bob Jones"

Command Description Usage
saveConfig Saves the current settings into the original config file saveconfig <filename> (optional, will save in place without)
login Log into a Neos account login <username/email> <password>
logout Log out from the current Neos account logout
message Message user in friends list message <friend name> <message>
invite Invite a friend to the currently focused world invite <friend name>
friendRequests Lists all incoming friend requests friendRequests
acceptFriendRequest Accepts a friend request acceptfriendrequest <friend name>
worlds Lists all active worlds worlds
focus Focuses a specific world focus <world id>
startWorldURL Start a new world from Neos URL startworldurl <record URL>
startWorldTemplate Start a new world form template startworldtemplate <template name>
status Shows the status of the current world status
sessionURL Prints the Neos Url of the current session to the console sessionurl
sessionID Prints the ID of the current session to the console sessionid
copySessionURL Copies the Neos URL of the current session to the clipboard copysessionurl
copySessionID Copies the ID of the current session to the clipboard copysessionid
users Lists all the users in the currently focused world users
close Closes the currently focused world close
save Saves the currently focused world save
restart Restarts the currently focused world restart
kick Kicks a given user from the session kick <username>
silence Silences given user in the session silence <username>
unsilence Removes silence from given user in the session unsilence <username>
listbans Lists all active bans listbans
ban Bans a given user from all sessions hosted by this server ban <username>
unban Removes a ban for a specified user unban <username>
banByName Bans user with given Neos username from all sessions hosted by this server banbyname <Neos username>
unbanByName Unbans user with given Neos username from all sessions hosted by this server unbanbyname <Neos username>
banByID Bans user with given Neos User ID from all sessions hosted by this server banbyid <user ID>
unbanByID Unbans user with given Neos User ID from all sessions hosted by this server unbanbyid <user ID>
respawn Respawns a specified user respawn <username>
role Assigns a role to a specified user. Possible values: Admin, Builder, Moderator, Guest, Spectator role <username> <role>
name Sets a new world name for the currently focused world name <new name>
accessLevel Sets a new world access level for the currently focused world. Possible values: Private, LAN, Friends, FriendsOfFriends, RegisteredUsers, Anyone accesslevel <access level name>
description Sets a new world description for the currently focused world description <new description>
hideFromListing Sets whether the session should be hidden from listing or not hidefromlisting <true/false>
maxUsers Sets a user limit for the currently focused world maxusers <number of users>
awayKickInterval Sets the away kick interval for the currently focused world awaykickinterval <interval in minutes>
import Import an asset into the currently focused world import <file path or Neos URL>
importMinecraft Import a Minecraft world. Requires Mineways to be installed. importminecraft <folder containing Minecraft world with the level.dat file>
dynamicImpulse Sends a dynamic impulse with a given tag to the scene root dynamicimpulse <tag>
dynamicImpulseString Sends a dynamic impulse with given tag and string value to the scene root dynamicimpulsesstring <tag> <value>
dynamicImpulseInt Sends a dynamic impulse with given tag and integer value to the scene root dynamicimpulsesint <tag> <value>
dynamicImpulseFloat Sends a dynamic impulse with given tag and float value to the scene root dynamicimpulsefloat <tag> <value>
spawn Spawns a saved item from the inventory into the root spawn <neos url> <active state>
gc Forces full garbage collection gc
shutdown Shuts the headless client down (without saving world state) shutdown
tickRate Sets the maximum simulation rate for the server tickrate <ticks per second>
log Switches the interactive shell to logging output. Press Enter again to restore interactive console. log