Resonite Bot: Difference between revisions

Latest revision as of 09:38, 1 October 2024

The Resonite Bot is an automated user bearing the name "Resonite", located in your contacts menu. It is run by the Resonite Team and is used to deliver messages about important updates of Resonite, and to send commands to, to manage your account.

Resonite Bot Messages / Notifications

Common things Resonite Bot may message you about:

New Updates - If you're online when an update comes out, Resonite Bot will let you know with a message
Patreon Messages - If you're a Patron of Resonite on Patreon, each month you'll get messages thanking you for your pledge and sending you information on your rewards from Patreon.

Resonite Bot Commands

You can also message Resonite bot, with various phrases to achieve various actions and activities. To do this, find the "Resonite" user in your contacts screen and message them the command.

User Commands

Command	Example	Description
`/changeUsername <old username> <new username>`	`/changeUsername "Bad Name" "Good Name"`	Changes your displayed username. This will not change your User ID, and you must wait at least 7 days before you can use this command again after a name change.
`/setPrimaryEmail <email>`	`/setPrimaryEmail MyEmail@gmail.com`	Changes the primary email address associated with your account.
`/addAlternateEmail <email>`	`/addAlternateEmail MyOtherEmail@gmail.com`	Adds an additional email address to your account, typically used to assist in linking Patreon accounts.
`/requestAccountDeletion`	`/requestAccountDeletion`	Requests that your Resonite account be deleted. It will take 7 days for the deletion to complete and you will receive warnings to both your account and primary email that allow you to cancel the process.

Group Commands

Make sure to enclose names with quotation marks else the system won't recognize the names if it contains spaces in it. If you're the member of a Group, you can message the Resonite bot with the following commands to interact with the Groups System:

Command	Example	Description
`/createGroup <group name>`	`/createGroup The Cool Kids`	Creates a Group. This can be used by any user who has active benefit to create groups. Groups with spaces within their names, do not need to be surrounded in quotes for this command.
`/getGroupInfo <group name>`	`/getGroupInfo The Cool Kids` `/getGroupInfo G-The-Cool-Kids`	Gets a list of current members and other metadata, quotation marks are not required.
`/addMember <group name> <member name> <member quota>`	`/addMember "The Cool Kids" "Frooxius" 5` `/addMember G-The-Cool-Kids "Frooxius" 5`	Adds a User to a group, The quota parameter is measured in GB and allocates how much of the Group's storage they can use. Use `-1` for unlimited storage.
`/removeMember <group name> <member name>`	`/removeMember "The Cool Kids" "Frooxius"` `/removeMember G-The-Cool-Kids "Frooxius"`	Removes a User from a group.
`/setMemberQuota <group name> <member> <quota>`	`/setMemberQuota "The Cool Kids" "Frooxius" 5G`	Changes how much storage a group member is allowed to use.
`/getGroupSpace <group name>`	`/getGroupSpace "The Cool Kids"`	Shows how much storage the group is using.
`/shareStorageWithGroup <group> <amount>`	`/shareStorageWithGroup "The Cool Kids" 15GB`	Will share the specified storage with a group.
`/changeGroupName <group name> <new name>`	`/changeGroupName "The Cool Kids" "The Coolder Kids"`	Will change the name of the specified group to the new name.

Storage Commands

Command	Example	Description
`/requestRecordUsageJSON`	`/requestRecordUsageJSON`	Will email you a JSON File of all records on your account that are using storage. It will be emailed to your account's email address. This can be used with 3rd party tools to generate analysis of your storage usage IMPORTANT!!! Be very careful who you send this report to, as it contains nearly the entire contents of your account and inventory and has enough information to spawn anything from your account
`/requestRecordUsageReport`	`/requestRecordUsageReport`	Will email your account's specified email address with a basic storage report. This list includes all records (worlds, items...) on your account that use any storage, sorted by sum of the sizes of their assets This doesn't take into account assets that are shared across records. The raw sum of all records is very likely going to be much higher than your actual storage usage, because shared assets are only counted once Conversely if you delete a world/item, your storage won't necessarily go down by the amount reported, but only by how many unique assets it has. If the assets are used by other records, your storage won't go down by the full amount Additionally some assets are "free", like various assets from other users (e.g. some stuff you find in a public folder) and will be counted in the report, but doesn't actually contribute to your storage The report includes name, path, ID, record type (and whether it's message item) and public status of each record
`/deleteRecord <record ID>`	`/deleteRecord R-1234-ABC123`	Allows you to delete any record from your account by its Record ID. IMPORTANT! This command doesn't ask for confirmation, double check you've got the right Record ID as this action is irreversible You can use this to delete some message-item records for the time being. For inventory items and worlds I strongly recommend using in-game UI

