Difference between revisions of "Neos Bot"

From Neos Wiki
Jump to navigation Jump to search
(Added 2FA.)
(Corrected the "getGroupInfo" example since friendly names do not need quotes (usings quotes for this will actually prevent the command from working). Added examples that include the Group ID.)
 
(14 intermediate revisions by 5 users not shown)
Line 16: Line 16:
  
 
=== Group Commands === <!--T:5-->
 
=== Group Commands === <!--T:5-->
 +
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 Neos bot with the following commands to interact with the Groups System:
 
If you're the member of a [[Group]], you can message the Neos bot with the following commands to interact with the Groups System:
−
* <code>/getGroupInfo <groupname></code> - Gets a list of current members and other metadata
+
{| class="wikitable"
−
* <code>/addMember <group name> <member name> <member quota></code> - 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.
+
! style="text-align:left;"| Command
−
* <code>/removeMember <group name> <member name></code> - Removes a User from a group.
+
! Example
 +
! Description
 +
|-
 +
| <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
 +
|-
 +
| <code>/addMember <group name> <member name> <member quota></code>  
 +
| <code>/addMember "The Cool Kids" "Frooxius" 5</code><hr><code>/addMember G-The-Cool-Kids "Frooxius" 5</code>
 +
| 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 <code>-1</code> for unlimited storage.
 +
|-
 +
| <code>/removeMember <group name> <member name></code>
 +
| <code>/removeMember "The Cool Kids" "Frooxius"</code><hr><code>/removeMember G-The-Cool-Kids "Frooxius"</code>
 +
| Removes a User from a group.
 +
|}
  
 
=== Priority Issue voting for Patreon Supporters === <!--T:11-->
 
=== Priority Issue voting for Patreon Supporters === <!--T:11-->
−
* <code>/priorityIssue <issue number></code> - Patreon supporters can vote to show that a specific GitHub issue is a priority for them.
+
{| class="wikitable"
−
** <issue number> is GitHub issue number.
+
! style="text-align:left;"| Command
−
** The command will echo back the title of the issue on success
+
! Example
−
** You can only have 1 priority issue at the time. You can change your vote at any time
+
! Description
−
** Current votes can be seen at https://www.neosvr-api.com/api/stats/priorityIssues, with vote count for each and vote points (points are proportional to level of support on Patreon, updated automatically)
+
|-
−
** Note that the priority issue list is updated asynchronously and can take a few minutes to reflect your vote in some cases
+
| <code>/priorityIssue <issue number></code>  
 +
| <code>/priorityIssue 1337</code>
 +
| Patreon supporters can vote to show that a specific GitHub issue is a priority for them.
 +
* <issue number> is GitHub issue number.
 +
* The command will echo back the title of the issue on success
 +
* You can only have 1 priority issue at the time. You can change your vote at any time
 +
* Current votes can be seen at https://www.neosvr-api.com/api/stats/priorityIssues, with vote count for each and vote points (points are proportional to level of support on Patreon, updated automatically)
 +
* Note that the priority issue list is updated asynchronously and can take a few minutes to reflect your vote in some cases
 +
|}
  
 
=== Storage Commands === <!--T:6-->
 
=== Storage Commands === <!--T:6-->
−
* <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.
+
{| class="wikitable"
−
** This can be used with 3rd party tools to generate analysis of your Neos storage usage
+
! style="text-align:left;"| Command
−
** '''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
+
! Example
−
* <code>/requestRecordUsageReport</code> - Will email your account's specified email address with a basic storage report.
+
! Description
−
** 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
+
| <code>/requestRecordUsageJSON</code>
−
** 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
+
| <code>/requestRecordUsageJSON</code>
−
** Additionally some assets are "free", like various Neos assets (e.g. some stuff you find in public Neos inventory) and will be counted in the report, but doesn't actually contribute to your storage
+
| 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.
−
** The report includes name, path, ID, record type (and whether it's message item) and public status of each record
+
* This can be used with 3rd party tools to generate analysis of your Neos storage usage
−
* <code>/deleteRecord <record ID></code> allows you to delete any record from your account by its Record ID
+
* '''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
−
** '''IMPORTANT!''' It doesn't ask for confirmation, double check you've got the right Record ID as this action is mostly 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
+
| <code>/requestRecordUsageReport</code>
 +
| <code>/requestRecordUsageReport</code>
 +
| 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 Neos assets (e.g. some stuff you find in public Neos inventory) 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
 +
|-
 +
| <code>/deleteRecord <record ID></code>  
 +
| <code>/deleteRecord R-1234-ABC123</code>
 +
| 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
 +
|}
  
 
=== Cloud Variables === <!--T:14-->
 
=== Cloud Variables === <!--T:14-->
  
 
<!--T:15-->
 
<!--T:15-->
−
Main article: [[Cloud Variables#List of Commands for Cloud Variables|Cloud Variables]]
+
Please see [[Cloud_Variables#Cloud_Variable_Commands|Cloud Variable Commands]]
  
 
=== Recovery Command === <!--T:7-->
 
=== Recovery Command === <!--T:7-->
  
 
<!--T:8-->
 
<!--T:8-->
−
* <code>/requestDeleteRecovery <nowiki><time period></nowiki> <search name> </code> - Which will recover deleted items/worlds from your account.
+
{| class="wikitable"
−
** <code>time period</code> 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.
+
! style="text-align:left;"| Command
−
** <code>search name</code> will filter out any items that don't contain given term anywhere in their path or name. Use * to recover everything
+
! Example
 +
! Description
 +
|-
 +
| <code>/requestDeleteRecovery <nowiki><time period></nowiki> <search name> </code>
 +
| <code>/requestDeleteRecovery 2d cheese </code>
 +
| Which will recover deleted items/worlds from your account.
 +
* <code>time period</code> 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.
 +
* <code>search name</code> will filter out any items that don't contain given term anywhere in their path or name. Use * to recover everything
 +
|}
  
 
==== Examples ==== <!--T:9-->
 
==== Examples ==== <!--T:9-->
Line 68: Line 113:
 
* Maximum recovery time period is 30 days, after this the items are deleted permanently
 
* 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, contact a team member
 
* This command can only be used by Patreon users directly. If you have an emergency and are not Patreon, contact a team member
−
* '''THIS IS 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.
+
* '''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 === <!--T:12-->
Line 84: Line 129:
  
 
=== NCR/Tokens === <!--T:13-->
 
=== NCR/Tokens === <!--T:13-->
−
* <code>/requestTransactionHistory <token></code> - Generates and sends your complete transaction history for the given token to your email.
+
* <code>/requestTransactionHistory <token></code> - Generates and sends your complete transaction history for the given token to your email. Replace <token> with KFC or NCR.
 
* <code>/KFCoptOut</code> - Opts out of receiving KFC.
 
* <code>/KFCoptOut</code> - Opts out of receiving KFC.
 
* <code>/KFCoptIn</code> - Opt in to receiving KFC. (All accounts are opted in to the reception of KFC by default. This command is only necessary if <code>/KFCoptOut</code> has previously been sent to the Neos bot on the account.)
 
* <code>/KFCoptIn</code> - Opt in to receiving KFC. (All accounts are opted in to the reception of KFC by default. This command is only necessary if <code>/KFCoptOut</code> has previously been sent to the Neos bot on the account.)
 +
* <code>/NCRoptOut</code> - Opts out of receiving NCR.
 +
* <code>/NCRoptIn</code> - Opt in to receiving NCR. (All accounts are opted in to the reception of NCR by default. This command is only necessary if <code>/NCRoptOut</code> has previously been sent to the Neos bot on the account.)
  
−
=== Two-Factor Authentication (2FA) ===
+
=== Two-Factor Authentication (2FA) === <!--T:16-->
−
2FA is a highly recommended measure to secure one's Neos account, it can be setup through the `Setup 2FA` button on the home screen of the dashboard.
+
2FA is a highly recommended measure to secure one's Neos account, it can be setup through the "Setup 2FA" button on the home screen of the dashboard.
 +
 
 +
<!--T:17-->
 +
Also please note that 2FA by default <b>only covers transactions</b>. It is highly recommended to extend this to your Neos Login with the following command:
 
* <code>/enableLogin2FA</code> - Opt-in to use of a 2FA code to login to your Neos account (not necessary for subsequent sessions if 'remember me' is enabled.)
 
* <code>/enableLogin2FA</code> - Opt-in to use of a 2FA code to login to your Neos 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 Neos account.
 
* <code>/disableLogin2FA</code> - Opt-out of use of a 2FA code to login to your Neos account.
−
* <code>/webLogin</code> - If login 2FA is enabled on your account, this will temporarily suppress it for three minutes. Used while logging on to the Wiki, and other Neos sites currently not supporting 2FA login.
+
* <code>/webLogin</code> - If 2FA Login is enabled on your account, this will temporarily suppress it for three minutes. Used while logging on to the Wiki, and other Neos sites currently not supporting 2FA Login.
 +
 
 +
=== Delete Account === <!--T:18-->
 +
You may also use the Neos Bot to delete your Neos account. Simply send Neos Bot <code>/requestAccountDeletion</code> in a message and the deletion process will start. It will take 7 days and there are warnings sent to both your account and the email registered to your account that allow you to cancel.
 
</translate>
 
</translate>

Latest revision as of 06:11, 10 February 2023

Other languages:
English • ‎čeština • ‎中文（中国大陆）‎ • ‎日本語 • ‎한국어

When in Neos, you may occasionally receive a message or notice from a user by the name of "Neos". This user is actually a bot ran by the Neos Team and provides notifications and messages about Neos and your account.

Neos Bot Messages / Notifications

Common things Neos Bot may message you about:

  • New Updates - If you're online when an update comes out, Neos Bot will let you know with a message
  • Patreon Messages - If you're a patron of Neos on Patreon, each month you'll get messages thanking you for your pledge and sending you your NCR from Patreon.
  • Special Currency Transfers - If you're the winner of a competition such as the MMC, NCC or otherwise you may get a message from Neos bot which is the transfer of the winning funds.

Neos Bot Commands

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

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 Neos bot with the following commands to interact with the Groups System:

Command Example Description
/getGroupInfo <group name> /getGroupInfo The Cool Kids
/getGroupInfo G-The-Cool-Kids 		Gets a list of current members and other metadata
/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.

Priority Issue voting for Patreon Supporters

Command Example Description
/priorityIssue <issue number> /priorityIssue 1337 Patreon supporters can vote to show that a specific GitHub issue is a priority for them.
  • <issue number> is GitHub issue number.
  • The command will echo back the title of the issue on success
  • You can only have 1 priority issue at the time. You can change your vote at any time
  • Current votes can be seen at https://www.neosvr-api.com/api/stats/priorityIssues, with vote count for each and vote points (points are proportional to level of support on Patreon, updated automatically)
  • Note that the priority issue list is updated asynchronously and can take a few minutes to reflect your vote in some cases

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 Neos 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 Neos assets (e.g. some stuff you find in public Neos inventory) 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

Cloud Variables

Please see Cloud Variable Commands

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 Neos 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 Neos 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, contact a team member
  • 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 badges. They can be assigned, and removed by messaging the Neos 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.

NCR/Tokens

  • /requestTransactionHistory <token> - Generates and sends your complete transaction history for the given token to your email. Replace <token> with KFC or NCR.
  • /KFCoptOut - Opts out of receiving KFC.
  • /KFCoptIn - Opt in to receiving KFC. (All accounts are opted in to the reception of KFC by default. This command is only necessary if /KFCoptOut has previously been sent to the Neos bot on the account.)
  • /NCRoptOut - Opts out of receiving NCR.
  • /NCRoptIn - Opt in to receiving NCR. (All accounts are opted in to the reception of NCR by default. This command is only necessary if /NCRoptOut has previously been sent to the Neos bot on the account.)

Two-Factor Authentication (2FA)

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

Also please note that 2FA by default only covers transactions. It is highly recommended to extend this to your Neos Login with the following command:

  • /enableLogin2FA - Opt-in to use of a 2FA code to login to your Neos account (not necessary for subsequent sessions if 'remember me' is enabled.)
  • /disableLogin2FA - Opt-out of use of a 2FA code to login to your Neos account.
  • /webLogin - If 2FA Login is enabled on your account, this will temporarily suppress it for three minutes. Used while logging on to the Wiki, and other Neos sites currently not supporting 2FA Login.

Delete Account

You may also use the Neos Bot to delete your Neos account. Simply send Neos Bot /requestAccountDeletion in a message and the deletion process will start. It will take 7 days and there are warnings sent to both your account and the email registered to your account that allow you to cancel.

Retrieved from "https://wiki.neosvr.com/index.php?title=Neos_Bot&oldid=64722"