1
1
# TMT2 - Tournament Match Tracker 2
2
2
3
+ [ ![ GitHub Actions Workflow Status] ( https://img.shields.io/github/actions/workflow/status/JensForstmann/tmt2/docker.yml?label=docker%20build )] ( https://github.com/JensForstmann/tmt2/actions/workflows/docker.yml )
3
4
[ ![ Docker Pulls] ( https://img.shields.io/docker/pulls/jensforstmann/tmt2 )] ( https://hub.docker.com/r/jensforstmann/tmt2 )
4
- [ ![ Docker Image Size (tag)] ( https://img.shields.io/docker/image-size/jensforstmann/tmt2/latest )] ( https://hub.docker.com/r/jensforstmann/tmt2 )
5
+ [ ![ Docker Image Size] ( https://img.shields.io/docker/image-size/jensforstmann/tmt2/latest?label=docker%20image%20size )] ( https://hub.docker.com/r/jensforstmann/tmt2 )
6
+
7
+
5
8
6
9
TMT is a tool that tracks/watches/observes a Counter-Strike 2 match.
7
10
@@ -56,6 +59,8 @@ Table of Contents:
56
59
- [ Install dependencies and run application in development mode] ( #install-dependencies-and-run-application-in-development-mode )
57
60
- [ Build docker image] ( #build-docker-image )
58
61
62
+
63
+
59
64
## Getting Started
60
65
61
66
TMT2 is available on docker hub: https://hub.docker.com/r/jensforstmann/tmt2
@@ -80,6 +85,8 @@ docker run --name tmt2 -d -p 8080:8080 -v /home/tmt2/storage:/app/backend/storag
80
85
81
86
The matches which are neither finished nor stopped will be loaded on application start.
82
87
88
+
89
+
83
90
### Create you first Match
84
91
85
92
After running the container you can open the web frontend: http://localhost:8080
@@ -98,6 +105,7 @@ either take a look at the `access_tokens.json` file
98
105
or take a look at the first lines of the log output (` docker logs tmt2 ` ).
99
106
100
107
108
+
101
109
### Ingame Chat Commands
102
110
103
111
While TMT watches a match the player ingame can use chat commands to communicate with TMT:
@@ -147,13 +155,16 @@ TMT_SAY_PREFIX="[TMT] "
147
155
```
148
156
149
157
158
+
150
159
## API
151
160
152
161
See [ ` backend/swagger.json ` ] ( backend/swagger.json ) .
153
162
You might want to copy its content and paste it into https://editor.swagger.io/ .
154
163
155
164
See also the [ ` examples ` ] ( examples ) folder.
156
165
166
+
167
+
157
168
## Security / Authentication
158
169
159
170
There are two types of authentication:
@@ -169,6 +180,8 @@ Both are used in client requests in the Authorization header with a "Bearer "-pr
169
180
Authorization: Bearer 2Mgog6ATqAs495NtUQUsph
170
181
...
171
182
183
+
184
+
172
185
### global access tokens
173
186
174
187
Global access tokens are persisted in the storage folder in the file ` access_tokens.json ` .
@@ -193,6 +206,8 @@ Example:
193
206
194
207
If the file does not exist at startup a new one with a single auto generated global access token will be created.
195
208
209
+
210
+
196
211
### match specific access tokens
197
212
198
213
Every match will have a ` tmtSecret ` property. This can be used in the same way as a global access token.
@@ -210,6 +225,8 @@ After starting the dev processes you can reach the backend & frontend at:
210
225
- Backend: http://localhost:8080
211
226
- Frontend: http://localhost:5173
212
227
228
+
229
+
213
230
## Docker
214
231
215
232
Docker is recommended as it's easy to use and doesn't require any other software to be installed
@@ -278,4 +295,6 @@ docker build -t tmt2 .
278
295
279
296
---
280
297
298
+
299
+
281
300
> This project is a complete rewrite of the former [ TMT] ( https://github.com/JensForstmann/CSGO-PHP-TournamentMatchTracker ) .
0 commit comments