Skip to content

Conversation

@ivanbaluta
Copy link
Collaborator

Part of #17125

If you are a new contributor to the project, do not use AI to generate pages. We will close any PR with a suspicion of AI usage.

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR contains at most 5 new pages.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Oct 21, 2025
@ivanbaluta ivanbaluta changed the title valheim: add page for the dedicated server valheim: add page Oct 21, 2025
@Managor
Copy link
Member

Managor commented Oct 21, 2025

Scroll down to "List of console commands" in the page and add some of those as an example. I think at least -port, -password, and -public should be reasonable to document.

@ivanbaluta
Copy link
Collaborator Author

Scroll down to "List of console commands" in the page and add some of those as an example. I think at least -port, -password, and -public should be reasonable to document.

Thanks for the feedback.
I've run into a technical dilemma here and would love your guidance.
"List of console commands" are arguments for the valheim_server.x86_64 binary. However, this binary cannot be run directly. It requires specific environment variables (like LD_LIBRARY_PATH) to be set first, which is handled by the official start_server.sh wrapper script.
If we document the binary directly with its flags (like -port, -password), the examples won't work for a user who just copies them, because the required environment will be missing.
This creates a conflict:

  1. We can document start_server.sh, which is runnable but hides the useful flags.
  2. We can document the binary valheim_server.x86_64 with its flags, but the examples won't be runnable out-of-the-box.

@Managor
Copy link
Member

Managor commented Oct 21, 2025

Does the .sh file not pass the arguments forward?

@ivanbaluta
Copy link
Collaborator Author

No, it doesn't. The script isn't designed to pass arguments; configuration is meant to be done by editing the script itself.

@Managor
Copy link
Member

Managor commented Oct 21, 2025

Well that sucks. Add that info as a second line in the header.

@Managor Managor merged commit 5ef2819 into tldr-pages:main Oct 25, 2025
4 checks passed
@ivanbaluta ivanbaluta deleted the add-page-for-valheim-server branch October 25, 2025 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants