rojo-rbx / rojo.space

Rojo website
https://rojo.space
MIT License
35 stars 44 forks source link

Add to the Docs that Unknown Instances will be automatically destroyed #96

Open jackprogramsjp opened 1 year ago

jackprogramsjp commented 1 year ago

Rojo clears any unknown instances in a location it syncs to by default.

You'll need to add $ignoreUnknownInstances to either the project file or a .meta.json for the location you're syncing to.

To some people, they may not know this when they start Rojo, because you cannot assume that they are going through every single part of the docs, as they are wanting to get started right away, so they may skip some essential steps. Basically, they risk losing data if they are not acknowledged about this property.

This happened to me, and I lost data because I put Instances in, assuming Rojo wouldn't delete them, but it did since they were unknown.

Not everyone, again, is going to read the whole docs, so just when they install it, it should be a reminder therefore they don't make the same mistakes I did. When someone installs Rojo, they will definitely go through the Getting Started part of the docs, but not in the Sync Details docs if they have no interest.

jackprogramsjp commented 1 year ago

Porting an Existing Game also works.

My motivation was that people might still feel ok to put unknown Instances in those specific areas when they create a new game, so they wouldn't know. It's just when people visit the site, Creating a New Game is something they would go first and check out, compared to other parts of the site, so it would be ok to tell them to make sure they know before creating a new game. Porting an Existing Game works, it's just that people who create new games may still not know about this unknown instance thingy.

I'm not sure about changing the default of the Unknown instance flag would solve everything, as some people might expect Rojo to not delete anything. It may be annoying to some people who want the Unknown instance flag to not destroy, but they can always set it up, and it's safer that way than actually defaulting it to destroying.

Dekkonot commented 1 year ago

There's a limit to how much we can document things. If someone is going to Creating a New Game but not the rest of the documentation, is that really our fault?

I'd say we should put a warning like this in sync details but given how often people go into the OSS server and ask, I don't know if the people who need it would read that page...