Add per-script and plugin versioning with changelog rules
This commit is contained in:
+100
@@ -0,0 +1,100 @@
|
||||
# Changelog
|
||||
|
||||
Changes are listed newest first, with an independent version for every individual
|
||||
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-12
|
||||
|
||||
### Initial versioning baseline
|
||||
|
||||
Established independent version `1.0.0` entries for each of the 14 scripts and
|
||||
both plugins from source commit
|
||||
`b508b6739b185d5048e8a8f96ccb16e429f1d37a`. This records the existing source state;
|
||||
earlier changes remain in Git history without retroactively assigned versions.
|
||||
The baseline introduces `versions.json`, this changelog, the README links and
|
||||
version policy, and the maintenance rules in `AGENTS.md`. It changes no game
|
||||
script or plugin behavior and requires no deployment by itself.
|
||||
|
||||
The component entries below summarize the existing functionality and deployment
|
||||
requirements for servers adopting this baseline. Version assignment does not
|
||||
indicate that a Windows build, live-game validation, or deployment was performed.
|
||||
|
||||
### T5 script baselines
|
||||
|
||||
Each row is a separately versioned script under `t5/scripts/`.
|
||||
|
||||
| Script | Version | Existing functionality |
|
||||
| --- | --- | --- |
|
||||
| `tws_t5_afk.gsc` | `1.0.0` | AFK toggle, protection, and indicator |
|
||||
| `tws_t5_common.gsc` | `1.0.0` | Shared configuration, helpers, commands, and player dispatchers |
|
||||
| `tws_t5_hud.gsc` | `1.0.0` | Timers, zombie count, and health display |
|
||||
| `tws_t5_join.gsc` | `1.0.0` | Immediate join for newcomers |
|
||||
| `tws_t5_leaderboard.gsc` | `1.0.0` | Map record announcements and `.leaders` command |
|
||||
| `tws_t5_lock.gsc` | `1.0.0` | Lobby lock at the configured round milestone |
|
||||
| `tws_t5_telemetry.gsc` | `1.0.0` | Game reports, durable boundary retries, balance and cumulative score |
|
||||
|
||||
- Compatibility: these initial script versions use `tws_t5_common.gsc` `1.0.0`;
|
||||
lobby lock also needs `tws_t5_hud.gsc` `1.0.0`. Telemetry and leaderboard use
|
||||
TWS T5 plugin `1.0.0`. Telemetry additionally requires
|
||||
Electric Cherry's match/sequence deduplication and `score_total` support;
|
||||
follow the [receiver and plugin rollout order](README.md#telemetry-delivery-and-rollout-t5-and-t6).
|
||||
Disabling telemetry by dvar does not remove its native linking requirements.
|
||||
- Deployment: follow the [T5 installation/upgrade instructions](t5/scripts/README.md#install--upgrade),
|
||||
copy the desired scripts and their required dependencies to
|
||||
`storage/t5/scripts/sp/`, and restart the map.
|
||||
Installing or updating the required plugin needs a full server-process restart.
|
||||
|
||||
### T6 script baselines
|
||||
|
||||
Each row is a separately versioned script under `t6/scripts/`, adapted to T6 APIs
|
||||
and map variants.
|
||||
|
||||
| Script | Version | Existing functionality |
|
||||
| --- | --- | --- |
|
||||
| `tws_t6_afk.gsc` | `1.0.0` | AFK toggle, protection, and indicator |
|
||||
| `tws_t6_common.gsc` | `1.0.0` | Shared configuration, helpers, commands, and player dispatchers |
|
||||
| `tws_t6_hud.gsc` | `1.0.0` | Timers, zombie count, and health display |
|
||||
| `tws_t6_join.gsc` | `1.0.0` | Immediate join for newcomers |
|
||||
| `tws_t6_leaderboard.gsc` | `1.0.0` | Map record announcements and `.leaders` command |
|
||||
| `tws_t6_lock.gsc` | `1.0.0` | Lobby lock at the configured round milestone |
|
||||
| `tws_t6_telemetry.gsc` | `1.0.0` | Game reports, durable boundary retries, balance and cumulative score |
|
||||
|
||||
- Compatibility: these initial script versions use `tws_t6_common.gsc` `1.0.0`;
|
||||
lobby lock also needs `tws_t6_hud.gsc` `1.0.0`. Telemetry and leaderboard use
|
||||
TWS T6 plugin `1.0.0`. Telemetry additionally requires
|
||||
Electric Cherry's match/sequence deduplication and `score_total` support;
|
||||
follow the [receiver and plugin rollout order](README.md#telemetry-delivery-and-rollout-t5-and-t6).
|
||||
Disabling telemetry by dvar does not remove its native linking requirements.
|
||||
- Deployment: follow the [T6 installation instructions](t6/scripts/README.md#install),
|
||||
copy the desired scripts and their required dependencies to
|
||||
`storage/t6/scripts/zm/`, and restart the map.
|
||||
Installing or updating the required plugin needs a full server-process restart.
|
||||
|
||||
### T5 plugin — 1.0.0
|
||||
|
||||
- Baseline: the TWS-maintained plugin, including configurable HTTP deadlines,
|
||||
status/timing diagnostics, and durable telemetry storage and response helpers.
|
||||
- Source covered: `t5/plugins/tws-t5-gsc-utils/` and the existing shared plugin
|
||||
build/dependency tooling under `tools/`.
|
||||
- Compatibility: provides the native functions used by `tws_t5_telemetry.gsc`
|
||||
`1.0.0` and `tws_t5_leaderboard.gsc` `1.0.0`.
|
||||
Upstream source and dependency pins remain in the plugin's `upstream.json`.
|
||||
Upstream binary downloads do not include these TWS changes.
|
||||
- Deployment: [build the x86 DLL on Windows](README.md#building-plugins), install
|
||||
`tws-t5-gsc-utils.dll` in `Plutonium/plugins/`, remove the old upstream DLL if
|
||||
present, and restart the full server process before loading dependent scripts.
|
||||
|
||||
### T6 plugin — 1.0.0
|
||||
|
||||
- Baseline: the matching TWS T6 plugin with configurable HTTP deadlines,
|
||||
status/timing diagnostics, and durable telemetry storage and response helpers.
|
||||
- Source covered: `t6/plugins/tws-t6-gsc-utils/` and the existing shared plugin
|
||||
build/dependency tooling under `tools/`.
|
||||
- Compatibility: provides the native functions used by `tws_t6_telemetry.gsc`
|
||||
`1.0.0` and `tws_t6_leaderboard.gsc` `1.0.0`.
|
||||
Upstream source and dependency pins remain in the plugin's `upstream.json`.
|
||||
Upstream binary downloads do not include these TWS changes.
|
||||
- Deployment: [build the x86 DLL on Windows](README.md#building-plugins), install
|
||||
`tws-t6-gsc-utils.dll` in `Plutonium/plugins/`, remove the old upstream DLL if
|
||||
present, and restart the full server process before loading dependent scripts.
|
||||
Reference in New Issue
Block a user