Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update env variables and protocol. #1130

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

digisomni
Copy link
Member

No description provided.

@digisomni digisomni added this to the 2021.2.0 Selene Release milestone Mar 29, 2021
@digisomni digisomni added this to In progress in 2022.1.0 Selene Release via automation Mar 29, 2021
@vegaslon
Copy link
Contributor

Do you consider this a necessary change? I consider it a unnecessary one that will cause problems in future with both using the vircadia name and compatibility with previous and feature forks. But if you feel this is absolutely necessary I suggest we change them to something that does not have vircadia in name to make it easier to identify what has been added to be different from the base code.

@digisomni
Copy link
Member Author

It's just more of the hifi-migration and branding. It helps because for example if you're using a High Fidelity version or an older build then the functionality can be separated out. You can define how you want High Fidelity VR to work or its successor "Vircadia" as we've changed a lot since then and continue to improve the system.

@daleglass
Copy link
Contributor

I think this can be done over time. For instance I think my #1127 may yet acquire an improvement for which it would make sense to change how the setting works. At that point, might as well rename it, since it'll be incompatible anyway.

@vegaslon
Copy link
Contributor

I think a case can be made that a change like this is not so much about branding and more about “becouse we can”, changing the variables to something specific means that the variable will have to be replicated for each fork working on as they each grow. Leaving you with a lot of environmental variable that all do the exact same thing.
As dale says until they each start differing in functionality from one fork to another there is really no reason to change them out of the blue.

@digisomni
Copy link
Member Author

The thing is that we have new developers joining up to work with Vircadia all the time. As such, they will eventually have to change it. It's easier to change things that will inevitably have to change later, now, rather than later.

e.g. breaking parts of the scripting API now would be better than breaking it later if at all possible because the trouble later is much greater.

That's why I'd rather get developers used to using the correct variable now.

If you have multiple installs on your computer/server then the worst that will happen is having +1 entry, a minor inconvenience. The benefit in this case is that future developers can code/implement with the mind that these are not liable to change.

@vegaslon
Copy link
Contributor

Still prefer they not ended up with vircadia in name none the less. It makes them too long to view in some env variable viewers.

@digisomni
Copy link
Member Author

Still prefer they not ended up with vircadia in name none the less. It makes them too long to view in some env variable viewers.

Do you know the specific character limits? Can try to figure out a good abbreviation.

@vegaslon
Copy link
Contributor

Suggest “vir” or “virc”. That would leave no trouble.

@daleglass
Copy link
Contributor

Hmm, I already used VIRCADIA_ elsewhere

@vegaslon
Copy link
Contributor

Sorry did not catch that earlier.. in this case it would just display as a huge block of vircadia in the viewers, and hence have to open each variable separately to find the correct one to edit.

@odysseus654
Copy link
Contributor

Note that the packaging scripts at https://github.com/vircadia/vircadia/blob/master/pkg-scripts/new-server will need to be adjusted with this.

@digisomni
Copy link
Member Author

I'll do another ctrl+f for that stuff before it's time to mergerino.

@digisomni digisomni changed the title 'HIFI_' -> 'VIRCADIA_' for env variables. Update env variables and protocol. Jun 2, 2021
@@ -49,8 +49,8 @@ macro(SET_PACKAGING_PARAMETERS)
set(PRODUCTION_BUILD 1)
set(BUILD_VERSION ${RELEASE_NUMBER})
set(BUILD_ORGANIZATION "Vircadia")
set(HIGH_FIDELITY_PROTOCOL "hifi")
set(HIGH_FIDELITY_APP_PROTOCOL "hifiapp")
set(HIGH_FIDELITY_PROTOCOL "vw")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am heavily against calling it vw:// as it will make is impossible for a user to ever find information about it on any big search engine. Problem is that someone that doesn't know Vircadia won't be able to find out what a vw:// link is for. Considering how little people use links like this nowadays, people that use Vircadia will most likely also not know what that is for. I am pretty sure that even on a hifi:// link, most fairly new users will go "What is this?".

Personally I am for vircadia:// as that leaves no room for interpretation and will yield good results on all major search engines.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does the 'w' stand for?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vw = virtual world. I gotta reapproach this, been a while since I've thought about the possibilities and implications to each.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what I thought, but aren't the "worlds" called domains?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but these are ultimately virtual worlds in a broader context. Domain is how we reference the servers or the worlds in a more Vircadia-focused context. However, to the outside world a virtual world would be the easiest way to explain what this all is, as they are in fact... virtual worlds. But vw:// is super compact and there is well, VW (the car company), so other options may be helpful to gain traction with in terms of SEO.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I would probably use "vircadia://" unless "vw://" is already used by other (ideally compatible) services. The same could be said for "hifi://". I don't think there's any harm in supporting an arbitrary number of protocol extension, but I would say "vircadia://" is a good place to start. My opinion.

@stale
Copy link

stale bot commented Apr 28, 2022

Hello! Is this still an issue?

@stale stale bot added the stale Issue / PR has not had activity label Apr 28, 2022
@stale stale bot removed the stale Issue / PR has not had activity label Oct 21, 2022
@stale
Copy link

stale bot commented Apr 19, 2023

Hello! Is this still an issue?

@stale stale bot added the stale Issue / PR has not had activity label Apr 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs CR (code review) stale Issue / PR has not had activity
Projects
Development

Successfully merging this pull request may close these issues.

None yet

7 participants