(More storage commands are on the Patreon page)

Miscellaneous Commands

Command	Example	Description
`/echo <message>`	`/echo Mango`	The Resonite Bot will reply with the text you sent it.
`/serverInfo`	`/serverInfo`	Displays information about the server.
`/makebaby`	`/makebaby`	It's a secret.

Cloud Variables

Please see Cloud Variable Commands

Patreon Specific Commands

You can find the Patreon-specific commands for custom badges, headless server access, shareable storage and exit messages on the Patreon page.

Recovery Command

Command	Example	Description
`/requestDeleteRecovery <time period> <search name>`	`/requestDeleteRecovery 2d cheese`	Which will recover deleted items/worlds from your account. `time period` indicates how long ago in the history to search. Syntax is flexible, e.g. "1d", "2h", "30m", "1 hour 30 minutes" will all work. Default unit is day. `search name` will filter out any items that don't contain given term anywhere in their path or name. Use * to recover everything

Examples

Below are some examples of how to use the command:

/requestDeleteRecovery 1d Cool Hat - Will try to recover any item that contains the phrase "Cool Hat" in its name in the past 1 Day.
/requestDeleteRecovery 30m Cheese - Will try to recover any item that contains the phrase "Cheese" in its name for the past 30 minutes. SAVE THE CHEESE!
/requestDeleteRecovery 1 hour 30 minutes Four Lights - Will try to recover any item that contains the phrase "Four Lights" in its name for the past 1 hour and 30 minutes.
/requestDeleteRecovery 30m * - Will try recover ANY item from the past 30 minutes.

Warnings/Notes

Before using this command please read the following warnings/notes :

This command can only be used by Resonite Patreons
You will be emailed a ZIP file with special files representing items of your inventory in the same folder structure. To actually recover the item/world, you need to import those files into Resonite and save them again. DO NOT CLEAR YOUR CACHE!
Maximum recovery time period is 30 days, after this the items are deleted permanently
This command can only be used by Patreon users directly. If you have an emergency and are not Patreon, submit a Support Ticket.
THIS IS A LAST RESORT EMERGENCY OPTION! Full recovery isn't 100% guaranteed, it relies on other asset files still being in the cloud or being in your cache to recover fully. Please take every step necessary to make sure you don't need to use it in the first place.

Assignable Badges

There are a variety of badges that can be self-assigned by users. These include accessibility badges, and the potato badge. They can be assigned, and removed by messaging the Resonite bot in your contacts list. The commands are as follows:

/addHearingImpaired - Will assign the hearing impaired badge.
/removeHearingImpaired - Will remove the hearing impaired badge.
/addColorBlind - Will assign the color blind badge.
/removeColorBlind - Will remove the color blind badge.
/addVisuallyImpaired - Will assign the visually impaired badge.
/removeVisuallyImpaired - Will remove the visually impaired badge.
/addMute - Will assign the speech impaired badge.
/removeMute - Will remove the speech impaired badge.
/addPotato - Will assign the potato badge.
/removePotato - Will remove the potato badge.

Two-Factor Authentication (2FA)

2FA is a highly recommended measure to secure one's Resonite account, it can be setup through the "Setup 2FA" button on the home screen of the dashboard.

Also please note that once setup 2FA is still not active, you will need to enable it with the following command:

/enableLogin2FA - Opt-in to use of a 2FA code to login to your Resonite account (not necessary for subsequent sessions if 'remember me' is enabled.)
/disableLogin2FA - Opt-out of use of a 2FA code to login to your Resonite account.

@@ Line 1: / Line 1: @@
-<!--T:1-->
+The '''Resonite Bot''' is an automated user bearing the name "Resonite", located in your contacts menu. It is run by the [[Resonite Team]] and is used to deliver messages about important updates of Resonite, and to send commands to, to manage your account.
-When in Resonite, you may occasionally receive a message or notice from a user by the name of "Resonite". This user is actually a bot ran by the Resonite Team and provides notifications and messages about Resonite and your account.
-= Resonite Bot Messages / Notifications = <!--T:2-->
+== Resonite Bot Messages / Notifications ==
 Common things Resonite Bot may message you about:
 * New Updates - If you're online when an update comes out, Resonite Bot will let you know with a message
-* Patreon Messages - If you're a patron of Resonite on Patreon, each month you'll get messages thanking you for your pledge and sending you information on your rewards from Patreon.
+* Patreon Messages - If you're a Patron of Resonite on Patreon, each month you'll get messages thanking you for your pledge and sending you information on your rewards from Patreon.
-= Resonite Bot Commands = <!--T:3-->
+== Resonite Bot Commands ==
-<!--T:4-->
 You can also message Resonite bot, with various phrases to achieve various actions and activities. To do this, find the "Resonite" user in your contacts screen and message them the command.
-== User Commands ==
+=== User Commands ===
 {| class="wikitable"
 ! style="text-align:left;" | Command
@@ Line 35: / Line 33: @@
 |}
-== Group Commands == <!--T:5-->
+=== Group Commands ===
-Make sure to enclose names with <b>quotation marks</b> else the system won't recognize the names if it contains spaces in it.
+Make sure to enclose names with <b>quotation marks</b> else the system won't recognize the names if it contains spaces in it. If you're the member of a [[Group]], you can message the Resonite bot with the following commands to interact with the Groups System:
-If you're the member of a [[Group]], you can message the Resonite bot with the following commands to interact with the Groups System:
 {| class="wikitable"
 ! style="text-align:left;"| Command
@@ Line 44: / Line 41: @@
 |-
 | <code>/createGroup <group name></code>
-| <code>/createGroup "The Cool Kids"</code>
+| <code>/createGroup The Cool Kids</code>
-| Creates a Group. This can be used by any user who has active benefit to create groups.
+| Creates a Group. This can be used by any user who has active benefit to create groups. '''Groups with spaces within their names, do not need to be surrounded in quotes for this command.'''
 |-
 | <code>/getGroupInfo <group name></code>
 | <code>/getGroupInfo The Cool Kids</code><hr><code>/getGroupInfo G-The-Cool-Kids</code>
-| Gets a list of current members and other metadata
+| Gets a list of current members and other metadata, quotation marks are '''not required'''.
 |-
 | <code>/addMember <group name> <member name> <member quota></code>
@@ Line 66: / Line 63: @@
 | <code>/getGroupSpace "The Cool Kids"</code>
 | Shows how much storage the group is using.
+|-
+| <code>/shareStorageWithGroup <group> <amount></code>
+| <code>/shareStorageWithGroup "The Cool Kids" 15GB</code>
+| Will share the specified storage with a group.
+|-
+| <code>/changeGroupName <group name> <new name></code>
+| <code>/changeGroupName "The Cool Kids" "The Coolder Kids"
+| Will change the name of the specified group to the new name.
 |}
-== Storage Commands == <!--T:6-->
+=== Storage Commands ===
 {| class="wikitable"
 ! style="text-align:left;"| Command
@@ Line 76: / Line 81: @@
 | <code>/requestRecordUsageJSON</code>
 | <code>/requestRecordUsageJSON</code>
-| Will email you a JSON File of all records on your account that are using Storage. It will be emailed to your account's email address.
+| Will email you a JSON File of all records on your account that are using storage. It will be emailed to your account's email address.
 * This can be used with 3rd party tools to generate analysis of your storage usage
 * '''IMPORTANT!!!''' Be very careful who you send this report to, as it contains nearly the entire contents of your account and inventory and has enough information to spawn anything from your account
@@ Line 91: / Line 96: @@
 | <code>/deleteRecord <record ID></code>
 | <code>/deleteRecord R-1234-ABC123</code>
-| allows you to delete any record from your account by its Record ID
+| Allows you to delete any record from your account by its Record ID.
-* '''IMPORTANT!''' This command doesn't ask for confirmation, double check you've got the right Record ID as this action is irreversible.
+* '''IMPORTANT!''' This command doesn't ask for confirmation, double check you've got the right Record ID as this action is irreversible
 * You can use this to delete some message-item records for the time being. For inventory items and worlds I strongly recommend using in-game UI
 |}
+(More storage commands are on the [[Patreon]] page)
-== Misc Commands ==
+=== Miscellaneous Commands ===
 {| class="wikitable"
@@ Line 107: / Line 113: @@
 | <code>/serverInfo</code>
 | <code>/serverInfo</code>
-| Displays information about the server
+| Displays information about the server.
+|-
+| <code>/makebaby</code>
+| <code>/makebaby</code>
+| It's a secret.
 |}
