Skip to content

[PATCH] README clarity, explicit port config, and npm audit fix - #6

Open
ficocelliguy wants to merge 1 commit into
Tanimodori:mainfrom
ficocelliguy:main
Open

ficocelliguy wants to merge 1 commit into
Tanimodori:mainfrom
ficocelliguy:main

Conversation

@ficocelliguy

Copy link
Copy Markdown
  • Improved the readme to be more clear as to which menus you are looking for (steam version has menus at the top, but only very limited remote API controls from there) and how to debug some issues

  • Added the port config explicitly to the viteburner config file, to make for easier debugging, and changed the suggested port to one that is less likely to collide with other apps

  • Ran npm audit fix to update dependencies and remove vulnerability warnings

@Tanimodori

Tanimodori commented Aug 16, 2023

Copy link
Copy Markdown
Owner

Hiding port option from default config is by the design of vite. The port 12525 is chosen because the bitburner-filesync package uses the same port so no problem will occur while switching. What application does the port 12525 collide with on your environment? Is there any reason that 31337 is chosen?

The deps are old now, I should definitely upgrade them.

@ficocelliguy

Copy link
Copy Markdown
Author

I was unable to find exactly what was colliding on port 12345 on my local, but picking any other port allowed me to successfully get a connection.

Even if 12345 has good reason to be kept, it would have taken me a lot less time debugging to discover where that number came from if it was in the project anywhere, so I think it is a good idea to have it on-hand (even if it is commented out as a default in the typescript tradition e.g. https://gist.github.com/ryanatkn/f1793abbe020e08b785cb56d4a712af1 )

@ficocelliguy

Copy link
Copy Markdown
Author

( I chose 31337 just to fit the Snow Crash / h4x0r theme of Bitburner, clearly its an elite/31337 game XD)

@Tanimodori

Copy link
Copy Markdown
Owner

The default port used by viteburner is written in README and the current one will shown on console so I don't think it will be difficult to find out which port viteburner is using. It may be a bit difficult to find where to change it though. I'll consider to add port option to the default config.

To detect using port by applications, you can use resmon on Windows or netstat on both Windows and Linux. I don't think it is worth changing the default port as it is not used by some commonly used software and it will bring unnecessary migration cost to the end users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants