Toggle search
Search
Toggle menu
notifications
Toggle personal menu
Export translations
Views
Language statistics
Message group statistics
Export
associated-pages
Translate
More actions
Settings
Group
Account data download
Avatar System
Badges
Badges/MMC
Basic controls
Category:Community standards
Category:Components
Category:Troubleshooting
Category:Versions
Checkerboard Textures
Clear your database
Clearing your cache
Color masks
Command line arguments
Community tools
Component
Component:MaterialApplyPolicy
Component:ValueGradientDriver
Contact Us
Context
ContinuouslyChanging
Dash menu
Data and cache directories
Database corrupted
Database repair
Diagram:LNLConnectionOptions
Diagram:LNLRelayConnection
Dynamic variables
Face and Eye Tracking (Troubleshooting)
Financial Reports
Financial Reports/Q1 2024
Financial Reports/Terms
Financial Updates/Q2 2024
Frequently Asked Questions
Full Storage
Groups
Headless server software/Loading a specific world
Help:Translating
Homes
How to Help
Importing and using MSDFs
Impulses
Infrastructure
Installing Resonite
Interface type
Inventory
LAN Sessions
Linkage
List of community tools
List of largest sessions
List of public folders
Locale
Log files
Main Page
May 2024 survey
Mentors
Migrations
MMC
Moderation
Networking information
Office hours
Patreon
Patreon Linking
Plugins
ProtoFlux
Public folders
Reference type
Relocating and deleting Resonite directories
ResoFrancophone
Resonite bot
Resonite team
Roadmap
Scene Inspector
Slot
Slot count
Slot transforms
Spatial variable standards
Stuck Sync
Stuck Sync/Out Of Space
Sync errors
Synchronize your Clock
Template:FurtherHelp
Template:Removed
Template:StandaloneCommandLineArguments
Template:SteamCommandLineArguments
Template:TroubleshootingDoNot
Template:UnreleasedFeature
Test:Mermaid
Test:Translate
Test:Translate2
Test:Translate3
Test:Translate4
Test:Translate40
Things to avoid
Universes
Update
User ID
User:Dillmatt09
User:J4
User:PJB
User:ProbablePrime
User:Yosh/sandbox
Value type
Wiki contributions & translations
World and session thumbnails
Language
aa - Afar
aae - Arbërisht
ab - Abkhazian
abs - Ambonese Malay
ace - Achinese
acm - Iraqi Arabic
ady - Adyghe
ady-cyrl - Adyghe (Cyrillic script)
aeb - Tunisian Arabic
aeb-arab - Tunisian Arabic (Arabic script)
aeb-latn - Tunisian Arabic (Latin script)
af - Afrikaans
aln - Gheg Albanian
alt - Southern Altai
am - Amharic
ami - Amis
an - Aragonese
ang - Old English
ann - Obolo
anp - Angika
ar - Arabic
arc - Aramaic
arn - Mapuche
arq - Algerian Arabic
ary - Moroccan Arabic
arz - Egyptian Arabic
as - Assamese
ase - American Sign Language
ast - Asturian
atj - Atikamekw
av - Avaric
avk - Kotava
awa - Awadhi
ay - Aymara
az - Azerbaijani
azb - South Azerbaijani
ba - Bashkir
ban - Balinese
ban-bali - Balinese (Balinese script)
bar - Bavarian
bbc - Batak Toba
bbc-latn - Batak Toba (Latin script)
bcc - Southern Balochi
bci - Baoulé
bcl - Central Bikol
bdr - West Coast Bajau
be - Belarusian
be-tarask - Belarusian (Taraškievica orthography)
bew - Betawi
bg - Bulgarian
bgn - Western Balochi
bh - Bhojpuri
bho - Bhojpuri
bi - Bislama
bjn - Banjar
blk - Pa'O
bm - Bambara
bn - Bangla
bo - Tibetan
bpy - Bishnupriya
bqi - Bakhtiari
br - Breton
brh - Brahui
bs - Bosnian
btm - Batak Mandailing
bto - Iriga Bicolano
bug - Buginese
bxr - Russia Buriat
ca - Catalan
cbk-zam - Chavacano
cdo - Min Dong Chinese
ce - Chechen
ceb - Cebuano
ch - Chamorro
cho - Choctaw
chr - Cherokee
chy - Cheyenne
ckb - Central Kurdish
co - Corsican
cps - Capiznon
cpx - Pu-Xian Min
cpx-hans - Pu-Xian Min (Simplified Han script)
cpx-hant - Pu-Xian Min (Traditional Han script)
cpx-latn - Pu-Xian Min (Latin script)
cr - Cree
crh - Crimean Tatar
crh-cyrl - Crimean Tatar (Cyrillic script)
crh-latn - Crimean Tatar (Latin script)
crh-ro - Crimean Tatar (Romania)
cs - Czech
csb - Kashubian
cu - Church Slavic
cv - Chuvash
cy - Welsh
da - Danish
dag - Dagbani
de - German
de-at - Austrian German
de-ch - Swiss High German
de-formal - German (formal address)
dga - Dagaare
din - Dinka
diq - Zazaki
dsb - Lower Sorbian
dtp - Central Dusun
dty - Doteli
dv - Divehi
dz - Dzongkha
ee - Ewe
efi - Efik
egl - Emilian
el - Greek
eml - Emiliano-Romagnolo
en - English
en-ca - Canadian English
en-gb - British English
eo - Esperanto
es - Spanish
es-419 - Latin American Spanish
es-formal - Spanish (formal address)
et - Estonian
eu - Basque
ext - Extremaduran
fa - Persian
fat - Fanti
ff - Fula
fi - Finnish
fit - Tornedalen Finnish
fj - Fijian
fo - Faroese
fon - Fon
fr - French
frc - Cajun French
frp - Arpitan
frr - Northern Frisian
fur - Friulian
fy - Western Frisian
ga - Irish
gaa - Ga
gag - Gagauz
gan - Gan Chinese
gan-hans - Gan (Simplified)
gan-hant - Gan (Traditional)
gcf - kréyòl Gwadloup
gcr - Guianan Creole
gd - Scottish Gaelic
gl - Galician
gld - Nanai
glk - Gilaki
gn - Guarani
gom - Goan Konkani
gom-deva - Goan Konkani (Devanagari script)
gom-latn - Goan Konkani (Latin script)
gor - Gorontalo
got - Gothic
gpe - Ghanaian Pidgin
grc - Ancient Greek
gsw - Alemannic
gu - Gujarati
guc - Wayuu
gur - Frafra
guw - Gun
gv - Manx
ha - Hausa
hak - Hakka Chinese
haw - Hawaiian
he - Hebrew
hi - Hindi
hif - Fiji Hindi
hif-latn - Fiji Hindi (Latin script)
hil - Hiligaynon
hno - Northern Hindko
ho - Hiri Motu
hr - Croatian
hrx - Hunsrik
hsb - Upper Sorbian
hsn - Xiang Chinese
ht - Haitian Creole
hu - Hungarian
hu-formal - Hungarian (formal address)
hy - Armenian
hyw - Western Armenian
hz - Herero
ia - Interlingua
id - Indonesian
ie - Interlingue
ig - Igbo
igl - Igala
ii - Sichuan Yi
ik - Inupiaq
ike-cans - Eastern Canadian (Aboriginal syllabics)
ike-latn - Eastern Canadian (Latin script)
ilo - Iloko
inh - Ingush
io - Ido
is - Icelandic
it - Italian
iu - Inuktitut
ja - Japanese
jam - Jamaican Creole English
jbo - Lojban
jut - Jutish
jv - Javanese
ka - Georgian
kaa - Kara-Kalpak
kab - Kabyle
kai - Karekare
kbd - Kabardian
kbd-cyrl - Kabardian (Cyrillic script)
kbp - Kabiye
kcg - Tyap
kea - Kabuverdianu
kg - Kongo
kge - Basa Kumoring
khw - Khowar
ki - Kikuyu
kiu - Kirmanjki
kj - Kuanyama
kjh - Khakas
kjp - Eastern Pwo
kk - Kazakh
kk-arab - Kazakh (Arabic script)
kk-cn - Kazakh (China)
kk-cyrl - Kazakh (Cyrillic script)
kk-kz - Kazakh (Kazakhstan)
kk-latn - Kazakh (Latin script)
kk-tr - Kazakh (Turkey)
kl - Kalaallisut
km - Khmer
kn - Kannada
ko - Korean
ko-kp - Korean (North Korea)
koi - Komi-Permyak
kr - Kanuri
krc - Karachay-Balkar
kri - Krio
krj - Kinaray-a
krl - Karelian
ks - Kashmiri
ks-arab - Kashmiri (Arabic script)
ks-deva - Kashmiri (Devanagari script)
ksh - Colognian
ksw - S'gaw Karen
ku - Kurdish
ku-arab - Kurdish (Arabic script)
ku-latn - Kurdish (Latin script)
kum - Kumyk
kus - Kʋsaal
kv - Komi
kw - Cornish
ky - Kyrgyz
la - Latin
lad - Ladino
lb - Luxembourgish
lbe - Lak
lez - Lezghian
lfn - Lingua Franca Nova
lg - Ganda
li - Limburgish
lij - Ligurian
liv - Livonian
lki - Laki
lld - Ladin
lmo - Lombard
ln - Lingala
lo - Lao
loz - Lozi
lrc - Northern Luri
lt - Lithuanian
ltg - Latgalian
lus - Mizo
luz - Southern Luri
lv - Latvian
lzh - Literary Chinese
lzz - Laz
mad - Madurese
mag - Magahi
mai - Maithili
map-bms - Basa Banyumasan
mdf - Moksha
mg - Malagasy
mh - Marshallese
mhr - Eastern Mari
mi - Māori
min - Minangkabau
mk - Macedonian
ml - Malayalam
mn - Mongolian
mnc - Manchu
mnc-latn - Manchu (Latin script)
mnc-mong - Manchu (Mongolian script)
mni - Manipuri
mnw - Mon
mo - Moldovan
mos - Mossi
mr - Marathi
mrh - Mara
mrj - Western Mari
ms - Malay
ms-arab - Malay (Jawi script)
mt - Maltese
mus - Muscogee
mwl - Mirandese
my - Burmese
myv - Erzya
mzn - Mazanderani
na - Nauru
nah - Nāhuatl
nan - Min Nan Chinese
nap - Neapolitan
nb - Norwegian Bokmål
nds - Low German
nds-nl - Low Saxon
ne - Nepali
new - Newari
ng - Ndonga
nia - Nias
nit - కొలామి
niu - Niuean
nl - Dutch
nl-informal - Dutch (informal address)
nmz - Nawdm
nn - Norwegian Nynorsk
no - Norwegian
nod - Northern Thai
nog - Nogai
nov - Novial
nqo - N’Ko
nrm - Norman
nso - Northern Sotho
nv - Navajo
ny - Nyanja
nyn - Nyankole
nyo - Nyoro
nys - Nyungar
oc - Occitan
ojb - Northwestern Ojibwa
olo - Livvi-Karelian
om - Oromo
or - Odia
os - Ossetic
pa - Punjabi
pag - Pangasinan
pam - Pampanga
pap - Papiamento
pcd - Picard
pcm - Nigerian Pidgin
pdc - Pennsylvania German
pdt - Plautdietsch
pfl - Palatine German
pi - Pali
pih - Norfuk / Pitkern
pl - Polish
pms - Piedmontese
pnb - Western Punjabi
pnt - Pontic
prg - Prussian
ps - Pashto
pt - Portuguese
pt-br - Brazilian Portuguese
pwn - Paiwan
qqq - Message documentation
qu - Quechua
qug - Chimborazo Highland Quichua
rgn - Romagnol
rif - Riffian
rki - Arakanese
rm - Romansh
rmc - Carpathian Romani
rmy - Vlax Romani
rn - Rundi
ro - Romanian
roa-tara - Tarantino
rsk - Pannonian Rusyn
ru - Russian
rue - Rusyn
rup - Aromanian
ruq - Megleno-Romanian
ruq-cyrl - Megleno-Romanian (Cyrillic script)
ruq-latn - Megleno-Romanian (Latin script)
rut - мыхаӀбишды
rw - Kinyarwanda
ryu - Okinawan
sa - Sanskrit
sah - Yakut
sat - Santali
sc - Sardinian
scn - Sicilian
sco - Scots
sd - Sindhi
sdc - Sassarese Sardinian
sdh - Southern Kurdish
se - Northern Sami
se-fi - Northern Sami (Finland)
se-no - Northern Sami (Norway)
se-se - Northern Sami (Sweden)
sei - Seri
ses - Koyraboro Senni
sg - Sango
sgs - Samogitian
sh - Serbo-Croatian
sh-cyrl - Serbo-Croatian (Cyrillic script)
sh-latn - Serbo-Croatian (Latin script)
shi - Tachelhit
shi-latn - Tachelhit (Latin script)
shi-tfng - Tachelhit (Tifinagh script)
shn - Shan
shy - Shawiya
shy-latn - Shawiya (Latin script)
si - Sinhala
simple - Simple English
sjd - Kildin Sami
sje - Pite Sami
sk - Slovak
skr - Saraiki
skr-arab - Saraiki (Arabic script)
sl - Slovenian
sli - Lower Silesian
sm - Samoan
sma - Southern Sami
smn - Inari Sami
sms - Skolt Sami
sn - Shona
so - Somali
sq - Albanian
sr - Serbian
sr-ec - Serbian (Cyrillic script)
sr-el - Serbian (Latin script)
srn - Sranan Tongo
sro - Campidanese Sardinian
ss - Swati
st - Southern Sotho
stq - Saterland Frisian
sty - Siberian Tatar
su - Sundanese
sv - Swedish
sw - Swahili
syl - Sylheti
szl - Silesian
szy - Sakizaya
ta - Tamil
tay - Tayal
tcy - Tulu
tdd - Tai Nuea
te - Telugu
tet - Tetum
tg - Tajik
tg-cyrl - Tajik (Cyrillic script)
tg-latn - Tajik (Latin script)
th - Thai
ti - Tigrinya
tk - Turkmen
tl - Tagalog
tly - Talysh
tly-cyrl - Talysh (Cyrillic script)
tn - Tswana
to - Tongan
tok - Toki Pona
tpi - Tok Pisin
tr - Turkish
tru - Turoyo
trv - Taroko
ts - Tsonga
tt - Tatar
tt-cyrl - Tatar (Cyrillic script)
tt-latn - Tatar (Latin script)
ttj - Orutooro
tum - Tumbuka
tw - Twi
ty - Tahitian
tyv - Tuvinian
tzm - Central Atlas Tamazight
udm - Udmurt
ug - Uyghur
ug-arab - Uyghur (Arabic script)
ug-latn - Uyghur (Latin script)
uk - Ukrainian
ur - Urdu
uz - Uzbek
uz-cyrl - Uzbek (Cyrillic script)
uz-latn - Uzbek (Latin script)
ve - Venda
vec - Venetian
vep - Veps
vi - Vietnamese
vls - West Flemish
vmf - Main-Franconian
vmw - Makhuwa
vo - Volapük
vot - Votic
vro - Võro
wa - Walloon
wal - Wolaytta
war - Waray
wls - Wallisian
wo - Wolof
wuu - Wu Chinese
wuu-hans - Wu Chinese (Simplified)
wuu-hant - Wu Chinese (Traditional)
x-xss - fake xss language (see $wgUseXssLanguage)
xal - Kalmyk
xh - Xhosa
xmf - Mingrelian
xsy - Saisiyat
yi - Yiddish
yo - Yoruba
yrl - Nheengatu
yue - Cantonese
yue-hans - Cantonese (Simplified)
yue-hant - Cantonese (Traditional)
za - Zhuang
zea - Zeelandic
zgh - Standard Moroccan Tamazight
zh - Chinese
zh-cn - Chinese (China)
zh-hans - Simplified Chinese
zh-hant - Traditional Chinese
zh-hk - Chinese (Hong Kong)
zh-mo - Chinese (Macau)
zh-my - Chinese (Malaysia)
zh-sg - Chinese (Singapore)
zh-tw - Chinese (Taiwan)
zu - Zulu
Format
Export for off-line translation
Export in native format
Export in CSV format
Fetch
<languages /> = <span lang="en" dir="ltr" class="mw-content-ltr">Summary</span> = <div lang="en" dir="ltr" class="mw-content-ltr"> Resonite is a fantastic engine with a whole lot of power, options and capabilities. Some methods or practices can however be problematic or may lead to breakages at a later date. This is a general list of things to avoid or not do and the reasons behind them and some solutions or workarounds to assist you. Feel free to continue using these features. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> <p style="font-size:2em;">'''Items on this page are NOT against the [[Guidelines]]'''.</p> </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Though wherever possible, it is recommended to avoid using these items. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> This list is also not meant to call out anyone or have any bad intentions but is worth a read to understand where you might be able to improve your creations and to ensure that updates or other users do not unintentionally end up breaking things. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> If something feels hacky or undesirable please ask the community or the team if its a good idea or not. If there are problems or gaps that you'd like to see resolved, please open an issue on [https://github.com/Yellow-Dog-Man/Resonite-Issues/issues Github]. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Working around unsupported or not yet implemented features</span> = <div lang="en" dir="ltr" class="mw-content-ltr"> Certain features that are yet to be implemented officially can be "hacked in" or achieved through modifying certain internal systems and properties. While we're ok with experimenting and toying around, please be aware that those approaches will very likely break, '''without guaranteed prior warning and official implementation''' in place. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> This can leave you with broken content without ability to fix it until a much later point in the future, so we recommend avoiding such approaches in the first place and instead finding different method using already supported features. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> You can find list of planned features on our official GitHub: https://github.com/Yellow-Dog-Man/Resonite-Issues and vote on them so we prioritize them sooner. For any official features we always put great care into ensuring long term content compatibility over faster implementation, to ensure that future updates will keep your content functional. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> If we close a certain issue as something that we don't plan on implementing, we strongly advise against using hacks and workarounds to achieve that result completely, as those will be brittle and will break without replacement coming at all. In such cases you'll have to find a different approach that works with the design of the system to ensure long term compatibility. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Behavior of bugs</span> = <div lang="en" dir="ltr" class="mw-content-ltr"> If you encounter behaviors that seem incorrect and not like an intended feature, we strongly suggest you report it as soon as possible and don't rely on the behavior of the buggy system. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Whenever that bug gets fixed, either through a report or rework of the system, we might not be able to reasonably replicate behavior of the bug to preserve your content, meaning it will technically "break". </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Bugs can also by themselves be unreliable and only occur under certain conditions - making anything that relies on their behavior brittle and prone to breakage even without any changes to the code. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Slots</span> = <div lang="en" dir="ltr" class="mw-content-ltr"> Avoid relying on Slot names or structure for items and slots that '''you don’t own or control''' within your ProtoFlux or components. The names of slots and their structure for items '''you don’t own or control may change at any time''' and this can break things you’ve made. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Here are some examples of where this may occur and some alternatives or suggestions to attempt to mitigate the issues </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Names or structure of a user Root</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Items may be added or removed from the User Root with the addition of new features or updates to features. So try not to rely on this structure or naming conventions that these slots have. Additionally, do not rely on the ordering of these slots as they may change at any time. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Recently for example new Slots were added to a User root to cover the new "Freeform Camera". </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Things to avoid in this area: * Find Child By Name * Repeated use of Get Parent / Get Child nodes to locate a slot using searching or understood hierarchy depths </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Solutions for this area: * Use the [[:Category:ProtoFlux:Users:UserRoot|User Root Nodes]] to locate a user's slot. * Use the [[:Category:ProtoFlux:Users|User Nodes]]. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Names or structure of an Avatar</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Avatars are very complex creations. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Avoid: * Find Child By Name to locate avatar parts * Repeated use of Get Parent / Get Child nodes to locate avatar parts * Assuming the structure of an avatar ** For example, head and hands avatars don't have an "Avatar Root" </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Solutions in this area: * Use the [[:Category:ProtoFlux:Avatar|Avatar Nodes]]. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> If you’d like to routinely find or acquire a slot in the User Root, consider requesting a new node or feature for it on our [https://github.com/Yellow-Dog-Man/Resonite-Issues Github] if it doesn't exist. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Names or structures of other people’s worlds</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> When visiting other user’s worlds it is very important to remember that you are a guest in their space. When creating gadgets, tools and avatars you should try to be respectful of their world. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Things to avoid: * Placing items in the root from Guns/Rockets and other items. * Assuming the setup of the world is standard in terms of hierarchy for things like spawn or lights etc. * Custom Culling systems or locomotion modules * Avoid Calling [[Dynamic Impulses]] to the Root Slot * Avoid placing [[Dynamic Variables]] in the Root Slot or World Variable Space * Avoid leaving items in the world when you leave. Clean up after yourself. ** Temporary items from Guns/Rockets & Particles should clean up after themselves. Consider marking them as non-persistent or setting them to delete themselves when you leave. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Solutions: * When using the Set Parent node with a Root Slot Parent, Instead Supply a “Local User Space” node this will function identically in most cases but will keep items parented correctly to any world management systems rather than littering the root. * Ask the world owner before spawning complex gadgets or modifying the world root. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Slot obfuscation / "Encryption"</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Once you've made something you may want to protect it. When doing this don't: * Rename Slots, Nodes etc. * Move, scale, rotate slots * Apply [[ProtoFlux]] to your creation which does any of the above. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> While, this may seem like a way to protect your creation it doesn't do much for a knowledgeable user who has Builder permissions. Regardless of your methodology any in-app obfuscation is relatively easy to break in this manner. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Instead: * For Avatars: utilize Avatar protection systems such as [[Component:SimpleAvatarProtection|Simple Avatar Protection]] * Avoid setting users as Builder in a world you want protected * Avoid spawning items in sessions with users you do not know or trust </div> <div lang="en" dir="ltr" class="mw-content-ltr"> We also have several items on our roadmap to aid in this area, we'd encourage you to follow their progress and to vote on them: * Hard Permissions ([https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/1103 #1103]) - Protects assets, items and ProtoFlux within a World. * Object ID / Licenses ([https://github.com/Yellow-Dog-Man/Resonite-Issues/issues/626 #626]) - Protects assets, avatars, items, worlds etc. from being saved. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Avatars</span> = == <span lang="en" dir="ltr" class="mw-content-ltr">Disabling key Avatar Components</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Avatars are very complex things, please don't disable any of the key components that avatars need to function. If you find yourself doing this too often please open a GitHub issue or ask a question on our discord about the behaviour you are trying to achieve. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> == Disabling Raycasts on your Avatar == <!--T :56--> We have a lot of tools, gadgets and items which may affect your avatar. Things like Knockback guns, explosions, guns, tools that mess with your scale etc. are quite common. A solution to this which is common is for users to disable the ability for their avatar to respond to ray casts. While this works in principle it can cause game experiences and standard components or systems to not function. This can reduce your quality of experience across Resonite. It is also actually hiding a larger problem and this is culture and guidelines related. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Editing, messing with, and affecting you or your avatar in a session without your consent is against the [[Guidelines]]. Users doing this might not be aware that what they are doing is wrong so please take the time to inform them about the importance of consent and our [[Guidelines]]. Should the behavior continue please utilize session moderation or if it repeated or particularly malicious please make a [[Moderation]] ticket. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Components</span> = == <span lang="en" dir="ltr" class="mw-content-ltr">Forcing auto-disabled Components to be enabled</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Occasionally when using a component you may find that it disables itself. This usually means that something in the component setup or the slot that it was added to is problematic and would cause the component to fail to function. * Do not drive the enabled checkbox/field to true in these cases * Consider reporting a bug on our [https://github.com/Yellow-Dog-Man/Resonite-Issues Github]. These situations may be a problem that can be resolved. * Sometimes, these are actual miss-use of a component and may not be fixed. * Properties within components that start with _ may be changed or removed at anytime and should be avoided where possible. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Reference IDs / "Ref Hacking"</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> When building, it may be desirable to use [[Type:RefID|Reference IDs]] to get around certain restrictions or feature gaps that exist. This is often called [[Ref_Hacking|Reference hacking (Ref Hacking)]]. When doing this, keep the following in mind: * Reference IDs may change at any time. * Your use of them may break at any time. * Certain uses of References may be considered a security issue. ** If you notice something concerning please follow our [[Security]] Policy. * Some uses of References may allow for behavior that is against our [[Guidelines]] such as using references/ref hacking for harassment. ** If you have a concern, or notice a '''user breaking the [[Guidelines]]''' with or without Ref Hacking [https://moderation.resonite.com please submit a ticket]. ** Ref hacking by itself is NOT against the [[Guidelines]]. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Generally, you should use dedicated nodes and concepts instead such as: * The [[ProtoFlux:Allocating User|Allocating User]] Node * [[Reference_Type|Typed References]] and [[:Category:ProtoFlux:Core:Casts|Casts]] </div> <div lang="en" dir="ltr" class="mw-content-ltr"> If you find yourself continually needing to use a certain reference ID or path consider making a feature request on our [https://github.com/Yellow-Dog-Man/Resonite-Issues Github]. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Depending on the order of Components</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Components have an inherent order in which they appear in the inspector and are processed by Resonite. However, this order should be considered non-deterministic as they are internally stored in an unordered collection. There are ways to modify that order, but it is not guaranteed that existing objects will indefinitely preserve that order. Therefore, creations that depend on the order of components may break at any time. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> An example of this is utilizing multiple button actions on the same button event that depend on being processed in a specific order. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Instead: * Use ProtoFlux impulses. ProtoFlux is designed to be used for complex behaviors and program logic while components are generally intended for simple tasks. You can always depend on the order of operations in an impulse chain. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">ProtoFlux</span> = == <span lang="en" dir="ltr" class="mw-content-ltr">Using the ToString Node on complex data types</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> When using the ToString node on non-primitive data types(e.g. '''NOT''' float, int, double etc.), do not rely on the output of the node. It may change or be updated at any time. This includes things such as Data Types, Users, Slots, IFields, Sync, SyncRef etc. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Comparing strings for these items is brittle and may change with Updates. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Instead: * For Users, use [[:Category:ProtoFlux:Users:UserRoot|User Root Nodes]] * For Slots, use [[:Category:ProtoFlux:Slots|Slots]]. * For Types, use the Type nodes. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> If you find yourself continually needing to do this, consider making a feature request on our [https://github.com/Yellow-Dog-Man/Resonite-Issues Github]. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Using Fire On True etc. when there are better alternatives</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Several nodes in the [[:Category:ProtoFlux:Flow|Flow]] category can fire impulses when specific values change, e.g. [[Fire On True (ProtoFlux)|Fire On True]], [[Fire On False (ProtoFlux)|Fire On False]], [[Fire While True (ProtoFlux)|Fire While True]] etc. These can be very powerful and are fine to use where they're the best solution for a specific use case. However, there are a few common situations where they may seem like a good option, but there are actually much better and more efficient alternatives. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> In cases where e.g. Fire On True is appropriate, it is also advisable to provide a user value to the UpdatingUser input on these nodes rather than leaving it empty. </div> === <span lang="en" dir="ltr" class="mw-content-ltr">Buttons</span> === <div lang="en" dir="ltr" class="mw-content-ltr"> Often users want to make something happen, for example changing a value or causing some ProtoFlux to trigger, when a button is pressed. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Avoid: *Using the IsPressed bool field on the various button components and to providing that as the input to Fire On True in order to fire ProtoFlux impulses. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Instead: *Use the dedicated node for this purpose, [[Button Events (ProtoFlux)|Button Events]]. This is more efficient and impulses can be fired when various different things happen with the given button (Pressed, Pressing, Released etc.). **ProbablePrime has produced a short tutorial on how to use this node [https://www.youtube.com/watch?v=5xplINNXGco here]. *If you only want to perform a simple action based on a button press, such as changing a value, consider the components in the Common UI > Button Interactions category. These can often replace simple actions you might otherwise perform with ProtoFlux. **ProbablePrime has tutorials for several of these components - [https://www.youtube.com/watch?v=CuoqMWl9m9o ButtonValueCycle], [https://www.youtube.com/watch?v=EamDQP9DAfs ButtonValueShift], [https://www.youtube.com/watch?v=yXD3EKqKoWg ButtonValueSet], [https://www.youtube.com/watch?v=ufFli5Zn884 ButtonToggle]. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> * It ''is'' reasonable to use the IsPressed [[Types:Bool|bool]] for some effects which may be related to the button press state, such as driving the color of the button based on whether it is pressed or not. </div> === <span lang="en" dir="ltr" class="mw-content-ltr">Tools</span> === <div lang="en" dir="ltr" class="mw-content-ltr"> Grabbable items can be made equippable by adding the [[RawDataTool (Component)|Raw Data Tool]] component. This allows users to make custom tools, weapons, and gadgets which can be programmed to perform actions based on controller button presses much like the standard tools. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Avoid: *Using e.g. the Primary or Secondary [[Types:Bool|bool]] fields on the [[RawDataTool (Component)|Raw Data Tool]] component with Fire On True in order to fire ProtoFlux impulses. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Instead: *Use the dedicated node for this purpose, [[ProtoFlux:RawDataTool_Events|RawDataTool Events]]. This is more efficient and impulses can be fired when various different things happen when a [[RawDataTool (Component)|Raw Data Tool]] is equipped. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> * It ''is'' reasonable to use the Primary and Secondary [[Types:Bool|bool]] fields for some effects which may be related to when a user presses a controller button, such as driving the color of the equipped item based on whether the user is pressing primary fire. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Combining multiple nodes into the same slot</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> '''We do not recommend doing this for any reason.''' </div> <div lang="en" dir="ltr" class="mw-content-ltr"> When looking to optimize ProtoFlux, you might be worried about how many slots a set of ProtoFlux takes up and look to improve this by collapsing the nodes down into one slot. This usually needs a [[Plugins|plugin]] and is referred to as "Mono-Packing". </div> <div lang="en" dir="ltr" class="mw-content-ltr"> While this does cut down on the slot count of ProtoFlux, it makes the "mono-packed" ProtoFlux difficult to edit, read and understand. Additionally, it makes the ProtoFlux more difficult or not possible for Resonite to optimize for you in the future. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Instead: * Wait for additional optimizations and enhancements to ProtoFlux such as Nested Nodes * Consider looking into other optimization techniques and sources such as the [[Optimization Guidelines]]. * Wait for a native equivalent which may allow for seamless unpacking/packing * Remember that the slot count of an object does not necessarily dictate how performant it is. Performance comes from a variety of sources and Slot count is just one. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Inspectors</span> = == <span lang="en" dir="ltr" class="mw-content-ltr">Relying on/using the text found in inspectors</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Sometimes within inspectors, you might find some useful information, such as in the "Ref Editor" component's inspector. Including(but not limited to): * Running string comparisons/filtering/searching on Inspector UI component properties </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Relying on the text is fragile and may break. Inspectors are due for serious amounts of re-working due to a number of features such as collections, hard permissions, The UI Update, component access etc. These changes may change the text that is shown in the inspector windows. So relying on the text here to remain the same across these updates is not recommended. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Instead: * Wait for features such as component access which will allow you to use these fields directly rather than via string matching. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Graphics</span> = == <span lang="en" dir="ltr" class="mw-content-ltr">Material "Stacking"</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> When creating visual effects you can add multiple material slots to a Mesh Renderer to stack materials on-top of each other. This can have a great visual effect but '''it may break at a later date'''. Wherever possible, '''you should avoid doing this'''. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Instead: * Create multiple Mesh Renderers in the same location each with a different material. This will lead to the same effect. * Try experimenting with different material types available to you. * Consider opening a [https://github.com/Yellow-Dog-Man/Resonite-Issues feature request] for the effect you're looking at. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> * This does not affect meshes with multiple material slots. For example Avatars. It just refers to using the same material slot used multiple times. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> According to [[User:Geenz|Geenz]] during multiple office hours, [[Sauce]] release will probably break Material stacking. Alternative have also been disused to be implemented to Sauce (sometime ''after'' its initial release, as initial release will be parity of supported feature only), like Material Layering<ref>https://drive.google.com/file/d/1uCbzXDT_PXv_PgByuBAFcvVX1tTtSF53/view</ref> </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Switching DB URLs for Shaders</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> You may have noticed that you can swap URLs on [[Component:StaticShader|StaticShader]] assets with URLs from other StaticShader assets with varying degrees of visual impact. '''This will break at a later date''', particularly when custom shaders land with our upcoming graphics engine replacement. You should not rely on this for any sort of visual effect when producing your content. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Assets</span> = == <span lang="en" dir="ltr" class="mw-content-ltr">Using .7zbson/json/bson</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> Items, avatars, gadgets and even worlds are sometimes stored in a variety of files that are usually some form of JSON, Binary JSON or Compressed variants of them. There are a few methods available which allow you to gain access to these files in these forms and these files can then be used to import, edit, save, backup, etc. Items and Assets. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> While this may seem handy and desirable to use, it unfortunately '''may break at any time''' for a number of reasons: </div> <div lang="en" dir="ltr" class="mw-content-ltr"> * Our format or structure for these assets may change. <!-- * We may introduce/remove components within these files causing incompatibility.<sup>[Still true?]</sup> --> * These files often refer or cross-link to other files which may be removed or changed further increasing the chance of incompatibility. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> '''It is therefore not recommended to use this approach. It is not a supported feature.''' </div> <div lang="en" dir="ltr" class="mw-content-ltr"> If you have one of these files and it is not able to be imported in a newer version of Resonite, older versions will continue to work, so try using a version of Resonite released before the date the file was modified. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> When wanting to share content made on Resonite, use the [[ResonitePackage]] format which is made for this use, and avoids some of the issues mentioned. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Using Keyboard Components/Nodes to spawn items</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> By combining multiple Keyboard related components it is possible to trigger the spawning of an item from the cloud. This usually uses a URL which points to an Item or asset. While doing this can provide a good experience it is not something that is supported long term. This functionality may break or become non-functional at a later date. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> '''This functionality is commonly known as "Cloud Spawning" right now but it isn't'''. Cloud Spawning is actually a feature that Resonite plans to support in the future. </div> = <span lang="en" dir="ltr" class="mw-content-ltr">Inventory</span> = == <span lang="en" dir="ltr" class="mw-content-ltr">Long/Complex folder names</span> == <div lang="en" dir="ltr" class="mw-content-ltr"> When creating folders within your inventory, you may be tempted to use very long folder names or names which contain [https://en.wikipedia.org/wiki/ASCII_art ASCII Art]. Doing this is not recommended as it may not display the same on all platforms and will cause navigational and technical issues in some areas. Additionally when inventory management/searching is added in the future it may cause issues with searching or indexing your inventory. </div> <div lang="en" dir="ltr" class="mw-content-ltr"> Emojis and a few RTF Formatting tags(such as changing the color) are ok though. Just do not overuse them. </div> == <span lang="en" dir="ltr" class="mw-content-ltr">Sources</span> == <references />