-== Cloud Variables == <!--T:14-->
+=== Cloud Variables ===
-<!--T:15-->
 Please see [[Cloud_Variables#Cloud_Variable_Commands|Cloud Variable Commands]]
-== Patreon Specific Commands ==
+=== Patreon Specific Commands ===
-You can find the Patreon-specific commands on the [[Patreon]] page.
+You can find the Patreon-specific commands for custom badges, headless server access, shareable storage and exit messages on the [[Patreon]] page.
-== Recovery Command == <!--T:7-->
+=== Recovery Command ===
-<!--T:8-->
 {| class="wikitable"
 ! style="text-align:left;"| Command
@@ Line 134: / Line 142: @@
 |}
-=== Examples === <!--T:9-->
+==== Examples ====
 Below are some examples of how to use the command:
 * <code>/requestDeleteRecovery 1d Cool Hat</code> - Will try to recover any item that contains the phrase "Cool Hat" in its name in the past 1 Day.
@@ Line 141: / Line 149: @@
 * <code>/requestDeleteRecovery 30m *</code> - Will try recover '''ANY''' item from the past 30 minutes.
-=== Warnings/Notes === <!--T:10-->
+==== Warnings/Notes ====
 Before using this command please read the following warnings/notes :
 * '''This command can only be used by Resonite Patreons'''
@@ Line 149: / Line 157: @@
 * '''THIS IS A LAST RESORT EMERGENCY OPTION! Full recovery isn't 100% guaranteed''', it relies on other asset files still being in the cloud or being in your cache to recover fully. Please take every step necessary to make sure you don't need to use it in the first place.
-== Assignable Badges == <!--T:12-->
+=== Assignable Badges ===
-There are a variety of [[Badges]] that can be self-assigned by users. These include accessibility badges, and the potato badges. They can be assigned, and removed by messaging the Resonite bot in your contacts list. The commands are as follows:
+There are a variety of [[badges]] that can be self-assigned by users. These include accessibility badges, and the potato badge. They can be assigned, and removed by messaging the Resonite bot in your contacts list. The commands are as follows:
 * <code>/addHearingImpaired</code> - Will assign the hearing impaired badge.
 * <code>/removeHearingImpaired</code> - Will remove the hearing impaired badge.
@@ Line 162: / Line 170: @@
 * <code>/removePotato</code> - Will remove the potato badge.
-== Additional Patreon Commands == <!--T:12-->
+=== Two-Factor Authentication (2FA) ===
-If you are a Resonite Patreon supporter, you may have gained access to additional commands depending on your tier:
-* <code>/set2DBadge <badge url></code> - Set a custom 2D badge to go above your nametag in-game
-** The URL needs to be a resdb:/// or just the pure hash of the asset
-* <code>/set3Dbadge <record url></code> - Set a custom 3D badge to go above your nametag in-game
-** In order to use it, upload your 3D badge to your inventory and click "Get URL" to get its record URL.
-** The item will have basic validation applied to it and if it fails, it will provide reason on why it failed.
-** The item should have only 1 mesh renderer, 1 static mesh (up to 128 triangles or 256 vertices) and max 1 texture (this will be auto limited to 128 px).
-** Any components not on the whitelist will be cleared out. Only allowed components are: StaticTexture2D, StaticMesh, StaticShader, MeshRenderer, Spinner, Wiggler, Panner1D to Panner4D and Materials.
-* <code>/clear2Dbadge</code> - Clears your custom 2D badge
-* <code>/clear3Dbadge</code> - Clears your custom 3D badge
-* <code>/headlessCode</code> - Gets the code to the Headless Server beta branch on Steam
-== Two-Factor Authentication (2FA) == <!--T:16-->
 FA is a highly recommended measure to secure one's Resonite account, it can be setup through the "Setup 2FA" button on the home screen of the dashboard.
-<!--T:17-->
 Also please note that once setup 2FA is still not active, you will need to enable it with the following command:
 * <code>/enableLogin2FA</code> - Opt-in to use of a 2FA code to login to your Resonite account (not necessary for subsequent sessions if 'remember me' is enabled.)
 * <code>/disableLogin2FA</code> - Opt-out of use of a 2FA code to login to your Resonite account.