gtac-types 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [2025-2026] [RoxasYTB]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,435 @@
1
+ # gtac-types
2
+
3
+ > **GTA Connected** — TypeScript type definitions & runtime utilities for GTA Vice City server scripting (SpiderMonkey JS).
4
+
5
+ [![npm version](https://img.shields.io/npm/v/gtac-types)](https://www.npmjs.com/package/gtac-types)
6
+ [![License](https://img.shields.io/npm/l/gtac-types)](LICENSE)
7
+
8
+ ---
9
+
10
+ ## Table of Contents
11
+
12
+ - [Overview](#overview)
13
+ - [Installation](#installation)
14
+ - [Quick Start](#quick-start)
15
+ - [Package Structure](#package-structure)
16
+ - [Type Definitions](#type-definitions)
17
+ - [Element Types](#element-types)
18
+ - [Server-Side Functions](#server-side-functions)
19
+ - [Client-Side Functions](#client-side-functions)
20
+ - [Events](#events)
21
+ - [Natives](#natives)
22
+ - [Constants](#constants)
23
+ - [Runtime Utilities](#runtime-utilities)
24
+ - [Constants](#runtime-constants)
25
+ - [Utility Functions](#utility-functions)
26
+ - [Configuration](#configuration)
27
+ - [tsconfig.json](#tsconfigjson)
28
+ - [gtac.config.json](#gtacconfigjson)
29
+ - [CLI Usage](#cli-usage)
30
+ - [Development](#development)
31
+ - [Security](#security)
32
+ - [License](#license)
33
+
34
+ ---
35
+
36
+ ## Overview
37
+
38
+ `gtac-types` is the type definitions and runtime utility package for [GTA Connected](https://gtaconnected.com) server resources targeting **GTA Vice City** (`gta:vc`). It provides:
39
+
40
+ - **14 `.d.ts` type definition files** covering the full GTAC API surface
41
+ - Element hierarchy (Element, Entity, Physical, Ped, Player, Vehicle, etc.)
42
+ - Server-side functions (addEventHandler, addCommandHandler, gta, http, etc.)
43
+ - Client-side functions (gui, audio, font, bindKey, etc.)
44
+ - Fully typed event handler overloads (server + client)
45
+ - 300+ GTA Vice City native opcode signatures (natives.*)
46
+ - Vector math (Vec2, Vec3, Matrix4x4, NetFlags)
47
+ - XML document manipulation API
48
+ - Resource, Timer, Client interfaces
49
+ - Predefined constants (colours, element types, cheats, controls, etc.)
50
+ - **Runtime shared utilities** for use in SpiderMonkey server scripts
51
+ - **Build utilities** shared with `gtac-server-node`
52
+
53
+ All declarations are **global** — no `import`/`export` required. Designed for the SpiderMonkey JS engine used by GTAC where scripts are concatenated via `meta.xml`.
54
+
55
+ ---
56
+
57
+ ## Installation
58
+
59
+ ```bash
60
+ npm install --save-dev gtac-types
61
+ ```
62
+
63
+ Also install the build tool:
64
+
65
+ ```bash
66
+ npm install --save-dev esbuild gtac-server-node
67
+ ```
68
+
69
+ ---
70
+
71
+ ## Quick Start
72
+
73
+ ### 1. Create a project
74
+
75
+ ```bash
76
+ npx gtac-server init my-server
77
+ cd my-server
78
+ npm init -y
79
+ npm install --save-dev gtac-types esbuild gtac-server-node
80
+ ```
81
+
82
+ ### 2. Configure TypeScript
83
+
84
+ Create `tsconfig.json`:
85
+
86
+ ```json
87
+ {
88
+ "compilerOptions": {
89
+ "target": "ES2015",
90
+ "lib": ["ES2015"],
91
+ "strict": true,
92
+ "noEmit": true,
93
+ "skipLibCheck": true,
94
+ "moduleResolution": "node",
95
+ "types": ["gtac-types"]
96
+ },
97
+ "include": ["src/**/*.ts"]
98
+ }
99
+ ```
100
+
101
+ ### 3. Write server code
102
+
103
+ ```typescript
104
+ // src/my-resource/server/main.ts
105
+ addEventHandler("OnServerStart", () => {
106
+ console.log("Server started!");
107
+ });
108
+
109
+ addEventHandler("OnPlayerJoin", (client: Client) => {
110
+ message(client.name + " joined the server!", COLOUR_GREEN);
111
+
112
+ // Spawn a vehicle for them
113
+ const car = gta.createVehicle(141, 0, 0, 10, 0);
114
+ message("Infernus spawned at " + car.position);
115
+ });
116
+ ```
117
+
118
+ ### 4. Write client code
119
+
120
+ ```typescript
121
+ // src/my-resource/client/main.ts
122
+ bindEventHandler("OnResourceStart", thisResource, () => {
123
+ console.log("Client resource ready");
124
+
125
+ bindKey("F2", (event: KeyEvent) => {
126
+ if (!event.isUp()) {
127
+ message("F2 pressed!");
128
+ }
129
+ });
130
+ });
131
+ ```
132
+
133
+ ### 5. Build & run
134
+
135
+ ```bash
136
+ npx gtac-server build
137
+ npx gtac-server start
138
+ ```
139
+
140
+ ---
141
+
142
+ ## Package Structure
143
+
144
+ ```
145
+ gtac-types/
146
+ ├── src/
147
+ │ ├── index.d.ts # Entry point — references all .d.ts files
148
+ │ ├── types/
149
+ │ │ ├── element.d.ts # Element, Entity, Physical, Ped, Player, Vehicle, etc.
150
+ │ │ ├── event.d.ts # Event, CancellableEvent, KeyEvent
151
+ │ │ ├── misc.d.ts # Colour, element type, chat, camera constants
152
+ │ │ ├── resource.d.ts # Resource, Timer, Stream, console
153
+ │ │ ├── vec.d.ts # Vec2, Vec3, Matrix4x4, NetFlags
154
+ │ │ ├── xml.d.ts # XmlDocument, XmlElement, FileObject
155
+ │ │ ├── client/
156
+ │ │ │ ├── animations.d.ts # AnimationGroup enum, cheat/control/corona defines
157
+ │ │ │ ├── events.d.ts # Client-side event handler overloads
158
+ │ │ │ ├── functions.d.ts # Client-side functions (gui, audio, font, etc.)
159
+ │ │ │ ├── gta.d.ts # Client-side gta.* API (camera, AI, world, etc.)
160
+ │ │ │ └── natives.d.ts # 300+ GTA VC native opcode signatures
161
+ │ │ └── server/
162
+ │ │ ├── client.d.ts # Client interface (server-side)
163
+ │ │ ├── events.d.ts # Server-side event handler overloads
164
+ │ │ └── functions.d.ts # Server-side functions (gta, http, messaging, etc.)
165
+ │ └── runtime/
166
+ │ └── shared/
167
+ │ ├── constants.ts # Runtime constant values for server scripts
168
+ │ └── utils.ts # Runtime utility functions (dist3d, isAdmin, etc.)
169
+ ├── lib/
170
+ │ └── build.js # Build utilities (shared with gtac-server-node)
171
+ ├── templates/
172
+ │ ├── meta.xml # XML template for resources
173
+ │ └── tsconfig.json # TypeScript config template
174
+ ├── bin/
175
+ │ └── gtac.js # CLI delegates to gtac-server-node
176
+ ├── index.js # Package entry point
177
+ ├── LICENSE # Apache 2.0
178
+ └── README.md
179
+ ```
180
+
181
+ ---
182
+
183
+ ## Type Definitions
184
+
185
+ ### Element Types
186
+
187
+ The GTAC element hierarchy is fully typed with all properties and methods:
188
+
189
+ | Interface | Extends | Key Properties |
190
+ |-----------|---------|---------------|
191
+ | `Element` | — | id, type, name, position, rotation, dimension, parent, children |
192
+ | `Entity` | Element | heading, interior, matrix, alpha, bounding*, collisions* |
193
+ | `Building` | Entity | modelIndex |
194
+ | `Physical` | Entity | gravity, mass, velocity, turnVelocity |
195
+ | `Object` | Physical | modelIndex |
196
+ | `Ped` | Physical | armour, health, frozen, modelIndex, occupiedVehicle |
197
+ | `Player` | Ped | skin, team, money, weapons, vehicle, wantedLevel |
198
+ | `Vehicle` | Physical | colour, health, engineState, doorStates, isLocked |
199
+ | `Train` | Vehicle | isTrain, carriage, track |
200
+ | `Blip` | Element | — |
201
+ | `Marker` | Element | color, type, targetPosition, visible |
202
+ | `Pickup` | Element | amount, type, quantity, respawns |
203
+ | `Sphere` | Element | — |
204
+
205
+ ### Server-Side Functions
206
+
207
+ Typed in `types/server/functions.d.ts`:
208
+
209
+ - **Network Events**: `addNetworkHandler()`, `triggerNetworkEvent()`
210
+ - **Commands**: `addCommandHandler()`, `removeCommandHandler()`
211
+ - **Client Queries**: `getClient()`, `getClients()`, `getClientFromPlayerElement()`
212
+ - **Element Queries**: `getElementsByType()`, `getElementFromId()`, `destroyElement()`
213
+ - **Entity Counts**: `getPlayerCount()`, `getVehicleCount()`, `getBlips()`, etc.
214
+ - **Messaging**: `message()`, `messageClient()`, `messageAllExcept()`
215
+ - **Key Binding**: `bindKey()`, `unbindKey()`
216
+ - **Server Info**: `getServerPort()`, `getServerName()`, `setServerPassword()`
217
+ - **HTTP**: `http.get()`, `http.post()`, `http.createRequest()`
218
+ - **File I/O**: `fileOpen()`, `fileRead()`, `fileWrite()`, `fileDelete()`
219
+ - **Timing**: `platform.ticks`
220
+ - **Player Control**: `spawnPlayer()`, `fadeCamera()`
221
+
222
+ ### Client-Side Functions
223
+
224
+ Typed in `types/client/functions.d.ts`:
225
+
226
+ - **Player References**: `localPlayer`, `localClient`
227
+ - **GUI**: `gui.createElement()`, `gui.createWindow()`, `gui.createPage()`
228
+ - **Audio**: `audio.createSound()`, `audio.createSoundFromURL()`
229
+ - **Font**: `font.create()`, `lucasFont.createFont()`
230
+ - **Screen**: `screen.width`, `screen.height`, `getScreenResolution()`
231
+ - **Events**: `addNetworkHandler()`, `bindEventHandler()`, `removeEventHandler()`
232
+ - **Commands**: `addCommandHandler()`
233
+ - **Chat**: `chatInputEnabled()`, `chatWindowEnabled()`
234
+ - **Messaging**: `message()`
235
+ - **File I/O**: `openFile()`, `fileOpen()`, `fileRead()`
236
+ - **Keys**: `bindKey()`, `unbindKey()`
237
+ - **Colours**: `toColour()`
238
+
239
+ ### Events
240
+
241
+ Both server and client events are fully typed with per-event overloads:
242
+
243
+ **Server events** (`types/server/events.d.ts`):
244
+ `OnElementDestroy`, `OnElementStreamIn`, `OnElementStreamOut`, `OnPedCrouch`, `OnPedEnterVehicle`, `OnPedExitVehicle`, `OnPedFall`, `OnPedJump`, `OnPedSpawn`, `OnPedUncrouch`, `OnPedWasted`, `OnPickupCollected`, `OnPlayerChat`, `OnPlayerCommand`, `OnPlayerConnect`, `OnPlayerJoin`, `OnPlayerJoined`, `OnPlayerQuit`, `OnProcess`, `OnResourceStart`, `OnResourceStop`, `OnServerStart`
245
+
246
+ **Client events** (`types/client/events.d.ts`):
247
+ `OnBeforeProcessCamera`, `OnCameraProcess`, `OnChatOutput`, `OnCursorDown`, `OnCursorMove`, `OnCursorUp`, `OnElementDestroy`, `OnElementStreamIn`, `OnElementStreamOut`, `OnEntityProcess`, `OnFocus`, `OnLostFocus`, `OnGUIAnchorClick`, `OnGUIClick`, `OnBeforeDrawHUD`, `OnDrawHUD`, `OnDrawnHUD`, `OnCharacter`, `OnKeyDown`, `OnKeyUp`, `OnMouseConnected`, `OnMouseDisconnected`, `OnMouseDown`, `OnMouseUp`, `OnMouseMove`, `OnMouseLeave`, `OnMouseWheel`, `OnDisconnect`, `OnPed*` (18 events), `OnPickupCollected`, `OnProcess`, `OnPostRender2D`, `OnPreRender`, `OnRender`, `OnRender2D`, `OnRenderEffects`, `OnResourceReady`, `OnResourceStart`, `OnResourceStop`, `OnVehicleExplode`
248
+
249
+ ### Natives
250
+
251
+ `types/client/natives.d.ts` contains **300+ typed GTA Vice City native opcodes** organized in the `Natives` interface:
252
+
253
+ ```
254
+ CREATE_CAR, CREATE_CHAR, CREATE_OBJECT, CREATE_PICKUP, CREATE_PLAYER
255
+ DELETE_CAR, DELETE_CHAR, DELETE_OBJECT
256
+ SET_CAR_HEALTH, SET_CHAR_HEALTH, SET_PLAYER_HEALTH
257
+ GIVE_WEAPON_TO_CHAR, GIVE_WEAPON_TO_PLAYER
258
+ TASK_GO_TO_COORD, TASK_KILL_CHAR, TASK_PLAY_ANIM
259
+ PLAY_SOUND, ADD_EXPLOSION, ADD_BLIP_FOR_COORD
260
+ SET_WEATHER, SET_TIME_OF_DAY, SET_GRAVITY
261
+ SET_CAMERA_POSITION, POINT_CAMERA_AT_PLAYER
262
+ DISPLAY_TEXT, PRINT, PRINT_HELP
263
+ ... and 280+ more
264
+ ```
265
+
266
+ Also provides an index signature `[key: string]` for dynamic native calls.
267
+
268
+ ### Constants
269
+
270
+ `types/misc.d.ts` and `types/client/animations.d.ts` provide GTAC engine constants:
271
+
272
+ - **Colours**: `COLOUR_RED`, `COLOUR_GREEN`, `COLOUR_BLUE`, `COLOUR_WHITE`, etc.
273
+ - **Element Types**: `ELEMENT_PLAYER`, `ELEMENT_VEHICLE`, `ELEMENT_BLIP`, etc.
274
+ - **GTA Entity Types**: `ENTITYTYPE_BUILDING`, `ENTITYTYPE_VEHICLE`, etc.
275
+ - **Chat Types**: `CHAT_TYPE_CHAT`, `CHAT_TYPE_INFO`, `CHAT_TYPE_DEBUG`
276
+ - **Camera Fade**: `FADE_IN`, `FADE_OUT`
277
+ - **Animation Groups**: `AnimationGroup` enum (PED, VAN, BIKE, SNIPER, etc.)
278
+ - **Radar Sprites**: `RADAR_SPRITE_TOMMY`, `RADAR_SPRITE_GUN`, etc.
279
+ - **Cheats**: `CHEAT_FASTTIME`, `CHEAT_ALLDODOS`, `CHEAT_GREENLIGHTS`, etc.
280
+ - **Controls**: `CONTROL_INCAR_HANDBRAKE`, `CONTROL_ONFOOT_JUMP`, etc.
281
+ - **Cop Types**: `COPTYPE_COP`, `COPTYPE_FBI`, `COPTYPE_SWAT`, `COPTYPE_ARMY`
282
+ - **Explosion Types**: `EXPLOSION_GRENADE`, `EXPLOSION_ROCKET`, `EXPLOSION_CAR`
283
+ - **Vehicle Doors**: `AUTOMOBILEDOOR_DOOR_FRONT_LEFT`, etc.
284
+ - **Vehicle Panels**: `AUTOMOBILEPANEL_FRONT_LEFT`, etc.
285
+ - **Corona Textures**: `CORONATEXTURE_CORONA`, `CORONATEXTURE_CORONASTAR`, etc.
286
+ - **Flight Modes**: `FLIGHTMODE_HELICOPTER`, `FLIGHTMODE_HOVERCAR`, etc.
287
+
288
+ ---
289
+
290
+ ## Runtime Utilities
291
+
292
+ ### Runtime Constants
293
+
294
+ `src/runtime/shared/constants.ts` provides runtime values for use in server scripts:
295
+
296
+ ```typescript
297
+ var STREAM_INFINITE = 999999;
298
+ var BLIP_VISIBILITY_DIST = 300;
299
+ var FADE_MS = 300;
300
+ var DEATH_SEQUENCE_DELAY = 11000;
301
+ var RESPAWN_DELAY = 1500;
302
+ var IV_100 = 100;
303
+ var IV_1000 = 1000;
304
+ var SKIN_TOMMY_MIN = 161;
305
+ var SKIN_TOMMY_MAX = 171;
306
+ var CHEAT_SPAWN_DIST = 4;
307
+ var MISSION_TRIGGER_DIST = 2;
308
+ var PROGRESS_BG_COLOUR = 0xff1b5982;
309
+ var PROGRESS_FG_COLOUR = 0xff61c2f7;
310
+ var EXPLOSION_TYPE_CHEAT = 3;
311
+ // ... 100+ constants total
312
+ ```
313
+
314
+ ### Utility Functions
315
+
316
+ `src/runtime/shared/utils.ts` provides:
317
+
318
+ ```typescript
319
+ function dist3d(ax, ay, az, bx, by, bz): number
320
+ function setInfiniteStream(blip): void
321
+ function formatJSON(obj): string
322
+ function isAdmin(c): boolean
323
+ function isRoxasName(c): boolean
324
+ ```
325
+
326
+ These are compiled directly into your SpiderMonkey bundle — no import required.
327
+
328
+ ---
329
+
330
+ ## Configuration
331
+
332
+ ### tsconfig.json
333
+
334
+ ```json
335
+ {
336
+ "compilerOptions": {
337
+ "target": "ES2015",
338
+ "lib": ["ES2015"],
339
+ "strict": true,
340
+ "noEmit": true,
341
+ "skipLibCheck": true,
342
+ "moduleResolution": "node",
343
+ "types": ["gtac-types"]
344
+ },
345
+ "include": ["src/**/*.ts"]
346
+ }
347
+ ```
348
+
349
+ ### gtac.config.json
350
+
351
+ The `gtac-server-node` package uses this JSON configuration file:
352
+
353
+ ```json
354
+ {
355
+ "server": {
356
+ "name": "My GTAC Server",
357
+ "port": 23000,
358
+ "game": "gta:vc",
359
+ "maxPlayers": 32,
360
+ "password": ""
361
+ },
362
+ "resourcesDir": "resources",
363
+ "resources": [
364
+ {
365
+ "name": "my-resource",
366
+ "server": ["server", "shared"],
367
+ "client": ["client", "shared"],
368
+ "serverOrder": { "server": ["main"] },
369
+ "clientOrder": { "client": ["main"] }
370
+ }
371
+ ]
372
+ }
373
+ ```
374
+
375
+ ---
376
+
377
+ ## CLI Usage
378
+
379
+ `gtac-types` provides a CLI that delegates to `gtac-server-node`:
380
+
381
+ ```bash
382
+ npx gtac-types # Show help
383
+ npx gtac-types build # → tells you to use npx gtac-server build
384
+ npx gtac-server init # Scaffold a new project
385
+ npx gtac-server build # Build TypeScript → SpiderMonkey JS
386
+ npx gtac-server start # Launch the GTAC server
387
+ npx gtac-server dev # Init + build + start
388
+ ```
389
+
390
+ ---
391
+
392
+ ## Development
393
+
394
+ ```bash
395
+ # Clone
396
+ git clone https://github.com/RoxasYTB/gtac-types.git
397
+ cd gtac-types
398
+
399
+ # Install dependencies
400
+ npm install
401
+
402
+ # The .d.ts files are the source — no build step for types
403
+ # Edit src/runtime/ or lib/ as needed
404
+ ```
405
+
406
+ ### Publishing
407
+
408
+ ```bash
409
+ # Ensure clean files
410
+ npm pack --dry-run # Verify what will be published
411
+
412
+ # Bump version
413
+ npm version patch # or minor, major
414
+
415
+ # Publish
416
+ npm publish
417
+ ```
418
+
419
+ ---
420
+
421
+ ## Security
422
+
423
+ - No credentials, tokens, or secrets are included in the package
424
+ - The `files` field in `package.json` explicitly whitelists only necessary files
425
+ - `.gitignore` excludes `node_modules/`
426
+ - All type definitions are read-only declarations — no executable code that accesses external services
427
+ - The package is published publicly on npmjs under Apache 2.0
428
+
429
+ ---
430
+
431
+ ## License
432
+
433
+ Apache 2.0 — see [LICENSE](LICENSE).
434
+
435
+ Copyright 2025-2026 RoxasYTB.
package/bin/gtac.js ADDED
@@ -0,0 +1,35 @@
1
+ #!/usr/bin/env node
2
+ "use strict";
3
+
4
+ // gtac-types is now a types-only package.
5
+ // Use gtac-server for CLI commands (init, build, watch, export, start).
6
+ // This CLI provides type checking for existing projects.
7
+
8
+ const { join } = require("path");
9
+ const { existsSync, readFileSync } = require("fs");
10
+
11
+ const args = process.argv.slice(2);
12
+ const cmd = args[0];
13
+ const cwd = process.cwd();
14
+
15
+ function showHelp() {
16
+ console.log(`gtac-types — GTA Connected TypeScript type definitions
17
+
18
+ This package provides type definitions only.
19
+ For build/init/start commands, use: npx gtac-server <command>
20
+
21
+ npx gtac-server init Scaffold a new project
22
+ npx gtac-server build Build TS → SpiderMonkey JS
23
+ npx gtac-server export Export standalone resources (XML+JS)
24
+ npx gtac-server start Launch the GTAC server
25
+ `);
26
+ }
27
+
28
+ switch (cmd) {
29
+ case "init": case "build": case "watch": case "export": case "start": case "dev":
30
+ console.error("This package is types-only. Use the CLI from gtac-server-node:");
31
+ console.error(" npx gtac-server " + cmd);
32
+ process.exit(1);
33
+ default:
34
+ showHelp();
35
+ }
package/index.js ADDED
@@ -0,0 +1,6 @@
1
+ "use strict";
2
+
3
+ module.exports = {
4
+ build: require("./lib/build.js"),
5
+ VERSION: require("./package.json").version,
6
+ };