Skip to content

Conversation

@sapbotgit
Copy link
Contributor

P.S. Had to re-push to check if i have errors in build system

Checklist

  • 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 is authored by me, or has been human-reviewed if it was created with AI or machine translation software.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

Reference issue: #17125

@CLAassistant
Copy link

CLAassistant commented Nov 2, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. new translation PRs translating a page(s) from English to other languages. review needed Prioritized PRs marked for reviews from maintainers. labels Nov 2, 2025
@TheRootDaemon
Copy link
Collaborator

Go through the style guide and correct the pages.

@sapbotgit
Copy link
Contributor Author

Go through the style guide and correct the pages.

What exactly wrong? I checked everything

@Managor
Copy link
Member

Managor commented Nov 2, 2025

Go through the style guide and correct the pages.

What exactly wrong? I checked everything

Start with the section "Example commands". This is not the syntax we use.

@acuteenvy acuteenvy changed the title Doom CLI Documentation doom: add page Nov 2, 2025
@tldr-bot
Copy link

tldr-bot commented Nov 3, 2025

The build for this PR failed with the following error(s) at commit
cbf517558592c1d414289539a0ed484a76716f4a:

pages.ru/common/doom.md:
Error: Parse error on line 8:
...m:`{{sourceport}}`.`- Запустить с вы
---------------------^
Expecting 'NEWLINE', 'TEXT', 'DASH', 'BACKTICK', got 'COMMAND_TEXT'
pages.ru/common/doom.md:7: TLDR103 Command example is missing its closing backtick

Please fix the error(s) and push again.

@sapbotgit
Copy link
Contributor Author

Finally all checks passed

@ivanbaluta
Copy link
Collaborator

Hi @sapbotgit, thank you for this contribution!
More Information Link: The current link points to the ZDoom wiki. I think a more general link like https://doomwiki.org/wiki/Source_port_parameters would be more useful for users of any source port.

@Managor
Copy link
Member

Managor commented Nov 4, 2025

I was thinking the same. If some user is a first timer to doom server hosting, the word "sourceport" might mean nothing to them. I agree with Ivan that the best solution is likely to include zandronum-server as the binary name if it's the most popular sourceport and add to the header "> zandronum-server can be replaced with any alternative sourceport"

@sapbotgit
Copy link
Contributor Author

I've been looking into the {{sourceport}} placeholder. Am I correct in understanding that the arguments for multiplayer or modding can differ significantly between various source ports (like GZDoom vs. Zandronum)?

Almost no. Even Zandronum supports -host, -join.

That leads to a more specific point I wanted to discuss. To follow up, if we were to use a specific binary like {{path/to/zandronum-server}} instead of the generic {{sourceport}}, would all the examples on the page still work as written? I'm bringing this up because this PR is linked to the "Let's document: Headless game servers" issue (#17125). My understanding is that Zandronum is a perfect fit for this, since zandronum-server is a true headless binary (no graphics, no client). On the other hand, ports like GZDoom are peer-to-peer, where the host is also a player rendering the game.

zandronum-server has custom cli parameters, and i think more wider and better definition will be {{path/to/doom}}. (Answer/react to me if agree)

@Managor
Copy link
Member

Managor commented Nov 4, 2025

I don't think the custom parameters matter if we don't document them.

@sapbotgit
Copy link
Contributor Author

I thinked something about currently documentating standart CLI parameters, then documenting in it's own page zandronum's.

@Managor
Copy link
Member

Managor commented Nov 4, 2025

Might be useful. But lets get this page done first.

@sapbotgit
Copy link
Contributor Author

Might be useful. But lets get this page done first.

So, what, {{path/to/doom}}? Or you got a better idea?

@Managor
Copy link
Member

Managor commented Nov 4, 2025

Just {{zandronum-server}}. It's a sourceport so it's available in package managers.

@sapbotgit
Copy link
Contributor Author

Just {{zandronum-server}}. It's a sourceport so it's available in package managers.

But what about others? Maybe add in description note that you can replace {{zandronum-server}} with your port? There are SOOO much other ports.

@Managor
Copy link
Member

Managor commented Nov 4, 2025

Yeah, that was my original idea as well. Add something like > `zandronum-server` can be replaced with any sourceport.

@sapbotgit
Copy link
Contributor Author

zandronum-server can be replaced with any sourceport.

One question, zandronum-server on hosting, just zandronum on joining or what?

@ivanbaluta
Copy link
Collaborator

And I believe using zandronum-server allows us to keep the page name as doom, as this would align with the guidelines in issue #17125. This way, we also avoid creating extra pages.

@Managor
Copy link
Member

Managor commented Nov 4, 2025

zandronum-server can be replaced with any sourceport.

One question, zandronum-server on hosting, just zandronum on joining or what?

Not sure if I understand the question.

@sapbotgit
Copy link
Contributor Author

zandronum-server can be replaced with any sourceport.

One question, zandronum-server on hosting, just zandronum on joining or what?

Not sure if I understand the question.

I mean, as i understand zandronum-server is headless. So, for CLI parameters on joining/playing the game i should just put zandronum (not headless, full port)?

@ivanbaluta
Copy link
Collaborator

zandronum-server can be replaced with any sourceport.

One question, zandronum-server on hosting, just zandronum on joining or what?

Let's simplify and stick to the goal of the "Headless game servers" issue (#17125).
Here is the plan:

  1. Focus only on the server-related commands.
  2. Replace all instances of {{sourceport}} with {{path/to/zandronum-server}}.

@sapbotgit
Copy link
Contributor Author

zandronum-server can be replaced with any sourceport.

One question, zandronum-server on hosting, just zandronum on joining or what?

Let's simplify and stick to the goal of the "Headless game servers" issue (#17125). Here is the plan:

1. Focus only on the server-related commands.

2. Replace all instances of {{sourceport}} with {{path/to/zandronum-server}}.

OK

@Managor
Copy link
Member

Managor commented Nov 4, 2025

We can always add more examples later. Better to focus the headless nature of gameservers first as they're more likely to be used from the terminal.

@sapbotgit
Copy link
Contributor Author

We can always add more examples later. Better to focus the headless nature of gameservers first as they're more likely to be used from the terminal.

ready

sapbotgit and others added 2 commits November 4, 2025 19:29
Co-authored-by: Managor <42655600+Managor@users.noreply.github.com>
@tldr-bot

This comment was marked as outdated.

Copy link
Collaborator

@ivanbaluta ivanbaluta left a comment

Choose a reason for hiding this comment

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

the placeholders in the Russian version should be translated, as per the project's style guide.

- `{{zandronum-server}} -iwad {{wad}} +map {{map}} -host {{players}}`
+ `{{zandronum-server}} -iwad {{wad}} +map {{карта}} -host {{число_игроков}}`
- `{{zandronum-server}} -iwad {{wad}} +map {{map}} -host {{players}} -deathmatch`
+ `{{zandronum-server}} -iwad {{wad}} +map {{карта}} -host {{число_игроков}} -deathmatch`

@Managor
Copy link
Member

Managor commented Nov 4, 2025

Highlight the line you want to change and then press the button next to "Preview" to suggest a change.

Не заметил недоперевод
@sapbotgit
Copy link
Contributor Author

the placeholders in the Russian version should be translated, as per the project's style guide.

- `{{zandronum-server}} -iwad {{wad}} +map {{map}} -host {{players}}`
+ `{{zandronum-server}} -iwad {{wad}} +map {{карта}} -host {{число_игроков}}`
- `{{zandronum-server}} -iwad {{wad}} +map {{map}} -host {{players}} -deathmatch`
+ `{{zandronum-server}} -iwad {{wad}} +map {{карта}} -host {{число_игроков}} -deathmatch`

fixed

@ivanbaluta ivanbaluta merged commit ecd5c9e into tldr-pages:main Nov 5, 2025
4 checks passed
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. new translation PRs translating a page(s) from English to other languages. review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants