Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ All notable changes to this project are documented here.

## [Unreleased]

## [0.2.6] - 2026-10-14

### Changed

- Interpret `tip_interval_ticks = 0` as an opt-in HUD default for players without saved preferences; manual enablement still works.
- Use `0` as the default in new configuration files without overwriting existing files or player settings.

## [0.2.5] - 2026-10-01

### Fixed
Expand Down
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ python -m build --wheel
The wheel is written to:

```text
dist/endstone_show_status-0.2.5-py3-none-any.whl
dist/endstone_show_status-0.2.6-py3-none-any.whl
```

To build both a wheel and source distribution:
Expand Down Expand Up @@ -192,17 +192,20 @@ Leaving `auth_password` empty keeps the page public. Set both
[status]
snapshot_interval_ticks = 20
tip_enabled = true
tip_interval_ticks = 20
tip_interval_ticks = 0
system_interval_seconds = 2.0
history_seconds = 300
chat_entries = 100
expose_chat = true
expose_players = true
```

The global `tip_enabled` switch remains authoritative. `tip_interval_ticks` is
the fallback display interval for players who have not saved a personal
preference.
The global `tip_enabled` switch remains authoritative. `tip_interval_ticks = 0`
means that players without a saved personal preference see no status HUD by
default, but they can enable it through `/showstatus`. A positive value specifies
the fallback refresh interval in ticks. Existing saved preferences take precedence.
When upgrading, change your existing `config.toml` to `tip_interval_ticks = 0` to
get the new default; the plugin does not overwrite existing configuration files.

### Player status display

Expand Down
6 changes: 3 additions & 3 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ python -m build --wheel
wheel 会写入:

```text
dist/endstone_show_status-0.2.5-py3-none-any.whl
dist/endstone_show_status-0.2.6-py3-none-any.whl
```

同时构建 wheel 和源码分发包:
Expand Down Expand Up @@ -175,15 +175,15 @@ auth_password = ""
[status]
snapshot_interval_ticks = 20
tip_enabled = true
tip_interval_ticks = 20
tip_interval_ticks = 0
system_interval_seconds = 2.0
history_seconds = 300
chat_entries = 100
expose_chat = true
expose_players = true
```

`tip_enabled` 仍然是管理员全局总开关;`tip_interval_ticks` 则作为尚未保存个人偏好的玩家的默认显示间隔。
`tip_enabled` 仍然是管理员全局总开关。`tip_interval_ticks = 0` 表示未保存个人设置的玩家默认不显示,仍可通过 `/showstatus` 手动开启;正数表示默认刷新间隔(单位 tick)。已保存的个人设置优先。升级时需手动将现有 `config.toml` 中的 `tip_interval_ticks` 改为 `0`,插件不会覆盖已有配置文件。

### 玩家状态显示设置

Expand Down
9 changes: 5 additions & 4 deletions config.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ class HTTPConfig:
class StatusConfig:
snapshot_interval_ticks: int = 20
tip_enabled: bool = True
tip_interval_ticks: int = 20
tip_interval_ticks: int = 0
system_interval_seconds: float = 2.0
history_seconds: int = 300
chat_entries: int = 100
Expand Down Expand Up @@ -78,8 +78,8 @@ class PluginConfig:
[status]
snapshot_interval_ticks = 20
tip_enabled = true
# Default display interval for players who have not saved a personal preference.
tip_interval_ticks = 20
# Default for players without a personal preference: 0 disables display; positive values are tick intervals.
tip_interval_ticks = 0
system_interval_seconds = 2.0
history_seconds = 300
chat_entries = 100
Expand Down Expand Up @@ -171,7 +171,8 @@ def _clamp(config: PluginConfig) -> None:
http.auth_password = http.auth_password[:1024]

status.snapshot_interval_ticks = min(200, max(10, status.snapshot_interval_ticks))
status.tip_interval_ticks = min(400, max(10, status.tip_interval_ticks))
if status.tip_interval_ticks != 0:
status.tip_interval_ticks = min(400, max(10, status.tip_interval_ticks))
status.system_interval_seconds = min(30.0, max(1.0, status.system_interval_seconds))
status.history_seconds = min(3600, max(60, status.history_seconds))
status.chat_entries = min(500, max(0, status.chat_entries))
Expand Down
4 changes: 2 additions & 2 deletions player_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
from typing import Final

CONTINUOUS_TIP_INTERVAL_TICKS: Final[int] = 5
DEFAULT_TIP_INTERVAL_TICKS: Final[int] = 20
DEFAULT_TIP_INTERVAL_TICKS: Final[int | None] = None
TIP_INTERVAL_OPTIONS: Final[tuple[tuple[str, int | None], ...]] = (
("持续显示", CONTINUOUS_TIP_INTERVAL_TICKS),
("每 1 秒", 20),
Expand Down Expand Up @@ -103,7 +103,7 @@ def load(self) -> str | None:
def get_tip_interval_ticks(
self,
player_id: str,
default: int = DEFAULT_TIP_INTERVAL_TICKS,
default: int | None = DEFAULT_TIP_INTERVAL_TICKS,
) -> int | None:
with self._lock:
return self._tip_intervals.get(player_id, default)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "endstone-show-status"
version = "0.2.5"
version = "0.2.6"
description = "Public Endstone server status page"
readme = "README.md"
license = "GPL-3.0-only"
Expand Down
5 changes: 3 additions & 2 deletions show_status.py
Original file line number Diff line number Diff line change
Expand Up @@ -319,8 +319,9 @@ def _handle_tip_settings_submit(self, player: Player, data: Any) -> None:
self._send_player_tip(player, self._tip_base_text())
self._next_tip_send[player_id] = time.monotonic() + interval_ticks / 20.0

def _default_tip_interval_ticks(self) -> int:
return max(5, int(self._plugin_config.status.tip_interval_ticks))
def _default_tip_interval_ticks(self) -> int | None:
ticks = self._plugin_config.status.tip_interval_ticks
return None if ticks == 0 else max(5, int(ticks))

def _tip_base_text(self) -> str:
with self.snapshot_lock:
Expand Down
54 changes: 54 additions & 0 deletions tests/test_config.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
from __future__ import annotations

import tempfile
import unittest
from pathlib import Path
from types import SimpleNamespace

from endstone_show_status.config import load_config
from endstone_show_status.player_settings import PlayerSettingsStore
from endstone_show_status.show_status import ShowStatus


class DefaultTipIntervalTest(unittest.TestCase):
def test_new_configuration_defaults_to_disabled_with_manual_enable_available(self) -> None:
with tempfile.TemporaryDirectory() as temp_dir:
config, _, error = load_config(Path(temp_dir))
self.assertIsNone(error)
self.assertTrue(config.status.tip_enabled)
self.assertEqual(config.status.tip_interval_ticks, 0)
plugin = SimpleNamespace(_plugin_config=config)
self.assertIsNone(ShowStatus._default_tip_interval_ticks(plugin))

settings = PlayerSettingsStore(Path(temp_dir) / "player_settings.json")
self.assertIsNone(settings.get_tip_interval_ticks("new", default=None))
settings.set_tip_interval_ticks("opted-in", 5)
self.assertEqual(settings.get_tip_interval_ticks("opted-in", default=None), 5)

def test_existing_positive_interval_remains_valid(self) -> None:
with tempfile.TemporaryDirectory() as temp_dir:
folder = Path(temp_dir)
(folder / "config.toml").write_text(
"[status]\ntip_interval_ticks = 20\n",
encoding="utf-8",
)
config, _, error = load_config(folder)
self.assertIsNone(error)
self.assertEqual(config.status.tip_interval_ticks, 20)
plugin = SimpleNamespace(_plugin_config=config)
self.assertEqual(ShowStatus._default_tip_interval_ticks(plugin), 20)

def test_zero_is_preserved_when_explicitly_configured(self) -> None:
with tempfile.TemporaryDirectory() as temp_dir:
folder = Path(temp_dir)
(folder / "config.toml").write_text(
"[status]\ntip_interval_ticks = 0\n",
encoding="utf-8",
)
config, _, error = load_config(folder)
self.assertIsNone(error)
self.assertEqual(config.status.tip_interval_ticks, 0)


if __name__ == "__main__":
unittest.main()
Loading