Skip to content

Commit 99c0028

Browse files
BliTz037BliTz037
committed
[ADD] FiveM's Schema for track server fivem with cfx code
1 parent 2cbe64c commit 99c0028

File tree

1 file changed

+149
-64
lines changed

1 file changed

+149
-64
lines changed

‎src/fivem/fivem.schema.ts

Lines changed: 149 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,92 @@ const fivemCfxResponse: SchemaObject & Partial<ReferenceObject> = {
114114
cfx: { type: 'string', description: "Server's CFX code" },
115115
online: { type: 'boolean', description: "Server's status. If the bool is true, the server is online" },
116116
EndPoint: { type: 'string', description: "Server's CFX code used as an Endpoint" },
117-
Data: { type: 'object', description: "Server's Data" },
117+
Data: {
118+
type: 'object', description: "Server's Data",
119+
properties: {
120+
clients: { type: 'number', description: "Number of Players connected" },
121+
gametype: { type: 'string', description: "Server game's type" },
122+
hostname: { type: 'string', description: "Server's hostname" },
123+
mapname: { type: 'string', description: "The name of the currently loaded map on the server" },
124+
sv_maxclients: { type: 'string', description: "Max number of players the server can host" },
125+
enhancedHostSupport: { type: 'boolean', description: "Enhanced host support" },
126+
requestSteamTicket: { type: 'string', description: "Server accept request steam ticket or not" },
127+
resources: {
128+
type: 'array',
129+
description: 'An array of all ressources on server',
130+
items: {
131+
type: 'string', description: "Ressource's name"
132+
},
133+
},
134+
server: { type: 'string', description: "Server's software used" },
135+
vars: {
136+
type: 'object',
137+
description: 'An object of several variables of server',
138+
},
139+
selfReportedClients: { type: 'number', description: "Number of Players connected" },
140+
players: {
141+
type: 'array',
142+
description: 'An array of all players connected on server',
143+
items: {
144+
type: 'object',
145+
properties: {
146+
endpoints: { type: 'string', description: "Player's endpoint", default: "127.0.0.1" },
147+
id: { type: 'number', description: "Player's ID" },
148+
identifiers: { type: 'array', description: "Player's identifiers", items: {} },
149+
name: { type: 'string', description: "Player's name" },
150+
ping: { type: 'number', description: "Player's ping" },
151+
},
152+
required: ['endpoints', 'id', 'identifiers', 'name', 'ping']
153+
},
154+
},
155+
ownerID: { type: 'number', description: "Server owner's ID" },
156+
private: { type: 'boolean', description: "Server is private or not" },
157+
fallback: { type: 'boolean', description: "Server is fallback or not" },
158+
connectEndPoints: {
159+
type: 'array',
160+
description: 'An array of all endpoints available to connect on server',
161+
items: {
162+
type: 'string', description: "Endpoint's address"
163+
},
164+
},
165+
upvotePower: { type: 'number', description: "Server's up vote power" },
166+
burstPower: { type: 'number', description: "Server's up burst power" },
167+
support_status: { type: 'string', description: "Support's status" },
168+
svMaxclients: { type: 'string', description: "Max number of players the server can host" },
169+
ownerName: { type: 'string', description: "Server owner's name" },
170+
ownerProfile: { type: 'string', description: "Server owner's profile on forum.cfx.re" },
171+
ownerAvatar: { type: 'string', description: "Server owner's avatar on forum.cfx.re" },
172+
lastSeen: { type: 'date', description: 'Date in ISO 8601 of last seen' },
173+
iconVersion: { type: 'number', description: "Server icon's version" }
174+
},
175+
required: [
176+
"clients",
177+
"gametype",
178+
"hostname",
179+
"mapname",
180+
"sv_maxclients",
181+
"enhancedHostSupport",
182+
"requestSteamTicket",
183+
"resources",
184+
"server",
185+
"vars",
186+
"selfReportedClients",
187+
"players",
188+
"ownerID",
189+
"private",
190+
"fallback",
191+
"connectEndPoints",
192+
"upvotePower",
193+
"burstPower",
194+
"support_status",
195+
"svMaxclients",
196+
"ownerName",
197+
"ownerProfile",
198+
"ownerAvatar",
199+
"lastSeen",
200+
"iconVersion"
201+
]
202+
},
118203
cacheTime: { type: 'number', description: "UNIX timestamp when the response was cached" },
119204
cacheExpire: { type: 'number', description: "UNIX timestamp when the response will be remove from cache. Around 5 minutes." }
120205
},
@@ -131,73 +216,73 @@ const fivemCfxResponse: SchemaObject & Partial<ReferenceObject> = {
131216
"online": true,
132217
"EndPoint": "45yo89",
133218
"Data": {
134-
"clients": 51,
135-
"gametype": "Minigames, Races, and Free Mode",
136-
"hostname": "^5Mega's Games (US): ^5Minigames ^9|^4 Sumo ^9|^1 Races ^9|^3 Freeroam",
137-
"mapname": "Various",
138-
"sv_maxclients": 2048,
139-
"enhancedHostSupport": true,
140-
"requestSteamTicket": "off",
141-
"resources": [
142-
"hardcap",
143-
"_cfx_internal",
144-
"ivpack"
145-
],
146-
"server": "FXServer-master SERVER v1.0.0.6228 win32",
147-
"vars": {
148-
"gamename": "gta5",
149-
"locale": "en-US",
150-
"onesync_enabled": "true",
151-
"sv_enforceGameBuild": "2802",
152-
},
153-
"selfReportedClients": 51,
154-
"players": [
155-
{
156-
"endpoint": "127.0.0.1:1234",
157-
"id": 82,
158-
"identifiers": [
159-
"license:9b510e4fd9ea81065ff5ff95dbec0f5cbbf9a70a",
160-
"discord:855375608708464651",
161-
"fivem:3966756",
162-
"license2:9b510e4fd9ea81065ff5ff95dbec0f5cbbf9a70a"
163-
],
164-
"name": "qwetti",
165-
"ping": 246
219+
"clients": 51,
220+
"gametype": "Minigames, Races, and Free Mode",
221+
"hostname": "^5Mega's Games (US): ^5Minigames ^9|^4 Sumo ^9|^1 Races ^9|^3 Freeroam",
222+
"mapname": "Various",
223+
"sv_maxclients": 2048,
224+
"enhancedHostSupport": true,
225+
"requestSteamTicket": "off",
226+
"resources": [
227+
"hardcap",
228+
"_cfx_internal",
229+
"ivpack"
230+
],
231+
"server": "FXServer-master SERVER v1.0.0.6228 win32",
232+
"vars": {
233+
"gamename": "gta5",
234+
"locale": "en-US",
235+
"onesync_enabled": "true",
236+
"sv_enforceGameBuild": "2802",
166237
},
167-
{
168-
"endpoint": "127.0.0.1:1234",
169-
"id": 106,
170-
"identifiers": [
171-
"license:b0b4d13aadbb79f8f4ab557aea934a9cd14c89ec",
172-
"xbl:2535435310984194",
173-
"live:1055518852711614",
174-
"discord:412397129638739978",
175-
"fivem:5839602",
176-
"license2:88ff199d67171af80acb08c04ce12115b8a45763"
177-
],
178-
"name": "ur cooked",
179-
"ping": 87
180-
}
181-
],
182-
"ownerID": 46512,
183-
"private": false,
184-
"fallback": false,
185-
"connectEndPoints": [
186-
"192.223.26.51:15000"
187-
],
188-
"upvotePower": 168,
189-
"burstPower": 0,
190-
"support_status": "supported",
191-
"svMaxclients": 2048,
192-
"ownerName": "MegaGTAVMaster",
193-
"ownerProfile": "https://forum.cfx.re/u/MegaGTAVMaster",
194-
"ownerAvatar": "https://forum.cfx.re/user_avatar/forum.cfx.re/megagtavmaster/128/2049360_2.png",
195-
"lastSeen": "2023-03-01T07:49:41.9488692Z",
196-
"iconVersion": -1146343723
238+
"selfReportedClients": 51,
239+
"players": [
240+
{
241+
"endpoint": "127.0.0.1:1234",
242+
"id": 82,
243+
"identifiers": [
244+
"license:9b510e4fd9ea81065ff5ff95dbec0f5cbbf9a70a",
245+
"discord:855375608708464651",
246+
"fivem:3966756",
247+
"license2:9b510e4fd9ea81065ff5ff95dbec0f5cbbf9a70a"
248+
],
249+
"name": "qwetti",
250+
"ping": 246
251+
},
252+
{
253+
"endpoint": "127.0.0.1:1234",
254+
"id": 106,
255+
"identifiers": [
256+
"license:b0b4d13aadbb79f8f4ab557aea934a9cd14c89ec",
257+
"xbl:2535435310984194",
258+
"live:1055518852711614",
259+
"discord:412397129638739978",
260+
"fivem:5839602",
261+
"license2:88ff199d67171af80acb08c04ce12115b8a45763"
262+
],
263+
"name": "ur cooked",
264+
"ping": 87
265+
}
266+
],
267+
"ownerID": 46512,
268+
"private": false,
269+
"fallback": false,
270+
"connectEndPoints": [
271+
"192.223.26.51:15000"
272+
],
273+
"upvotePower": 168,
274+
"burstPower": 0,
275+
"support_status": "supported",
276+
"svMaxclients": 2048,
277+
"ownerName": "MegaGTAVMaster",
278+
"ownerProfile": "https://forum.cfx.re/u/MegaGTAVMaster",
279+
"ownerAvatar": "https://forum.cfx.re/user_avatar/forum.cfx.re/megagtavmaster/128/2049360_2.png",
280+
"lastSeen": "2023-03-01T07:49:41.9488692Z",
281+
"iconVersion": -1146343723
197282
},
198283
"cacheTime": 1677657024,
199284
"cacheExpire": 1677657324
200-
}
285+
}
201286
}
202287

203288
export {

0 commit comments

Comments
 (0)