cleanup + redo headings |
Remove all anchors |
||
| Line 1: | Line 1: | ||
== General Questions == | == General Questions == | ||
=== What platforms and hardware does Resonite support? === | === What platforms and hardware does Resonite support? === | ||
| Line 11: | Line 9: | ||
If you are a hardware developer, and wish to send a Dev Kit for integration into Resonite, please create a [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/new?assignees=shiftyscales&labels=enhancement&projects=&template=feature-request.yml Feature Request] or send a [https://yellowdogman.com/contact.html contact form] on our website with your request. | If you are a hardware developer, and wish to send a Dev Kit for integration into Resonite, please create a [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/new?assignees=shiftyscales&labels=enhancement&projects=&template=feature-request.yml Feature Request] or send a [https://yellowdogman.com/contact.html contact form] on our website with your request. | ||
=== What are Resonite’s hardware requirements? === | === What are Resonite’s hardware requirements? === | ||
| Line 18: | Line 15: | ||
It is recommended to have a VR-capable card from either Nvidia (GTX 1060) or AMD (RX 570) although stronger GPUs have a high benefit for VR use by increasing resolution, and framerate. | It is recommended to have a VR-capable card from either Nvidia (GTX 1060) or AMD (RX 570) although stronger GPUs have a high benefit for VR use by increasing resolution, and framerate. | ||
=== Can I put Resonite in a window? === | === Can I put Resonite in a window? === | ||
| Line 25: | Line 21: | ||
E.g. <code>-screen-fullscreen 0 -screen-width 1280 -screen-height 720</code> will place Resonite in a 1280x720 window at launch. | E.g. <code>-screen-fullscreen 0 -screen-width 1280 -screen-height 720</code> will place Resonite in a 1280x720 window at launch. | ||
=== Can I play Resonite on the desktop? === | === Can I play Resonite on the desktop? === | ||
| Line 32: | Line 27: | ||
The screen mode is under active development, and additional functionality is still to be developed. | The screen mode is under active development, and additional functionality is still to be developed. | ||
=== Can I play with a controller? === | === Can I play with a controller? === | ||
Resonite currently offers preliminary support for gamepads, e.g. basic functionality such as moving, turning, jumping, and using the context menu. Additional support will be added later. | Resonite currently offers preliminary support for gamepads, e.g. basic functionality such as moving, turning, jumping, and using the context menu. Additional support will be added later. | ||
=== Is Resonite open source? === | === Is Resonite open source? === | ||
Currently, most of Resonite is not open source. Resonite is currently being developed by a small team and it is uncertain what the implications of open sourcing right now would be. | Currently, most of Resonite is not open source. Resonite is currently being developed by a small team and it is uncertain what the implications of open sourcing right now would be. | ||
=== Does Resonite support modded clients? === | === Does Resonite support modded clients? === | ||
Please see our [[Mod & Plugin Policy]]. | Please see our [[Mod & Plugin Policy]]. | ||
=== Is Resonite running on Unity? === | === Is Resonite running on Unity? === | ||
| Line 53: | Line 44: | ||
Unity is used primarily for its renderer, the runtime environment (Mono/.NET), and interfacing with the audio system. | Unity is used primarily for its renderer, the runtime environment (Mono/.NET), and interfacing with the audio system. | ||
=== What are the rules in Resonite? === | === What are the rules in Resonite? === | ||
Be excellent to each other. Details can be found in our [[Guidelines]] page. | Be excellent to each other. Details can be found in our [[Guidelines]] page. | ||
=== How can I report a user? === | === How can I report a user? === | ||
| Line 63: | Line 52: | ||
Where possible, it is preferable that users resolve their own conflicts by use of the tools they have available to them in the form of the permissions system, muting, etc. You can read more on our [[Moderation]] page. | Where possible, it is preferable that users resolve their own conflicts by use of the tools they have available to them in the form of the permissions system, muting, etc. You can read more on our [[Moderation]] page. | ||
=== How can I protect myself from malicious users? === | === How can I protect myself from malicious users? === | ||
| Line 70: | Line 58: | ||
Users that host sessions from these worlds are able to assign permission levels separately for each user in a session. | Users that host sessions from these worlds are able to assign permission levels separately for each user in a session. | ||
=== How can I identify Resonite Team members, and moderators? === | === How can I identify Resonite Team members, and moderators? === | ||
| Line 79: | Line 66: | ||
You can verify these badges through the session menu as they will be displayed alongside their names there as well. | You can verify these badges through the session menu as they will be displayed alongside their names there as well. | ||
== Beginner Questions == | == Beginner Questions == | ||
=== Are there any tutorials on how to use Resonite? === | === Are there any tutorials on how to use Resonite? === | ||
| Line 88: | Line 73: | ||
Our users are also very welcoming, and helpful, and often willing to lend a hand to each other either in Resonite, or on Discord. | Our users are also very welcoming, and helpful, and often willing to lend a hand to each other either in Resonite, or on Discord. | ||
=== What are the basic controls in Resonite? === | === What are the basic controls in Resonite? === | ||
| Line 95: | Line 79: | ||
The context menu button is used to access context-sensitive actions, and other controls such as undo/redo, and your locomotion modes (these will be moved in a later UI update). Additional controls including screen mode controls can be found on our [[Basic Controls]] page. | The context menu button is used to access context-sensitive actions, and other controls such as undo/redo, and your locomotion modes (these will be moved in a later UI update). Additional controls including screen mode controls can be found on our [[Basic Controls]] page. | ||
=== Where can I find an avatar to use? === | === Where can I find an avatar to use? === | ||
| Line 101: | Line 84: | ||
You can also use the avatar creator to turn any object into an avatar, including rigged avatar models you import. | You can also use the avatar creator to turn any object into an avatar, including rigged avatar models you import. | ||
=== How can I equip an avatar? === | === How can I equip an avatar? === | ||
Avatars from your inventory you can quick-equip by selecting them once to highlight them, and then pressing the yellow lightning bolt. Avatars placed in the world can be equipped by clicking on them. | Avatars from your inventory you can quick-equip by selecting them once to highlight them, and then pressing the yellow lightning bolt. Avatars placed in the world can be equipped by clicking on them. | ||
=== Where can I find other users? === | === Where can I find other users? === | ||
Active sessions will be listed at the top of the worlds list under the “Worlds” tab of your dashboard. You can filter the listing to include only sessions with active users by using the “Active Sessions” search preset. | Active sessions will be listed at the top of the worlds list under the “Worlds” tab of your dashboard. You can filter the listing to include only sessions with active users by using the “Active Sessions” search preset. | ||
=== Can I explore other worlds? === | === Can I explore other worlds? === | ||
| Line 117: | Line 97: | ||
You can also search for specific tags in the search bar at the top, in addition to the numerous search presets for themed worlds, e.g. games, educational content, social hangouts, and more. | You can also search for specific tags in the search bar at the top, in addition to the numerous search presets for themed worlds, e.g. games, educational content, social hangouts, and more. | ||
=== How can I invite friends to my session? === | === How can I invite friends to my session? === | ||
From the Contacts button on your Dash Menu, select the friend in your list you wish to invite, then press Invite Here. | From the Contacts button on your Dash Menu, select the friend in your list you wish to invite, then press Invite Here. | ||
=== How can I adjust the visibility of my session/how can I host a private session? === | === How can I adjust the visibility of my session/how can I host a private session? === | ||
| Line 127: | Line 105: | ||
While your status is set to Invisible, all sessions you create will be set to private by default. | While your status is set to Invisible, all sessions you create will be set to private by default. | ||
=== How do I navigate between sessions? === | === How do I navigate between sessions? === | ||
| Line 133: | Line 110: | ||
To close an active session, you can press the ‘X’ button at the top right corner of the session, and press close, or you can use the ‘close world’ button on the home screen of your dash. | To close an active session, you can press the ‘X’ button at the top right corner of the session, and press close, or you can use the ‘close world’ button on the home screen of your dash. | ||
=== How can I mute myself? === | === How can I mute myself? === | ||
| Line 141: | Line 117: | ||
To un-mute yourself, press the mute button again to restore your previous voice mode. | To un-mute yourself, press the mute button again to restore your previous voice mode. | ||
=== I’m stuck/I’ve made a mistake. === | === I’m stuck/I’ve made a mistake. === | ||
| Line 149: | Line 124: | ||
There are also the emergency respawn, and emergency disconnect gestures. To respawn yourself, hold your controllers up to your face, hold one grip button, and press both context menu buttons, and wait a few seconds until your controllers begin to vibrate. To disconnect from a world immediately, you can hold up the controllers to your face, and just hold both context menu buttons. | There are also the emergency respawn, and emergency disconnect gestures. To respawn yourself, hold your controllers up to your face, hold one grip button, and press both context menu buttons, and wait a few seconds until your controllers begin to vibrate. To disconnect from a world immediately, you can hold up the controllers to your face, and just hold both context menu buttons. | ||
=== How do I add someone as a contact? === | === How do I add someone as a contact? === | ||
To add someone as a Contact, you can click on their nameplate, and press the Add Contact button, or you can search for a user through the Contacts button on your Dash Menu, and typing in the search field at the top left. | To add someone as a Contact, you can click on their nameplate, and press the Add Contact button, or you can search for a user through the Contacts button on your Dash Menu, and typing in the search field at the top left. | ||
=== Can others see my UI? === | === Can others see my UI? === | ||
Other users are unable to see your UI by default, however some UI elements such as the context menus, and your interaction lasers can be publicly visible from within the session. | Other users are unable to see your UI by default, however some UI elements such as the context menus, and your interaction lasers can be publicly visible from within the session. | ||
=== How do I save objects to my inventory? === | === How do I save objects to my inventory? === | ||
| Line 164: | Line 136: | ||
Note: Some worlds and objects are set-up with permissions that prevent saving them to your inventory. | Note: Some worlds and objects are set-up with permissions that prevent saving them to your inventory. | ||
=== How can I organize my inventory? === | === How can I organize my inventory? === | ||
| Line 170: | Line 141: | ||
It is not presently possible to rearrange existing inventory locations, so to do so, you will need to spawn the object out, and save it into the new folder, then delete the original with the red trash can icon. This process will be streamlined in a future UI update. | It is not presently possible to rearrange existing inventory locations, so to do so, you will need to spawn the object out, and save it into the new folder, then delete the original with the red trash can icon. This process will be streamlined in a future UI update. | ||
=== What are public folders/how can I share items? === <!--T:105--> | === What are public folders/how can I share items? === <!--T:105--> | ||
| Line 183: | Line 153: | ||
To share privately with a contact, you can let them save a copy of the object as you spawn it out, or send it to them through the messaging system by gripping the object, and pressing the green plus button at the bottom right of the Contacts UI. | To share privately with a contact, you can let them save a copy of the object as you spawn it out, or send it to them through the messaging system by gripping the object, and pressing the green plus button at the bottom right of the Contacts UI. | ||
== Avatars and Assets == | == Avatars and Assets == | ||
=== How can I import my assets? === | === How can I import my assets? === | ||
| Line 194: | Line 162: | ||
For many assets an Importer UI will appear with options to set up the detected asset as an object for use in Resonite. | For many assets an Importer UI will appear with options to set up the detected asset as an object for use in Resonite. | ||
=== What kinds of assets does Resonite support? === | === What kinds of assets does Resonite support? === | ||
Models, textures, sounds, fonts, LUTs, and more- Resonite is capable of importing a wide range of assets in a wide range of commonly accepted formats. | Models, textures, sounds, fonts, LUTs, and more- Resonite is capable of importing a wide range of assets in a wide range of commonly accepted formats. | ||
=== How do I make an avatar? === | === How do I make an avatar? === | ||
Avatars are created through the Avatar Creator found in the Home section of your Dash Menu. Any object can be turned into an avatar including rigged models you’ve imported. | Avatars are created through the Avatar Creator found in the Home section of your Dash Menu. Any object can be turned into an avatar including rigged models you’ve imported. | ||
=== Importing An Avatar: === | === Importing An Avatar: === | ||
Once you’ve opened the asset in Resonite, a Model Importer UI will appear. For avatars you will want to select 3D Model > Regular > Auto Humanoid Height. You can either press Import Now!, or Advanced Settings if you wish to modify the setup, e.g. changing which materials the model is setup with. | Once you’ve opened the asset in Resonite, a Model Importer UI will appear. For avatars you will want to select 3D Model > Regular > Auto Humanoid Height. You can either press Import Now!, or Advanced Settings if you wish to modify the setup, e.g. changing which materials the model is setup with. | ||
=== Using the Avatar Creator: === | === Using the Avatar Creator: === | ||
| Line 212: | Line 176: | ||
You can also select the Protect Avatar option to prevent other users from equipping or saving a copy of your avatar. | You can also select the Protect Avatar option to prevent other users from equipping or saving a copy of your avatar. | ||
=== My avatar has no textures. === | === My avatar has no textures. === | ||
Sometimes an avatar may import without their textures. This is something that can be resolved from within Resonite using the Material Tool, and DevTool. Extract the materials from your avatar, and assign the textures you’ve imported by dragging them into their appropriate fields from within the Material Inspector. | Sometimes an avatar may import without their textures. This is something that can be resolved from within Resonite using the Material Tool, and DevTool. Extract the materials from your avatar, and assign the textures you’ve imported by dragging them into their appropriate fields from within the Material Inspector. | ||
=== What are the rig requirements? === | === What are the rig requirements? === | ||
| Line 223: | Line 185: | ||
A full list of the humanoid rig requirements can be found on [[Humanoid_Rig_Requirements_for_IK]]. | A full list of the humanoid rig requirements can be found on [[Humanoid_Rig_Requirements_for_IK]]. | ||
=== Can I import my <code>.unitypackage</code> avatar? === | === Can I import my <code>.unitypackage</code> avatar? === | ||
Not directly, no. <code>.unitypackage</code> is a compressed file format specific to use in Unity. However, if your model exists in a raw form such as a .fbx file within the project folder in Unity, you can use that to import, instead. | Not directly, no. <code>.unitypackage</code> is a compressed file format specific to use in Unity. However, if your model exists in a raw form such as a .fbx file within the project folder in Unity, you can use that to import, instead. | ||
=== What about my custom shaders? === | === What about my custom shaders? === | ||
| Line 234: | Line 194: | ||
However- a wide variety of visual effects can be achieved through the use of ProtoFlux, and components from within Resonite itself! | However- a wide variety of visual effects can be achieved through the use of ProtoFlux, and components from within Resonite itself! | ||
=== Does Resonite support dynamic bones for flowing hair, tails, etc? === <!--T:125--> | === Does Resonite support dynamic bones for flowing hair, tails, etc? === <!--T:125--> | ||
| Line 240: | Line 199: | ||
Once the bone chain has been added, you can modify a wide variety of properties such as the elasticity, gravity, and whether or not the bone chain is grabbable via the IsGrabbable checkbox. Dynamic bones can even be brushed around by your hands. | Once the bone chain has been added, you can modify a wide variety of properties such as the elasticity, gravity, and whether or not the bone chain is grabbable via the IsGrabbable checkbox. Dynamic bones can even be brushed around by your hands. | ||
=== How can I set my default avatar? === | === How can I set my default avatar? === | ||
After you have clicked to select an avatar from your inventory, press the purple heart icon to set an avatar as your favorite. An avatar can be unset as your favorite by pressing the button again, or choosing another avatar as your favorite. | After you have clicked to select an avatar from your inventory, press the purple heart icon to set an avatar as your favorite. An avatar can be unset as your favorite by pressing the button again, or choosing another avatar as your favorite. | ||
=== How can I change my home world? === | === How can I change my home world? === | ||
| Line 250: | Line 207: | ||
You can only use worlds that you have created, or saved a copy of using Save > Save Copy or Save > Save As from the Save menu in the Session section of your Dash Menu. | You can only use worlds that you have created, or saved a copy of using Save > Save Copy or Save > Save As from the Save menu in the Session section of your Dash Menu. | ||
=== How do I adjust the length of my arms/the fit of my avatar? === | === How do I adjust the length of my arms/the fit of my avatar? === | ||
| Line 257: | Line 213: | ||
Additionally, on the [[VRIKAvatar (Component) | VRIKAvatar]] component is the <code>HeightCompensation</code> property. This will scale your entire avatar down, or up to better match your body. This setting is also more easily accessible through the Full Body Calibrator tool. | Additionally, on the [[VRIKAvatar (Component) | VRIKAvatar]] component is the <code>HeightCompensation</code> property. This will scale your entire avatar down, or up to better match your body. This setting is also more easily accessible through the Full Body Calibrator tool. | ||
=== How do I set up full-body tracking? === | === How do I set up full-body tracking? === | ||
| Line 263: | Line 218: | ||
Once you’ve calibrated your trackers, you can proceed to the avatar calibration. You should only need to calibrate your trackers once so long as they remain in the same position, and orientation on your body. | Once you’ve calibrated your trackers, you can proceed to the avatar calibration. You should only need to calibrate your trackers once so long as they remain in the same position, and orientation on your body. | ||
=== My avatar is moving strangely with FBT. === | === My avatar is moving strangely with FBT. === | ||
| Line 273: | Line 227: | ||
Most avatars can work quite well in full-body with some tweaking. | Most avatars can work quite well in full-body with some tweaking. | ||
=== Does Resonite have an SDK? === | === Does Resonite have an SDK? === | ||
Resonite does not have an SDK, you will need to import and set things up from within Resonite itself. | Resonite does not have an SDK, you will need to import and set things up from within Resonite itself. | ||
== Resonite Features == | == Resonite Features == | ||
=== What is ProtoFlux? === | === What is ProtoFlux? === | ||
| Line 286: | Line 237: | ||
It is a powerful tool for managing, and manipulating data within a world, opening vast potential to your creations. | It is a powerful tool for managing, and manipulating data within a world, opening vast potential to your creations. | ||
=== Can I stream Resonite? === | === Can I stream Resonite? === | ||
| Line 293: | Line 243: | ||
The Camera Control panel also offers a variety of options to manipulate the camera. | The Camera Control panel also offers a variety of options to manipulate the camera. | ||
=== OBS and Twitch Integration: === | === OBS and Twitch Integration: === | ||
| Line 301: | Line 250: | ||
Your Twitch chat can be viewed from within Resonite by typing your channel name into the text entry field at the top of the Twitch Chat UI. You can pin the Twitch chat to you by pressing the yellow pin button, you can also make a publicly visible Twitch Chat UI by pressing the blue half-circle icon. | Your Twitch chat can be viewed from within Resonite by typing your channel name into the text entry field at the top of the Twitch Chat UI. You can pin the Twitch chat to you by pressing the yellow pin button, you can also make a publicly visible Twitch Chat UI by pressing the blue half-circle icon. | ||
=== What are Tools? === | === What are Tools? === | ||
| Line 309: | Line 257: | ||
These tools, and many more can all be found in the Essential Tools folder of your inventory. | These tools, and many more can all be found in the Essential Tools folder of your inventory. | ||
=== Locomotion Modules: === | === Locomotion Modules: === | ||
| Line 315: | Line 262: | ||
Details such as your speed, jump height, and whether or not you can climb on surfaces may change from world to world because of changes implemented by a world’s creator. | Details such as your speed, jump height, and whether or not you can climb on surfaces may change from world to world because of changes implemented by a world’s creator. | ||
== Account and Supporter Perks == | == Account and Supporter Perks == | ||
=== How do I get more cloud storage space? === | === How do I get more cloud storage space? === | ||
Additional cloud storage space is a perk awarded to our Patrons on Patreon. $1 per month will grant access to 5 GB of additional cloud storage, with additional storage space, and perks available at each successive tier. | Additional cloud storage space is a perk awarded to our Patrons on Patreon. $1 per month will grant access to 5 GB of additional cloud storage, with additional storage space, and perks available at each successive tier. | ||
=== Can I store things locally on my hard drive? === | === Can I store things locally on my hard drive? === | ||
You can save worlds, and their contents into your Local Home, which will save the assets locally on your computer. These files are not stored on the cloud, or backed up, so if you store anything here, please regularly backup your local database at <code>%USERPROFILE%\AppData\LocalLow\Yellow Dog Man Studios\Resonite</code> | You can save worlds, and their contents into your Local Home, which will save the assets locally on your computer. These files are not stored on the cloud, or backed up, so if you store anything here, please regularly backup your local database at <code>%USERPROFILE%\AppData\LocalLow\Yellow Dog Man Studios\Resonite</code> | ||
=== I am a Patreon supporter, how do I link my account in Resonite? === | === I am a Patreon supporter, how do I link my account in Resonite? === | ||
| Line 335: | Line 278: | ||
/setAlternateEmail <alternate email></code> | /setAlternateEmail <alternate email></code> | ||
=== Why can I see my Patreon status in-game, but not in the Discord server? === <!--T:159--> | === Why can I see my Patreon status in-game, but not in the Discord server? === <!--T:159--> | ||
Verify that you have linked your Discord account on Patreon: https://support.patreon.com/hc/en-us/articles/212052266-Get-my-Discord-role | Verify that you have linked your Discord account on Patreon: https://support.patreon.com/hc/en-us/articles/212052266-Get-my-Discord-role | ||
=== When does Patreon charge, and when will I get my perks? === | === When does Patreon charge, and when will I get my perks? === | ||
Our Patreon is set up to charge users immediately on the day you subscribe. All perks should be assigned right away within a six hour period. | Our Patreon is set up to charge users immediately on the day you subscribe. All perks should be assigned right away within a six hour period. | ||
=== I need to pause my pledge/my pledge failed to process. What will happen to my storage? === | === I need to pause my pledge/my pledge failed to process. What will happen to my storage? === | ||
| Line 351: | Line 291: | ||
If this adversely affects you, file a support ticket, and they may be able to help by temporarily raising your storage limit until you can resume your pledge. | If this adversely affects you, file a support ticket, and they may be able to help by temporarily raising your storage limit until you can resume your pledge. | ||
=== How can I change my display name in Resonite? === | === How can I change my display name in Resonite? === | ||
| Line 359: | Line 298: | ||
<code>/changeUsername <old username> <new username></code> | <code>/changeUsername <old username> <new username></code> | ||
=== How do I turn on [https://en.wikipedia.org/wiki/Multi-factor_authentication two-factor authentication]? === | === How do I turn on [https://en.wikipedia.org/wiki/Multi-factor_authentication two-factor authentication]? === | ||
| Line 377: | Line 315: | ||
Yes, please see [[Resonite_Bot#Delete_Account|this article]] | Yes, please see [[Resonite_Bot#Delete_Account|this article]] | ||
?= Troubleshooting == | ?= Troubleshooting == | ||
=== What do I do if Resonite crashes/I encounter a bug? === | === What do I do if Resonite crashes/I encounter a bug? === | ||
In the event that Resonite crashes, or you encounter a bug, collect your logs and file a GitHub issue on our issue tracker [https://github.com/Yellow-Dog-Man/Resonite-Issues/ here]. | In the event that Resonite crashes, or you encounter a bug, collect your logs and file a GitHub issue on our issue tracker [https://github.com/Yellow-Dog-Man/Resonite-Issues/ here]. | ||
=== Where can I find the log files? === | === Where can I find the log files? === | ||
Follow [[Log Files|this guide]] | Follow [[Log Files|this guide]] | ||
=== How can I report a bug I’ve found? === | === How can I report a bug I’ve found? === | ||
| Line 397: | Line 331: | ||
If you are uncertain if a behaviour is actually a bug, you can ask for clarification on our Discord server. | If you are uncertain if a behaviour is actually a bug, you can ask for clarification on our Discord server. | ||
=== How can I report a Security Issue / Exploit? === | === How can I report a Security Issue / Exploit? === | ||
If you've found an issue that you think is a security issue or an exploit that you'd like to report then please review our [[Security|Security & Exploit Reporting Policy]]. | If you've found an issue that you think is a security issue or an exploit that you'd like to report then please review our [[Security|Security & Exploit Reporting Policy]]. | ||
=== How can I help improve Resonite? === | === How can I help improve Resonite? === | ||
| Line 408: | Line 340: | ||
Currently there is no procedure for accessing early builds, this section will be updated should that change. | Currently there is no procedure for accessing early builds, this section will be updated should that change. | ||
=== What do I do if I get a sync error/sync isn't finishing? === | === What do I do if I get a sync error/sync isn't finishing? === | ||
| Line 415: | Line 346: | ||
=== General Troubleshooting and Known Issues === | === General Troubleshooting and Known Issues === | ||
=== Textures aren’t loading/are checker boarded. === | === Textures aren’t loading/are checker boarded. === | ||
See [[Checkerboard_Textures_(Troubleshooting)| this guide]] | See [[Checkerboard_Textures_(Troubleshooting)| this guide]] | ||
=== Resonite is crashing to the desktop on Windows 7. === | === Resonite is crashing to the desktop on Windows 7. === | ||
Revision as of 02:39, 14 January 2024
General Questions
What platforms and hardware does Resonite support?
Resonite is currently available on Windows and Linux. It supports all of the major headsets, including SteamVR/OpenVR, Oculus, and Windows Mixed Reality (via SteamVR).
Resonite also supports a wide range of hardware peripherals. Resonite supports as many trackers as SteamVR can provide (up to 64), 8 for full-body tracking (feet, knees, hip, chest, and elbows) with additional trackers able to be used to track objects.
Resonite also supports the Leap Motion for finger tracking, Eye Tracking via the Vive Pro Eye and standalone modules, HTC’s lip tracking, and controllers such as the etee controllers.
If you are a hardware developer, and wish to send a Dev Kit for integration into Resonite, please create a Feature Request or send a contact form on our website with your request.
What are Resonite’s hardware requirements?
Resonite requires a powerful quad-core CPU- at least a Haswell i5-4590 from Intel, Piledriver FX 8350 from AMD, or newer. Resonite benefits greatly from strong single-core performance. At least 8 GB of memory is recommended, although Resonite benefits greatly from 16 GB, or even 32 GB and above.
It is recommended to have a VR-capable card from either Nvidia (GTX 1060) or AMD (RX 570) although stronger GPUs have a high benefit for VR use by increasing resolution, and framerate.
Can I put Resonite in a window?
Yes! At any point, you can press the key combination Alt + Enter to place Resonite into a window. You can also specify command line arguments to change the windowed state and resolution.
E.g. -screen-fullscreen 0 -screen-width 1280 -screen-height 720 will place Resonite in a 1280x720 window at launch.
Can I play Resonite on the desktop?
Yes! With no VR hardware it will be launched by default, and while in VR it can be toggled to at any point by pressing F8.
The screen mode is under active development, and additional functionality is still to be developed.
Can I play with a controller?
Resonite currently offers preliminary support for gamepads, e.g. basic functionality such as moving, turning, jumping, and using the context menu. Additional support will be added later.
Is Resonite open source?
Currently, most of Resonite is not open source. Resonite is currently being developed by a small team and it is uncertain what the implications of open sourcing right now would be.
Does Resonite support modded clients?
Please see our Mod & Plugin Policy.
Is Resonite running on Unity?
Most of Resonite is running on the FrooxEngine, a custom-made engine crafted over the span of numerous years since around 2015 and around five hundred thousand lines of code, not including third party libraries.
Unity is used primarily for its renderer, the runtime environment (Mono/.NET), and interfacing with the audio system.
What are the rules in Resonite?
Be excellent to each other. Details can be found in our Guidelines page.
How can I report a user?
If a user is in clear, and/or repeated violation of the guidelines, we recommend reporting it via our moderation website.
Where possible, it is preferable that users resolve their own conflicts by use of the tools they have available to them in the form of the permissions system, muting, etc. You can read more on our Moderation page.
How can I protect myself from malicious users?
Resonite offers a versatile permissions system that allows users to control how their sessions are run. Worlds in Resonite are created with a set of permissions by the world’s creator.
Users that host sessions from these worlds are able to assign permission levels separately for each user in a session.
How can I identify Resonite Team members, and moderators?
- Resonite Team members can be identified by a rainbow or yellow name, and a Resonite logo badge above their name.
- Moderators can be identified by a blue name with a blue moderation shield badge.
- Mentors can be identified by a green name and a green mentor bulb badge.
You can verify these badges through the session menu as they will be displayed alongside their names there as well.
Beginner Questions
Are there any tutorials on how to use Resonite?
The Resonite Wiki has a range of Tutorials that will be expanded over time.
Our users are also very welcoming, and helpful, and often willing to lend a hand to each other either in Resonite, or on Discord.
What are the basic controls in Resonite?
Navigation and movement are assigned to the joystick, primary actions are assigned to the trigger (e.g. activating buttons), secondary actions are achieved by a joystick/touchpad click (e.g. jumping, tool use), grabbing/moving objects in a world is achieved with the grip button.
The context menu button is used to access context-sensitive actions, and other controls such as undo/redo, and your locomotion modes (these will be moved in a later UI update). Additional controls including screen mode controls can be found on our Basic Controls page.
Where can I find an avatar to use?
Inside of the inventory, there is an Avatars folder inside of the Resonite Essentials which contains a variety of avatars which are free to use, and modify. Additional avatars can be found through public folders shared with you, or found inside of worlds.
You can also use the avatar creator to turn any object into an avatar, including rigged avatar models you import.
How can I equip an avatar?
Avatars from your inventory you can quick-equip by selecting them once to highlight them, and then pressing the yellow lightning bolt. Avatars placed in the world can be equipped by clicking on them.
Where can I find other users?
Active sessions will be listed at the top of the worlds list under the “Worlds” tab of your dashboard. You can filter the listing to include only sessions with active users by using the “Active Sessions” search preset.
Can I explore other worlds?
There are a wide range of worlds to be explored. They can be found in the World Browser. The World Browser is in the Worlds section of your Dash Menu. You can scroll through the wide range of uploads spanning since Resonite’ inception, or you can filter the results.
The Featured search preset will display community-created worlds the Resonite Team wishes to showcase.
You can also search for specific tags in the search bar at the top, in addition to the numerous search presets for themed worlds, e.g. games, educational content, social hangouts, and more.
How can I invite friends to my session?
From the Contacts button on your Dash Menu, select the friend in your list you wish to invite, then press Invite Here.
How can I adjust the visibility of my session/how can I host a private session?
While in an active session, you can do this through the Session menu of your Dash Menu. Open the session Settings, then select your desired privacy level anywhere in the range from Anyone to Nobody/Invited Users.
While your status is set to Invisible, all sessions you create will be set to private by default.
Any sessions you create, or join in Resonite remain open, and active until you close them, close Resonite, or are removed from them (e.g. by an AFK kick). To navigate, and manage your open sessions, you will find them listed at the top of the world browser. Your active sessions will be listed first, and have a yellow border around them. You can switch sessions by clicking on the session, and pressing ‘focus’ on the pop-up modal.
To close an active session, you can press the ‘X’ button at the top right corner of the session, and press close, or you can use the ‘close world’ button on the home screen of your dash.
How can I mute myself?
On your dashboard, you will find a range of voice control options on a facet in the top left corner. Clicking on them will set your voice mode.
Mute is a toggle that will silence you, Whisper places a whisper bubble around you that dampens outside noise, and prevents anyone outside of the bubble from hearing you, Normal is the typical spatialized voice mode, Shout has increased volume, and range- good for large maps, and Broadcast disables spatialization, allowing you to be heard from anywhere (like a voice call on other platforms.)
To un-mute yourself, press the mute button again to restore your previous voice mode.
I’m stuck/I’ve made a mistake.
If you are stuck in a part of the world, if it’s available, you can use the Noclip locomotion mode to escape. To do so, open your context menu, click on the locomotion button, and choose from the available modes in the world.
In this same menu, you can undo your previous actions such as moving objects with the Undo button.
There are also the emergency respawn, and emergency disconnect gestures. To respawn yourself, hold your controllers up to your face, hold one grip button, and press both context menu buttons, and wait a few seconds until your controllers begin to vibrate. To disconnect from a world immediately, you can hold up the controllers to your face, and just hold both context menu buttons.
How do I add someone as a contact?
To add someone as a Contact, you can click on their nameplate, and press the Add Contact button, or you can search for a user through the Contacts button on your Dash Menu, and typing in the search field at the top left.
Can others see my UI?
Other users are unable to see your UI by default, however some UI elements such as the context menus, and your interaction lasers can be publicly visible from within the session.
How do I save objects to my inventory?
To save objects to your inventory, grab the object you wish to save, and press the green plus button. You can only save into a folder that you’ve created, and not public folders such as the Resonite Essentials.
Note: Some worlds and objects are set-up with permissions that prevent saving them to your inventory.
How can I organize my inventory?
You can create a new folder to save objects into by pressing the green plus button, and naming the folder.
It is not presently possible to rearrange existing inventory locations, so to do so, you will need to spawn the object out, and save it into the new folder, then delete the original with the red trash can icon. This process will be streamlined in a future UI update.
Public folders are denoted by their orange coloration. They are created by users, and their contents are publicly listed.
A list of public folders is available. It contains links. These links can be pasted into Resonite to generate a public folder object, then saved to the inventory.
To create a public folder, you can highlight a folder in your inventory, and press the beige envelope icon to create a public folder object which can be used to save the folder into the inventory of other users. To copy a public folders link, you can grip it open the context menu, and press the copy link button.
Public folders are not intended for use in sharing sensitive data as the objects contained within are publicly viewable. To unpublish a folder, you can press the purple hand icon.
To share privately with a contact, you can let them save a copy of the object as you spawn it out, or send it to them through the messaging system by gripping the object, and pressing the green plus button at the bottom right of the Contacts UI.
Avatars and Assets
How can I import my assets?
Assets can be brought into Resonite by either dragging, and dropping them from your PC’s file browser onto the Resonite window, copying and pasting the asset or a link to the asset into Resonite window or through the Paste Content From Clipboard button found in the session menu.
You can also navigate your filesystem from the File Browser found in your Dash Menu.
For many assets an Importer UI will appear with options to set up the detected asset as an object for use in Resonite.
What kinds of assets does Resonite support?
Models, textures, sounds, fonts, LUTs, and more- Resonite is capable of importing a wide range of assets in a wide range of commonly accepted formats.
How do I make an avatar?
Avatars are created through the Avatar Creator found in the Home section of your Dash Menu. Any object can be turned into an avatar including rigged models you’ve imported.
Importing An Avatar:
Once you’ve opened the asset in Resonite, a Model Importer UI will appear. For avatars you will want to select 3D Model > Regular > Auto Humanoid Height. You can either press Import Now!, or Advanced Settings if you wish to modify the setup, e.g. changing which materials the model is setup with.
Using the Avatar Creator:
To use the Avatar Creator, open it from the Home section of your Dash Menu. You will see spheres containing a HMD, and hands. Align those with your avatar’s. You can optionally set up the hips, and feet if you wish to make your model compatible with full-body tracking. This can also be set up later through the Full Body Calibrator tool.
You can also select the Protect Avatar option to prevent other users from equipping or saving a copy of your avatar.
My avatar has no textures.
Sometimes an avatar may import without their textures. This is something that can be resolved from within Resonite using the Material Tool, and DevTool. Extract the materials from your avatar, and assign the textures you’ve imported by dragging them into their appropriate fields from within the Material Inspector.
What are the rig requirements?
Resonite requires a general bone naming convention, and hierarchy to be set-up automatically as an avatar. Avatar rigs set-up for other platforms should generally be compatible with Resonite.
A full list of the humanoid rig requirements can be found on Humanoid_Rig_Requirements_for_IK.
Can I import my .unitypackage avatar?
Not directly, no. .unitypackage is a compressed file format specific to use in Unity. However, if your model exists in a raw form such as a .fbx file within the project folder in Unity, you can use that to import, instead.
What about my custom shaders?
Custom shaders are not supported at this time, as there is no way to compile JIT shaders at runtime. The shaders need to be compiled into Resonite itself.
However- a wide variety of visual effects can be achieved through the use of ProtoFlux, and components from within Resonite itself!
Does Resonite support dynamic bones for flowing hair, tails, etc?
Yes! To do so, open up your avatar with the DevTool, navigate to the bone you wish to start the chain from, and attach the DynamicBoneChain component. Once it’s attached, browse to the bottom of the component, and select the Setup From Children button.
Once the bone chain has been added, you can modify a wide variety of properties such as the elasticity, gravity, and whether or not the bone chain is grabbable via the IsGrabbable checkbox. Dynamic bones can even be brushed around by your hands.
How can I set my default avatar?
After you have clicked to select an avatar from your inventory, press the purple heart icon to set an avatar as your favorite. An avatar can be unset as your favorite by pressing the button again, or choosing another avatar as your favorite.
How can I change my home world?
Like setting your default avatar, you can set a favorite world from a world orb in your inventory. Select the world orb in your inventory, and press the Set Home button to favorite it.
You can only use worlds that you have created, or saved a copy of using Save > Save Copy or Save > Save As from the Save menu in the Session section of your Dash Menu.
How do I adjust the length of my arms/the fit of my avatar?
From a DevTool, inspect the root of your avatar, and look through the VRIK component settings. You will find a value called ArmLengthMlp under each of the leftArm and rightArm. Adjusting these values slightly will give your arms a little more reach if they’re too short, or make your arms bend less if they’re too long.
Additionally, on the VRIKAvatar component is the HeightCompensation property. This will scale your entire avatar down, or up to better match your body. This setting is also more easily accessible through the Full Body Calibrator tool.
How do I set up full-body tracking?
Use the Full Body Calibrator found in the Home section of your Dash Menu. If this is the first time doing so, ensure your height is set correctly to your real height, confirm your trackers are recognized, then press the Start Tracker Calibration and align yourself as closely as you can in your playspace to the outline avatar.
Once you’ve calibrated your trackers, you can proceed to the avatar calibration. You should only need to calibrate your trackers once so long as they remain in the same position, and orientation on your body.
My avatar is moving strangely with FBT.
Some avatars can be oddly proportioned for full-body tracking. Like when an avatar is initially set up in the Avatar Creator, on the Full Body Calibrator, you will find options to help you fit your avatar to your body. The height compensation slider will grow or shrink your avatar’s size to better fit your own- a value around 0.92-0.95 is a good starting point.
If your chest and neck are moving strangely, you may wish to lower the target of your avatars hips by gripping them, and pulling them down, paying attention to the blue avatar rig visual.
If your avatar sinks into the floor when ducking, try raising the foot targets up to around their shins, or until you notice the legs begin to move upward on your avatar.
Most avatars can work quite well in full-body with some tweaking.
Does Resonite have an SDK?
Resonite does not have an SDK, you will need to import and set things up from within Resonite itself.
Resonite Features
What is ProtoFlux?
ProtoFlux is the node-based visual scripting language of Resonite. It forms the basis of many of the gadgets, toys, and game mechanics you will find within the various worlds our community have created.
It is a powerful tool for managing, and manipulating data within a world, opening vast potential to your creations.
Can I stream Resonite?
So long as the content is within our Guidelines, and the terms of use of the platform you stream to, you are welcome to share your time in the metaverse with others. Please utilize the Mirror To Display option found within the Camera / Streaming tool in the Home section of the Dash Menu. While Mirror To Display is enabled, a LIVE badge will appear over you head to notify other users that you are recording.
The Camera Control panel also offers a variety of options to manipulate the camera.
OBS and Twitch Integration:
Within the camera control panel, you will find buttons bearing the OBS and Twitch logos.
The OBS websocket allows you to remotely launch, and begin recording or streaming from OBS: https://github.com/Palakis/obs-websocket/releases
Your Twitch chat can be viewed from within Resonite by typing your channel name into the text entry field at the top of the Twitch Chat UI. You can pin the Twitch chat to you by pressing the yellow pin button, you can also make a publicly visible Twitch Chat UI by pressing the blue half-circle icon.
What are Tools?
Tools in Resonite are used in a variety of world, asset, and object creation workflows. They are what drives your ability to create from within Resonite. From simple brushes to draw, and paint, to complex and versatile tools such as the DevTool for general world manipulation, Material Tool for texturing, and ProtoFlux Tool for programming.
There are also other useful tools such as the Grabbable Setter Tool to change whether or not you can grab and move an object, and the Character Collider Setter Tool, which can make your environments collidable so you can walk on them.
These tools, and many more can all be found in the Essential Tools folder of your inventory.
Locomotion Modules:
Locomotion modules determine the types of locomotion that are available in a world. While a default set of locomotion modules exist in all of the template maps that many worlds are created from, a world creator may choose to modify, or remove certain locomotion modes from their world.
Details such as your speed, jump height, and whether or not you can climb on surfaces may change from world to world because of changes implemented by a world’s creator.
Account and Supporter Perks
How do I get more cloud storage space?
Additional cloud storage space is a perk awarded to our Patrons on Patreon. $1 per month will grant access to 5 GB of additional cloud storage, with additional storage space, and perks available at each successive tier.
Can I store things locally on my hard drive?
You can save worlds, and their contents into your Local Home, which will save the assets locally on your computer. These files are not stored on the cloud, or backed up, so if you store anything here, please regularly backup your local database at %USERPROFILE%\AppData\LocalLow\Yellow Dog Man Studios\Resonite
I am a Patreon supporter, how do I link my account in Resonite?
If your Resonite account email is the same as your Patreon email, linking should occur automatically within a six hour period. If it has not, or your Resonite email address differs from your Patreon, you can send either of these two commands to the Resonite bot in-game:
/setPrimaryEmail <new email>
/setAlternateEmail <alternate email>
Why can I see my Patreon status in-game, but not in the Discord server?
Verify that you have linked your Discord account on Patreon: https://support.patreon.com/hc/en-us/articles/212052266-Get-my-Discord-role
When does Patreon charge, and when will I get my perks?
Our Patreon is set up to charge users immediately on the day you subscribe. All perks should be assigned right away within a six hour period.
I need to pause my pledge/my pledge failed to process. What will happen to my storage?
It’s understandable that life can get in the way sometimes. Your support as a Patron is always greatly appreciated. In the event that you are over your storage limit when this happens, you will be unable to save any additional content to your cloud.
If this adversely affects you, file a support ticket, and they may be able to help by temporarily raising your storage limit until you can resume your pledge.
How can I change my display name in Resonite?
To change your display name in Resonite you may send the following command to the Resonite bot in-game. You must wait 7 days before you can use this command again; this delay is subject to change in the future.
/changeUsername <old username> <new username>
How do I turn on two-factor authentication?
You can enable 2FA on your dash from the tools facet, which has a "Setup 2FA" option. To set it up you'll need a TOTP authenticator app, like Authy or Google Authenticator.
Once 2FA is setup, you can enable 2FA requirement for login by sending the /enableLogin2FA command to the Resonite Bot account.
Using "Remember Me" will not require a 2FA code every time you start Resonite. If you want even more increased security, do not check this option and manually log in every time. However this shouldn't pose a significant risk, as the "remember me" token is invalidated every time you log in.
You can disable 2FA requirement for login by sending the /disableLogin2FA command.
Take care to protect your secret code and recovery codes. If you lose them, you'll PERMANENTLY lose access to your account!
Headless clients support 2FA login as well. Note that with Headless you cannot use auto-login in the configuration file with 2FA; only the dynamic "login" command will work.
Can I delete my account
Yes, please see this article
?= Troubleshooting ==
What do I do if Resonite crashes/I encounter a bug?
In the event that Resonite crashes, or you encounter a bug, collect your logs and file a GitHub issue on our issue tracker here.
Where can I find the log files?
Follow this guide
How can I report a bug I’ve found?
If the bug is replicable, and you have all of the details necessary to recreate it, create a new issue on our GitHub detailing all that you know about the issue, and posting your logs about the issue in the post.
If you are unable to immediately replicate the issue, indicate so in the Github issue and provide as many details as you can, and submit your logs so they may be investigated.
If you are uncertain if a behaviour is actually a bug, you can ask for clarification on our Discord server.
How can I report a Security Issue / Exploit?
If you've found an issue that you think is a security issue or an exploit that you'd like to report then please review our Security & Exploit Reporting Policy.
How can I help improve Resonite?
Currently there is no procedure for accessing early builds, this section will be updated should that change.
What do I do if I get a sync error/sync isn't finishing?
See this guide
General Troubleshooting and Known Issues
Textures aren’t loading/are checker boarded.
See this guide
Resonite is crashing to the desktop on Windows 7.
Resonite does not officially support Windows 7 as it is past End of Life. However, creating an empty file with no extension in the root of your C drive called UseUnityAudioAPI may resolve the issue.
Resonite doesn’t load on Windows 10 N.
If you are on Windows 10 N, you may be missing necessary dependencies to run Resonite. Try downloading the Media Feature Pack for N versions of Windows 10: https://www.microsoft.com/en-us/software-download/mediafeaturepack
My database is frequently corrupting/my primary drive is out of space.
See this guide
Resonite is visible on the desktop, but not in my HMD.
If you are on Oculus, ensure that you are running Resonite through the Oculus runtime. To do so, make sure SteamVR isn’t running when you launch Resonite from Oculus Home.
You may also manually specify the -RiftTouch command line argument through the launch options in Steam. To access them, right click on Resonite in your Steam library, and select Properties then Set Launch Options.
You can also force the SteamVR runtime instead either by using the Play Resonite with SteamVR runtime forced on option, specifying your device as SteamVR in the Resonite launcher, or using the -SteamVR command line argument in the launch options in Steam.
None of the above apply/I’m still in need of help.
In the event that your issue isn’t resolved by any of the above solutions, please feel free to reach out to other users through the #questions-help forum in our Discord server.
Monetization Questions
Does Resonite use Cryptocurrency?
No
Does Resonite use NFTs?
No
Will Resonite use NFTs or Cryptocurrency in the future?
No