Skip to main content

Admin Manager

The admin manager is used for managing the admin accounts of the server.


List Admin Groups

await RCONClientV1.admins.listAdminGroups();

Returns

List<string>


List Admins

await RCONClientV1.admins.list();

Returns

Array<{ playerId: string, group: string, comment: string }>


Add Admin

await RCONCLientV1.admins.add(playerId, group, comment);

Parameters

NameDescriptionTypeRequired
playerIdThe admin's player ID.stringTrue
groupThe group to add the admin to. Retrieved from listAdminGroupsstringTrue
commentThe comment/nickname for the admin.stringFalse

Returns

Promise<"SUCCESS" | "FAIL">


Remove Admin

await RCONCLientV1.admins.remove(playerId);

Parameters

NameDescriptionTypeRequired
playerIdThe admin's player ID.stringTrue

Returns

Promise<"SUCCESS" | "FAIL">