It's not recommended to use this repo for production as this is designed to be used on STEMPlace infrastructure. Please refer to other projects to start another instance. Currently, there is no stable release, please do not use pre-releases for production.
Commands can be entered into the running instance through standard input.
exact |exact| (required description) [optional description] one-or-more... DEFAULT/possible/values {description}
| Command | Arguments | Description |
|---|---|---|
reload |
Reloads pxls.conf and roles.conf, applying most changes immediately. Also reloads the user and faction cache. |
|
save |
Saves the board. | |
alert |
[message] |
Alerts every user with the given message (or blank if left empty). |
cons |
[|authed|] |
Lists the total (or authenticated) connection count. |
users |
Lists all authenticated usernames. | |
broadcast |
(message) |
Sends the message in chat. |
cf |
(query) |
Runs the query through the chat filter. |
reloadusers |
Reloads the user manager. Laggy! | |
idlecheck |
Runs the user timeout check. | |
senduserdata |
Broadcasts the non-idle user count in chat. | |
addnotification |
(title) (expiry) (body) |
Adds a new notification to the notification panel with the body. +123 for the expiry means 123 seconds from now. |
bp |
(packet) |
Broadcasts a raw JSON packet to all connections. |
up |
(username) (packet) |
Broadcasts a raw JSON packet to all active connections from the user. |
f |
(faction ID) [delete/tag [new tag]/name [new name]] |
Prints information about the faction or changes the tag or name. |
| Command | Arguments | Description |
|---|---|---|
nuke |
(x1) (y1) (x2) (y2) (color) |
Replaces all pixels from (x1, y1) to (x2, y2) with the specified color index. |
replace |
(x1) (y1) (x2) (y2) (from color) (to color) |
Replaces all pixels from (x1, y1) to (x2, y2) matching the from color index with the to color index. |
| Command | Arguments | Description |
|---|---|---|
logins |
(username) [{service ID}:{service user ID} ...] |
Gets or sets the user's login method(s). |
addlogins |
(username) ({service ID}:{service user ID} ...) |
Adds login method(s) to the user. |
removelogins |
(username) ({service ID}:{service user ID} ...) |
Removes login method(s) from the user. |
roles |
(username) [role ID ...] |
Gets or sets the user's roles. |
addroles |
(username) (role ID ...) |
Adds role(s) to the user. |
removeroles |
(username) (role ID ...) |
Removes role(s) from the user. |
ban |
(username) [reason] |
Bans the user for 24 hours with the given reason. |
permaban |
(username) [reason] |
Permanently bans the user with the given reason. |
shadowban |
(username) [reason] |
Shadowbans the user (making new pixels local) with the given reason. |
unban |
(username) [{revert} TRUE/false] [reason] |
Unbans the user, reverting their pixels and with the given reason. |
stack |
(user) [|set| (amount)] |
Gets or sets the user's stacked pixels. User must not be on cooldown before setting. |
placementOverride |
|list|/(user) [placeAnyColor/ignoreCooldown/ignorePlacemap] [on/off] |
Lists all placement overrides or turns a placement override on/off for the user. |
captchaOverride |
|list|/(user) [on/off] |
Lists all captcha overrides or turns it on/off for the user. |
chatban |
(username) (length) ({purge} true/false) (reason) |
Bans the user from chat for the length in seconds, optionally purging all of their messages, with the given reason. |
permachatban |
(username) ({purge} true/false) (reason) |
Permanently bans the user from chat optionally purging all of their messages, with the given reason. |
unchatban |
(username) |
Unbans the user from chat. |
chatpurge |
(username) [amount] [reason] |
Purges up to amount chat messages from the user for the given reason. |
flagrename |
(username) [{flag} TRUE/false] |
Flags or unflags the user for rename. |
setname|updateusername |
(username) (new username) |
Renames the user. |
- This project includes icons from Font Awesome Free 5.9.0 by fontawesome - https://fontawesome.com
- License: https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License)