Skip to content

Commit c7c985a

Browse files
tslashdtslashd
authored
Update README.md
1 parent 9450674 commit c7c985a

File tree

1 file changed

+164
-8
lines changed

1 file changed

+164
-8
lines changed

‎README.md‎

Lines changed: 164 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,173 @@
1-
# PLEASE DO NOT USE THIS, IT IS NOT COMPLETE AND IS AN ACTIVE WORK-IN-PROGRESS. ISSUES HAVE BEEN DISABLED FOR THIS REASON.
1+
# EVERYONE IS WELCOME TO BUILD UP ON THIS PROJECT AND CONTRIBUTE. ISSUES ARE DISABLED FOR THE TIME BEING
22
## Please join the Discord: https://discord.cs.surf
33

44
# Timer
55
Core plugin for CS2 Surf Servers. This project is aimed to be fully open-source with the goal of uniting all of CS2 surf towards building the game mode.
6+
<br>
7+
<details>
8+
<summary>Center HUD Speedometer</summary>
9+
<p>Different time formatting is available in the code base but not implemented for players to change it themselves. Refer to <strong>PlayerTimer.TimeFormatStyle</strong> in codebase</p>
10+
<ul>
11+
<li><strong>Map</strong>
12+
<p><em>Shown while player starts their Map Run from the map start zone (!r)</em></p>
13+
<details>
14+
<summary>Zone name + Start speed</summary>
15+
<p>Map Run mode:</p>
16+
<img src="https://i.imgur.com/IqUL067.png" alt="Map Start Zone">
17+
<img src="https://i.imgur.com/ITooApq.png" alt="Map Start Zone exit">
18+
</details>
19+
</li>
20+
<li><strong>Checkpoints</strong>
21+
<p><em>Only shown during Map Run after exiting a Checkpoint/Stage zone</em></p>
22+
<details>
23+
<summary>Zone name + Start speed</summary>
24+
<p>Checkpoint comparison:</p>
25+
<img src="https://i.imgur.com/recf26f.png" alt="Checkpoint Start Zone exit">
26+
</details>
27+
</li>
28+
<li><strong>Stages</strong>
29+
<p><em>Only shown while in Stage Mode, accessed through !s X or !stage X commands</em></p>
30+
<details>
31+
<summary>Zone name + Start speed</summary>
32+
<p>Stage Run mode:</p>
33+
<img src="https://i.imgur.com/Zi3HN2b.png" alt="Stages Start Zone">
34+
<img src="https://i.imgur.com/uYyumVJ.png" alt="Stages Start Zone exit">
35+
</details>
36+
</li>
37+
<li><strong>Bonuses</strong>
38+
<p><em>Only shown while in Bonus Mode, accessed through !b X or !bonus X commands</em></p>
39+
<details>
40+
<summary>Zone name + Start speed</summary>
41+
<p>Bonus Run mode:</p>
42+
<img src="https://i.imgur.com/Tlmdq9r.png" alt="Bonuses Start Zone">
43+
<img src="https://i.imgur.com/Rfm9qG4.png" alt="Bonuses Start Zone exit">
44+
</details>
45+
</li>
46+
</ul>
47+
</details>
648

