Skip to content

fix(paper): clarify that catchup-ticks 1 is equivalent to 0 - #806

Open
spa77k wants to merge 2 commits into
PaperMC:mainfrom
spa77k:docs/catchup-ticks-minimum
Open

spa77k wants to merge 2 commits into
PaperMC:mainfrom
spa77k:docs/catchup-ticks-minimum

Conversation

@spa77k

@spa77k spa77k commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

Closes #784

Adds a sentence to the misc.catchup-ticks description in paper-global.yml saying that 1 has the same effect as 0, so the lowest value that enables the catchup is 2.

This documents the current behaviour, where the configured value is clamped with Math.max(1, catchupTicks.or(5)) in the tick loop. If the behaviour is changed in Paper instead, I am happy to update this to match.

Checked with pnpm run format:check locally.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
built with Refined Cloudflare Pages Action

⚡ Cloudflare Pages Deployment

Name Status Preview Last Commit
papermc-docs ✅ Ready (View Log) Visit Preview af73463

Comment thread src/config/paper/paper-global.yml Outdated
Comment on lines +249 to +250
"default" defaults to 5. Set to 0 to disable the catchup. A value of 1 has the same effect
as 0, so the lowest value that enables the catchup is 2.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
"default" defaults to 5. Set to 0 to disable the catchup. A value of 1 has the same effect
as 0, so the lowest value that enables the catchup is 2.
"default" defaults to 5. Set to 1 or lower to disable the catchup.

something feels iffy about this behavior though

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It’s really not. This is the amount of ticks that should happen during the next tick after a missed tick, so a number of 1, means the next tick should have to pass as it normally would (1 ticks in 1 tick), whereas a value of 5 would mean, 5 ticks have to pass in 1 tick. Atleast something around those lines

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

However I do think the option is poorly named or atleast implemented, on one hand it is correct according to the implementation catchup-ticks, but on the other hand its not immediately obvious to a server admin that has no knowledge of the internals and how they work.

This branch was successfully deployed

1 active deployment
Preview — af73463e Deployed Oct 8, 2026 by github-actions[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Mention that catchupTicks set to 1 are equivalent to set to 0 (disabled)

3 participants