Skip to content

Commit 9b770b2

Browse files
authored
Update README.md
1 parent e990beb commit 9b770b2

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

README.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,52 @@
11
# waw-split
2-
Customizable on-screen split timer for CoD:WaW (Plutonium)
2+
Customizable in-game on-screen timer for CoD:WaW (Plutonium only) with automatic round history and splits.
3+
4+
![image](https://github.com/user-attachments/assets/1dbf021c-0201-4617-a50a-199113c05bc8)
5+
6+
### About
7+
- Displays a variety of timer information on the in-game HUD (alternative to a third-party speedrun timer overlay like LiveSplit)
8+
- Works for ALL stock World at War maps on Plutonium
9+
- Complies with current ZWR world record rules: https://zwr.gg/rules/
10+
11+
### Features
12+
- Displays the following information:
13+
- Total game time - measured from start of game (screen fade-in)
14+
- Per-round time - measured from start of round n to start of round n+1
15+
- History of most recent round times
16+
- User-defined round milestone/split times - measured from start of game to start of round n
17+
- Fully automatic - All times are automatically started and split on round transitions
18+
- Following parameters can be specified by the user with the variables at the top of the script:
19+
- Enable/disable back-speed fix
20+
- Enable/disable timer variations individually
21+
- Individual control over color and transparency of all elements
22+
- Global position (ex: can be moved to accommodate web-cams or other overlays on screen)
23+
- Number of round history times to show (shows past 4 rounds by default)
24+
- Specific rounds to show splits/milestoens (10, 30, 50, 70, 100 by default)
25+
26+
### How to use
27+
- Read through the disclaimers below
28+
- Download waw-split.gsc
29+
- Place the file in the plutonium 'scripts' folder for the map you want to play:
30+
- `C:\users\YOUR_USERNAME\AppData\Local\Plutonium\storage\t4\raw\scripts\sp\MAP_NAME\waw-split.gsc`
31+
- Nach Der Untoten = `nazi_zombie_prototype`
32+
- Verruct = `nazi_zombie_asylum`
33+
- Shi No Numa = `nazi_zombie_sumpf`
34+
- Der Riese = `nazi_zombie_factory`
35+
- If you have any existing scripts in this folder, remove them
36+
- Play the map normally through Plutonium
37+
38+
### Disclaimers
39+
- It is my intent for this to be compatable for world-record attempts for ZWR. Based on the rules, it should be. Please read the rules for yourself and use your own discretion.
40+
- If you don't want to use the back-speed fix, it can be disabled at the top of the script. The backspeed client dvar will hold its state until changed again. If you want to stop using the script AND revert the backspeed fix, run the map once with "level.FIX_BACKSPEED = false" to restore the default values, then the script can be deleted. Or, use the console commands to revert the client dvars at any time.
41+
- Default position is top left on 16:9 resolutions. Different aspect ratios or resoutions may need to adjust the coordinates. Try (0, 0) if you can't see the timer at all.
42+
- Adding too many HUD elements can cause them to dissapear or glitch out. If you want to increase them beyond their default, do a test game to verify.
43+
- I have tested this script solo on all stock WaW maps. I have not confirmed if this works co-op, or if it works for custom maps, but I believe it should.
44+
- I have no reason to believe this would cause performance issues or crashes, but I have not tested it past round 30 myself. Use at your own risk for world-record attempts.
45+
- Please report any problems and feel free to provide suggestions for improvements
46+
47+
### Screenshots
48+
![image](https://github.com/user-attachments/assets/45c90196-bd33-4177-b848-5d1945c95739)
49+
![image](https://github.com/user-attachments/assets/4fb6adef-7d84-4271-ae30-22150d7efae9)
50+
![image](https://github.com/user-attachments/assets/1a8e5c44-3666-4ad9-a2bf-15dd497e8699)
51+
![image](https://github.com/user-attachments/assets/95339bd0-99a4-4970-9eb6-4e84d1e3bab5)
52+

0 commit comments

Comments
 (0)