Improve command discovery and welcome messages

This commit is contained in:
2026-10-19 14:37:24 -04:00
parent e93182cd02
commit a457cbe539
12 changed files with 378 additions and 26 deletions
+75
View File
@@ -4,6 +4,81 @@ Changes are listed newest first, with an independent version for every individua
T5/T6 script and each native plugin. Current versions are recorded in
[versions.json](versions.json); see the [version policy](README.md#versioning).
## 2026-10-19
### Move the initial help hint to the private message area
| Component | Version | Affected source |
| --- | --- | --- |
| `tws_t5_common.gsc` | `1.7.1` | `t5/scripts/tws_t5_common.gsc` |
| `tws_t6_common.gsc` | `1.7.1` | `t6/scripts/tws_t6_common.gsc` |
| `tws_t5_leaderboard.gsc` | `1.4.1` | `t5/scripts/tws_t5_leaderboard.gsc` |
| `tws_t6_leaderboard.gsc` | `1.4.1` | `t6/scripts/tws_t6_leaderboard.gsc` |
- Send `Type .help for commands` once through the player's `iPrintLn`, matching
the location and formatting of the unknown-command reply. Keep each engine's
existing welcome readiness checks and five-second delay; print before waiting
for record data so a slow or failed fetch does not hold up the hint.
- Remove the welcome hint's HUD element, rendering state and optional argument
from common's record service. Manual replays and round reminders do not repeat
the message. Both T5 and T6 receive equivalent changes with their existing
namespaces and readiness differences preserved.
- Compatibility: no new dependency requirement. Leaderboard retains its common
`1.7.0+` requirement for command aliases; deploy common `1.7.1` with leaderboard
`1.4.1` for the updated source pair. Native plugins, backend and upstream pins
are unchanged.
- Validation: 179 leaderboard, 76 service HUD, 14 core HUD and 80 command discovery
checks passed. Fixtures verify readiness/delay, sender-specific native output,
a pending/failed record fetch and duplicate welcome dispatch. Changed T6
scripts compiled and assembled with the local upstream gsc-tool libraries.
Live Windows/Plutonium message placement and rendering remain unverified;
T5 has no gsc-tool backend. JSON/manifest coverage, matching versions/changelog,
local documentation links and `git diff --check` passed. No build of native
plugins or deployment was performed.
- Deployment: copy updated common and leaderboard scripts together for each
installed game and restart the map. No full server-process restart or other
deployment action is required.
### Make chat commands discoverable — issue #4
| Component | Version | Affected source |
| --- | --- | --- |
| `tws_t5_common.gsc` | `1.7.0` | `t5/scripts/tws_t5_common.gsc` |
| `tws_t6_common.gsc` | `1.7.0` | `t6/scripts/tws_t6_common.gsc` |
| `tws_t5_leaderboard.gsc` | `1.4.0` | `t5/scripts/tws_t5_leaderboard.gsc` |
| `tws_t6_leaderboard.gsc` | `1.4.0` | `t6/scripts/tws_t6_leaderboard.gsc` |
- Reply only to the sender of an unknown `.` or `!` command with
`Unknown command. Type .help for the list`. Compare the first word against
installed help registrations, including labels with arguments, so `.w 2000`
is recognized. Ordinary chat is unaffected; unregistered optional-module commands
receive the same fallback.
- Add case-insensitive `.info` and `.command` aliases for `.help`, and `.record`
for `.leaders`, without duplicate help entries. Keep existing exact-message
dispatch and module argument handling. Recognize the record alias only when
the leaderboard registers its command.
- Add `Type .help for commands` below the personal best on welcome, using one
private nonarchived HUD element. Retain help pause/resume and release the hint
on expiry, disconnect, game end or replacement by a manual replay. Manual
replays and compact round reminders retain their existing layouts.
- Apply the same changes to both engines, preserving their namespaces and
welcome readiness behavior. Extend portable checks and both games' live
validation instructions for unknown commands, `.w 2000`, every alias and
welcome-hint lifecycle behavior.
- Compatibility: leaderboard `1.4.0` requires matching common `1.7.0+` for the
optional welcome argument and alias recognition. Older common consumers
remain supported. No new native-plugin, backend or upstream dependency
requirement; unchanged scripts and plugins retain their versions.
- Validation: 80 command discovery, 78 service HUD, 14 core HUD, 177 leaderboard,
42 bank, 17 join, 23 telemetry, 76 lock and 47 AFK checks passed, plus both
moderation checks. Changed T6 scripts compiled and assembled using the local
upstream gsc-tool libraries. These are engine-shim/compiler checks; live
Windows/Plutonium chat delivery, privacy and rendering remain unverified.
T5 has no gsc-tool backend. No plugin build or deployment was performed.
- Deployment: copy updated common and leaderboard scripts together for each
installed game and restart the map. No full server-process restart or other
deployment action is required. See [command discovery](README.md#chat-command-discovery-t5-and-t6).
## 2026-10-18
### Show each player's personal map record on join and replay