Vega-strike-engine-source: Proposal: Streamline naming of binaries

Created on 8 May 2020  路  8Comments  路  Source: vegastrike/Vega-Strike-Engine-Source

On Windows, VS is habitually associated with Visual Studio and any binary that contains setup is considered an installation package of some sort.

And since Windows now supports arbitrary length names and isn't confined to the ye olde 8.3 format, I therefore propose renaming the Vega Strike binaries as follows:

Option A

  • vegastrike -> vegastrike (no change)
  • vegaserver -> vegastrike-server
  • vssetup-> vegastrike-settings

Another, simpler alternative (in terms of lines of code etc. changed) is:

Option B

  • vegastrike -> vegastrike (no change)
  • vegaserver -> vegaserver (no change)
  • vssetup-> vegasettings
bug enhancement

Most helpful comment

I'm working on a local branch where I've only renamed vssetup to vegasettings with some sed magic. It compiles already.

This keeps the current convention of vegastrike/vegaserver/vegasettings (where they all cleverly contain vegas) and makes for a less intrusive patch due to less changes.

Finally, the old vssetup program has two buttons with the labels:

  • Save Settings And View Readme
  • Save Settings and Exit

Both mention settings, which makes this naming scheme consistent. I also think the title of the vssetup/vegasettings program ought to be changed from:

Program Configuration - Vega Strike - Version x

to e.g.

Settings - Vega Strike - Version x

VOTE

Thumbs Up = Option B (the option I've described here)
Thumbs Down = Option A (use vegastrike-<suffix> names)

All 8 comments

agreed; we should change them. It might be good to make them parameters so that downstream projects compiling the engine can set:

  • executable names
  • configuration file

While this isn't as relevant on Linux (namely due to symlinks), on Windows/Mac (given how packaging on those platformsworks) is probably more important to do so that the executable can match the downstream game and not cause user confusion.

@BenjamenMeyer I totally agree about making this a parameter, though I think this needs some investigation about the consequences of such a change (binary size and such).

Out of curiosity, why are we considering this a bug?

@nabaco because of how the name effects Windows users

I'm working on a local branch where I've only renamed vssetup to vegasettings with some sed magic. It compiles already.

This keeps the current convention of vegastrike/vegaserver/vegasettings (where they all cleverly contain vegas) and makes for a less intrusive patch due to less changes.

Finally, the old vssetup program has two buttons with the labels:

  • Save Settings And View Readme
  • Save Settings and Exit

Both mention settings, which makes this naming scheme consistent. I also think the title of the vssetup/vegasettings program ought to be changed from:

Program Configuration - Vega Strike - Version x

to e.g.

Settings - Vega Strike - Version x

VOTE

Thumbs Up = Option B (the option I've described here)
Thumbs Down = Option A (use vegastrike-<suffix> names)

agreed; we should change them. It might be good to make them parameters so that downstream projects compiling the engine can set:

* executable names

* configuration file

While this isn't as relevant on Linux (namely due to symlinks), on Windows/Mac (given how packaging on those platformsworks) is probably more important to do so that the executable can match the downstream game and not cause user confusion.

Making the name configurable should be a separate PR IMHO. The diff is already big enough.

Note that I'm including some beginning edits to the man page in my local branch (the man page is completely out of date).

Fixing up the man page properly is a separate job best handled by the web assets team as it has lots of links to various resources etc. I did a quick clean-up, but someone else needs to get on this ASAP for 0.6.x.

@nabaco?

@ermo filed #113 for the manpage update; thanks for the find!

agreed; we should change them. It might be good to make them parameters so that downstream projects compiling the engine can set:

* executable names

* configuration file

While this isn't as relevant on Linux (namely due to symlinks), on Windows/Mac (given how packaging on those platformsworks) is probably more important to do so that the executable can match the downstream game and not cause user confusion.

Making the name configurable should be a separate PR IMHO. The diff is already big enough.

I'm find with that; let's make sure there's an issue filed to track it.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

LifWirser picture LifWirser  路  6Comments

BenjamenMeyer picture BenjamenMeyer  路  5Comments

BenjamenMeyer picture BenjamenMeyer  路  3Comments

stephengtuggy picture stephengtuggy  路  4Comments

viktorradnai picture viktorradnai  路  3Comments