7-
# Goals
49+
<details>
50+
<summary>Replays</summary>
51+
<p>Currently only accessible through the <strong>!spec</strong> command and cycling the players. Different time formatting is available in the code base but not implemented for players to change it themselves. Refer to <strong>PlayerTimer.TimeFormatStyle</strong> in codebase</p>
52+
<p>Replays are saved for all types of runs Map/Stage/Bonus (and future Styles) regardless if they are a World Record or just a Personal Best. No functionality is implemented for replaying PB replays yet, feel free to add and Pull Request it</p>
53+
<ul>
54+
<li><strong>Map</strong>
55+
<details>
56+
<summary>Spectating Map Replay</summary>
57+
<p>Map Run:</p>
58+
<img src="https://i.imgur.com/gZutBkS.png" alt="Map Run Replay">
59+
</details>
60+
</li>
61+
<li><strong>Stages</strong>
62+
<details>
63+
<summary>Spectating Stage Replay</summary>
64+
<p>Stage Run:</p>
65+
<img src="https://i.imgur.com/tL7kM1l.png" alt="Stages Run Replay">
66+
</details>
67+
</li>
68+
<li><strong>Bonuses</strong>
69+
<p>Bonus Replays are also available but no screenshots at the time of writing.</p>
70+
</li>
71+
<li><strong>Scoreboard</strong>
72+
<details>
73+
<summary>Currently available replays for the map</summary>
74+
<p>Scoreboard:</p>
75+
<img src="https://i.imgur.com/RNTTFgi.png" alt="Scoreboard showing all available Replays">
76+
</details>
77+
</li>
78+
</ul>
79+
</details>
80+
81+
82+
<details>
83+
<summary>Chat Messages</summary>
84+
<ul>
85+
<li><strong>Map Run</strong>
86+
<details>
87+
<summary>Improving a Record</summary>
88+
<p>Timer sends a chat message to all players upon a player beating the Map Record. Missing it sends a message only to the player:</p>
89+
<img src="https://i.imgur.com/ggCNjZ8.png" alt="Beating a Map record">
90+
</details>
91+
<details>
92+
<summary>Checkpoint Comparison</summary>
93+
<p>Timer sends a chat message the player comparing their PB checkpoint times with the current run (value in brackets after the time indicate the Speed):</p>
94+
<img src="https://i.imgur.com/ts4FfhY.png" alt="Checkpoints Comparison">
95+
</details>
96+
</li>
97+
<li><strong>Stage Records</strong>
98+
<details>
99+
<summary>New Stage record and improving Stage record</summary>
100+
<p>Timer sends a chat message to all players upon a player beating a Stage/Bonus/Map record. Different scenarios for missed/comparing times are also available and shown in chat but only to the player who is doing the run:</p>
101+
<img src="https://i.imgur.com/MNehNmv.png" alt="Stage Records and comparisons">
102+
</details>
103+
</li>
104+
<li><strong>QOL</strong>
105+
<details>
106+
<summary>Player Connected + Map Info (!mi / !tier)</summary>
107+
<p>LL is used for Local development and testing:</p>
108+
<img src="https://i.imgur.com/JtHwYnx.png" alt="Player Connected + Map Info">
109+
</details>
110+
<details>
111+
<summary>Player Rank</summary>
112+
<p>Displays the rank of the player on the current map:</p>
113+
<img src="https://i.imgur.com/4BXJjMv.png" alt="Player Rank">
114+
</details>
115+
</li>
116+
</ul>
117+
</details>
118+
119+
<details>
120+
<summary>Player Commands</summary>
121+
<p>We recommend making binds using the <strong>Console</strong> commands, chat commands may flood the server and not always work.</p>
122+
<ul>
123+
<li><strong>Saveloc (Practice Mode)</strong>
124+
<details>
125+
<summary>Save the current location</summary>
126+
<p>Chat: !saveloc</p>
127+
<p>Console: css_saveloc</p>
128+
</details>
129+
<details>
130+
<summary>Teleport to the last saved location</summary>
131+
<p>Chat: !tele</p>
132+
<p>Console: css_tele</p>
133+
</details>
134+
<details>
135+
<summary>Teleport to the previous saved location</summary>
136+
<p>Chat: !teleprev</p>
137+
<p>Console: css_teleprev</p>
138+
</details>
139+
<details>
140+
<summary>Teleport to the next saved location</summary>
141+
<p>Chat: !telenext</p>
142+
<p>Console: css_telenext</p>
143+
</details>
144+
</li>
145+
</ul>
146+
<ul>
147+
<li><strong>Spectate</strong>
148+
<details>
149+
<summary>Enter Spectator Mode</summary>
150+
<p>Chat: !spec</p>
151+
<p>Console: css_spec</p>
152+
</details>
153+
<details>
154+
<summary>Exiting Spectator Mode</summary>
155+
<p>No command currently available to go back to Play Mode (time may NOT be reset and you will loose your progress post entering Spectator Mode)</p>
156+
<p>Open team choosing menu <strong>M</strong> and select CT</p>
157+
</details>
158+
</li>
159+
</ul>
160+
</details>
161+
</br>
162+
163+
# Main list with tasks (more details can be found [here](https://github.com/tslashd/Timer/blob/dev/TODO)):
8164
*Note: This is not definitive/complete and simply serves as a reference for what we should try to achieve. Subject to change.*
9165
Bold & Italics = being worked on.
10-
11166
- [ ] Database
12-
- [ ] MySQL database schema ([W.I.P Design Diagram](https://dbdiagram.io/d/CS2Surf-Timer-DB-Schema-6560b76b3be1495787ace4d2))
167+
- [X] MySQL database schema ([Design Diagram](https://dbdiagram.io/d/CS2Surf-Timer-DB-Schema-6560b76b3be1495787ace4d2))
13168
- [ ] Plugin auto-create tables for easier setup?
14169
- [X] Base database class implementation
15-
- [ ] Maps
170+
- [X] Maps
16171
- [X] Implement map info object (DB)
17172
- [X] Zoning
18173
- [X] Hook zones from map triggers
@@ -31,12 +186,12 @@ Bold & Italics = being worked on.
31186
- [X] Load zone information automatically from standardised triggers: https://github.com/CS2Surf/Timer/wiki/CS2-Surf-Mapping
32187
- [X] Support for stages (`/rs`, teleporting with `/s`)
33188
- [X] Support for bonuses (`/rs`, teleporting with `/b #`)
34-
- [X] _**Start/End touch hooks implemented for all zones**_
189+
- [X] _Start/End touch hooks implemented for all zones
35190
- [ ] Surf configs
36191
- [X] Server settings configuration
37192
- [ ] Plugin configuration
38193
- [X] Database configuration
39-
- [ ] Timing
194+
- [X] Timing
40195
- [X] Base timer class implementation
41196
- [X] Base timer HUD implementation
42197
- [X] Prespeed measurement and display
@@ -50,7 +205,7 @@ Bold & Italics = being worked on.
50205
- [ ] Stretch goal: sub-tick timing
51206
- [ ] Player Data
52207
- [X] Base player class
53-
- [ ] **_Player stat classes_**
208+
- [ ] Player stat classes
54209
- [ ] Profile implementation (DB)
55210
- [ ] Points/Skill Groups (DB)
56211
- [ ] Player settings (DB)
@@ -65,3 +220,4 @@ Bold & Italics = being worked on.
65220
- [X] Bonus Record
66221
- [ ] Style implementation (SW, HSW, BW)
67222
- [ ] Paint (?)
223+
- [ ] API Integration (Repo can be found [here](https://github.com/CS2Surf/CS2-Surf-API))

0 commit comments

Comments
 (0)