├── src
    └── core
    │   ├── client
    │       ├── startup.ts
    │       └── webview
    │       │   └── index.ts
    │   ├── shared
    │       └── webviewEvents.ts
    │   ├── resource.toml
    │   └── server
    │       ├── startup.ts
    │       └── utility
    │           ├── ipc.ts
    │           └── reconnect.ts
├── src-webviews
    ├── resource.toml
    ├── src
    │   ├── vite-env.d.ts
    │   ├── shims-react.d.ts
    │   ├── main.tsx
    │   ├── App.css
    │   ├── index.css
    │   ├── App.tsx
    │   └── assets
    │   │   └── react.svg
    ├── tsconfig.node.json
    ├── vite.config.ts
    ├── index.html
    ├── tsconfig.json
    └── public
    │   └── vite.svg
├── .github
    └── FUNDING.yml
├── .prettierrc
├── .gitignore
├── scripts
    ├── shared.js
    ├── copy.js
    ├── compiler.js
    ├── watch.js
    └── transform.js
├── server.toml
├── tsconfig.json
├── package.json
└── README.md


/src/core/client/startup.ts:
--------------------------------------------------------------------------------
1 | import './webview/index';


--------------------------------------------------------------------------------
/src-webviews/resource.toml:
--------------------------------------------------------------------------------
1 | type = 'asset-pack'
2 | client-files = [ '*' ]


--------------------------------------------------------------------------------
/src-webviews/src/vite-env.d.ts:
--------------------------------------------------------------------------------
1 | /// <reference types="vite/client" />
2 | 


--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 | 
3 | github: [stuyk]
4 | 


--------------------------------------------------------------------------------
/src/core/shared/webviewEvents.ts:
--------------------------------------------------------------------------------
1 | export const WebViewEvents = {
2 |     toggleVisibility: 'WebView:Toggle:Visibility',
3 | };
4 | 


--------------------------------------------------------------------------------
/.prettierrc:
--------------------------------------------------------------------------------
1 | {
2 |     "tabWidth": 4,
3 |     "printWidth": 120,
4 |     "singleQuote": true,
5 |     "semi": true,
6 |     "arrowParens": "always"
7 | }
8 | 


--------------------------------------------------------------------------------
/src/core/resource.toml:
--------------------------------------------------------------------------------
1 | type = 'js'
2 | main = 'server/startup.js'
3 | client-files = [ 'client/*', 'shared/*' ]
4 | client-main = 'client/startup.js'
5 | deps = []


--------------------------------------------------------------------------------
/src-webviews/src/shims-react.d.ts:
--------------------------------------------------------------------------------
1 | declare module 'alt' {
2 |     import '@altv/types-webview';
3 |     import '@altv/types-shared';
4 |     export default alt;
5 | }
6 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | node_modules
 2 | altv-server
 3 | resources
 4 | .vscode
 5 | *.dll
 6 | *.exe
 7 | update.json
 8 | modules/
 9 | data/
10 | *.log
11 | cache/
12 | crashdumps/
13 | package-lock.json
14 | ipc.txt


--------------------------------------------------------------------------------
/src-webviews/tsconfig.node.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "compilerOptions": {
 3 |     "composite": true,
 4 |     "skipLibCheck": true,
 5 |     "module": "ESNext",
 6 |     "moduleResolution": "bundler",
 7 |     "allowSyntheticDefaultImports": true
 8 |   },
 9 |   "include": ["vite.config.ts"]
10 | }
11 | 


--------------------------------------------------------------------------------
/src-webviews/src/main.tsx:
--------------------------------------------------------------------------------
 1 | import React from 'react'
 2 | import ReactDOM from 'react-dom/client'
 3 | import App from './App.tsx'
 4 | import './index.css'
 5 | 
 6 | ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render(
 7 |   <React.StrictMode>
 8 |     <App />
 9 |   </React.StrictMode>,
10 | )
11 | 


--------------------------------------------------------------------------------
/scripts/shared.js:
--------------------------------------------------------------------------------
 1 | import fs from 'fs-extra';
 2 | 
 3 | export function normalizeFilePath(filePath) {
 4 |     return filePath.replace(/\\/gm, '/');
 5 | }
 6 | 
 7 | export function writeToIpc(command) {
 8 |     fs.appendFileSync('ipc.txt', `\r\n${command}`);
 9 | }
10 | 
11 | export async function sleep(ms) {
12 |     return new Promise((resolve) => {
13 |         setTimeout(resolve, ms);
14 |     })
15 | }


--------------------------------------------------------------------------------
/src-webviews/vite.config.ts:
--------------------------------------------------------------------------------
 1 | import { defineConfig } from 'vite';
 2 | import react from '@vitejs/plugin-react-swc';
 3 | 
 4 | // https://vitejs.dev/config/
 5 | export default defineConfig({
 6 |     plugins: [react()],
 7 |     base: './',
 8 |     build: {
 9 |         outDir: '../resources/webviews',
10 |         emptyOutDir: true,
11 |         minify: 'esbuild',
12 |         reportCompressedSize: false,
13 |     },
14 | });
15 | 


--------------------------------------------------------------------------------
/src-webviews/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html lang="en">
 3 |   <head>
 4 |     <meta charset="UTF-8" />
 5 |     <link rel="icon" type="image/svg+xml" href="/vite.svg" />
 6 |     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 7 |     <title>Vite + React + TS</title>
 8 |   </head>
 9 |   <body>
10 |     <div id="root"></div>
11 |     <script type="module" src="/src/main.tsx"></script>
12 |   </body>
13 | </html>
14 | 


--------------------------------------------------------------------------------
/src-webviews/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "compilerOptions": {
 3 |         "target": "ESNext",
 4 |         "lib": ["DOM", "DOM.Iterable", "ESNext"],
 5 |         "module": "ESNext",
 6 |         "skipLibCheck": true,
 7 |         "moduleResolution": "bundler",
 8 |         "allowImportingTsExtensions": true,
 9 |         "resolveJsonModule": true,
10 |         "isolatedModules": true,
11 |         "noEmit": true,
12 |         "jsx": "react-jsx"
13 |     },
14 |     "include": ["src"],
15 |     "references": [{ "path": "./tsconfig.node.json" }]
16 | }
17 | 


--------------------------------------------------------------------------------
/server.toml:
--------------------------------------------------------------------------------
 1 | announce = false
 2 | 
 3 | description = 'test'
 4 | website = 'test.com'
 5 | gamemode = 'Freeroam'
 6 | 
 7 | language = 'en'
 8 | modules = [ 'js-module' ]
 9 | name = 'TestServer'
10 | players = 1024
11 | port = 7788
12 | tags = [ 'customTag1', 'customTag2', 'customTag3', 'customTag4' ]
13 | 
14 | resources = [
15 |     # Add mods here
16 |     'webviews',
17 |     'core' 
18 | ]
19 | 
20 | # Turn this off in production mode
21 | debug = true
22 | 
23 | # Leave host as 0.0.0.0, don't change it.
24 | host = '0.0.0.0'
25 | 
26 | [js-module]
27 | global-webcrypto = true
28 | global-fetch = true
29 | 
30 | [voice]
31 | bitrate = 64000


--------------------------------------------------------------------------------
/src/core/server/startup.ts:
--------------------------------------------------------------------------------
 1 | import './utility/ipc'; // Used to reconnect, do not remove.
 2 | import * as alt from 'alt-server';
 3 | 
 4 | import { connectLocalClient } from './utility/reconnect';
 5 | 
 6 | alt.log(`alt:V Server - Boilerplate Started`);
 7 | alt.on('playerConnect', handlePlayerConnect);
 8 | 
 9 | function handlePlayerConnect(player: alt.Player) {
10 |     alt.log(`[${player.id}] ${player.name} has connected to the server.`);
11 | 
12 |     player.model = 'mp_m_freemode_01';
13 |     player.spawn(36.19486618041992, 859.3850708007812, 197.71343994140625, 0);
14 |     alt.emitClient(player, 'log:Console', 'alt:V Server - Boilerplate Started');
15 | }
16 | 
17 | connectLocalClient();
18 | 


--------------------------------------------------------------------------------
/src-webviews/src/App.css:
--------------------------------------------------------------------------------
 1 | #root {
 2 |   max-width: 1280px;
 3 |   margin: 0 auto;
 4 |   padding: 2rem;
 5 |   text-align: center;
 6 | }
 7 | 
 8 | .logo {
 9 |   height: 6em;
10 |   padding: 1.5em;
11 |   will-change: filter;
12 |   transition: filter 300ms;
13 | }
14 | .logo:hover {
15 |   filter: drop-shadow(0 0 2em #646cffaa);
16 | }
17 | .logo.react:hover {
18 |   filter: drop-shadow(0 0 2em #61dafbaa);
19 | }
20 | 
21 | @keyframes logo-spin {
22 |   from {
23 |     transform: rotate(0deg);
24 |   }
25 |   to {
26 |     transform: rotate(360deg);
27 |   }
28 | }
29 | 
30 | @media (prefers-reduced-motion: no-preference) {
31 |   a:nth-of-type(2) .logo {
32 |     animation: logo-spin infinite 20s linear;
33 |   }
34 | }
35 | 
36 | .card {
37 |   padding: 2em;
38 | }
39 | 
40 | .read-the-docs {
41 |   color: #888;
42 | }
43 | 


--------------------------------------------------------------------------------
/tsconfig.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "compilerOptions": {
 3 |         "typeRoots": ["./node_modules/@types", "./node_modules/@altv"],
 4 |         "removeComments": true,
 5 |         "noUnusedLocals": false,
 6 |         "noUnusedParameters": false,
 7 |         "noImplicitReturns": true,
 8 |         "moduleResolution": "node",
 9 |         "resolveJsonModule": true,
10 |         "allowJs": true,
11 |         "emitDecoratorMetadata": true,
12 |         "experimentalDecorators": true,
13 |         "module": "esNext",
14 |         "target": "esNext",
15 |         "outDir": "./resources",
16 |         "rootDir": "./src",
17 |         "allowSyntheticDefaultImports": true,
18 |         "declaration": false
19 |     },
20 |     "include": ["./src/**/*.ts"],
21 |     "exclude": ["node_modules", "**/*.spec.ts", "resources", "**/*.json"]
22 | }
23 | 


--------------------------------------------------------------------------------
/scripts/copy.js:
--------------------------------------------------------------------------------
 1 | import fs from 'fs-extra'
 2 | import * as glob from 'glob';
 3 | import { normalizeFilePath } from './shared.js';
 4 | 
 5 | const startTime = Date.now();
 6 | const files = glob.sync(['src/core/**/*.!(ts)', 'src-webviews/**/*.toml'])
 7 | 
 8 | let filesCopied = 0;
 9 | for (let file of files) {
10 |     const filePath = normalizeFilePath(file);
11 | 
12 |     if (filePath.includes('src/')) {
13 |         const finalPath = filePath.replace('src/', 'resources/');
14 |         fs.copySync(filePath, finalPath, { overwrite: true });
15 |     }
16 | 
17 |     if (filePath.includes('src-webviews')) {
18 |         const finalPath = filePath.replace('src-webviews/', 'resources/webviews/');
19 |         fs.copySync(filePath, finalPath, { overwrite: true });
20 |     }
21 | 
22 |     filesCopied += 1;
23 | }
24 | 
25 | console.log(`${filesCopied} Files Moved | ${Date.now() - startTime}ms`);


--------------------------------------------------------------------------------
/src/core/server/utility/ipc.ts:
--------------------------------------------------------------------------------
 1 | import * as alt from 'alt-server';
 2 | import fs from 'fs';
 3 | 
 4 | const FILE_NAME = 'ipc.txt';
 5 | 
 6 | function onChange() {
 7 |     const content = fs.readFileSync(FILE_NAME, { encoding: 'utf-8' });
 8 |     const contents = content.split('\n');
 9 |     const lastLine = contents[contents.length - 1].replace(/\n/g, '');
10 | 
11 |     switch (lastLine) {
12 |         case 'kick-all':
13 |             alt.log(`Invoking IPC Event 'kick-all'`);
14 |             alt.Player.all.forEach((player) => {
15 |                 player.kick('Restarting Server');
16 |             });
17 |             break;
18 |     }
19 | }
20 | 
21 | if (alt.debug) {
22 |     if (fs.existsSync(FILE_NAME)) {
23 |         fs.rmSync(FILE_NAME);
24 |     }
25 | 
26 |     fs.writeFileSync(FILE_NAME, '');
27 |     fs.watch(FILE_NAME, onChange);
28 |     alt.log(`Listening for IPC Events in Debug Mode`);
29 | }
30 | 


--------------------------------------------------------------------------------
/scripts/compiler.js:
--------------------------------------------------------------------------------
 1 | import fs from 'fs-extra'
 2 | import * as glob from 'glob';
 3 | import swc from '@swc/core'
 4 | import { normalizeFilePath } from './shared.js';
 5 | 
 6 | const SWC_CONFIG = {
 7 |     jsc: {
 8 |         parser: {
 9 |             syntax: 'typescript',
10 |             dynamicImport: true,
11 |             decorators: true,
12 |         },
13 |         transform: {
14 |             legacyDecorator: true,
15 |             decoratorMetadata: true,
16 |         },
17 |         target: 'es2020',
18 |     },
19 |     sourceMaps: false,
20 | };
21 | 
22 | const startTime = Date.now();
23 | const filesToCompile = glob.sync('./src/core/**/*.ts');
24 | 
25 | if (fs.existsSync('resources/core')) {
26 |     fs.rmSync('resources/core', { force: true, recursive: true });
27 | }
28 | 
29 | 
30 | let compileCount = 0;
31 | for (let i = 0; i < filesToCompile.length; i++) {
32 |     const filePath = normalizeFilePath(filesToCompile[i]);
33 |     const finalPath = filePath.replace('src/', 'resources/').replace('.ts', '.js');
34 |     const compiled = swc.transformFileSync(filePath, SWC_CONFIG);
35 |     fs.outputFileSync(finalPath, compiled.code, { encoding: 'utf-8' });
36 |     compileCount += 1;
37 | }
38 | 
39 | console.log(`${compileCount} Files Built | ${Date.now() - startTime}ms`);;
40 | 


--------------------------------------------------------------------------------
/src/core/client/webview/index.ts:
--------------------------------------------------------------------------------
 1 | import * as alt from 'alt-client';
 2 | import * as native from 'natives';
 3 | import { WebViewEvents } from '../../shared/webviewEvents';
 4 | 
 5 | const F2_KEY = 113;
 6 | let view: alt.WebView;
 7 | let isFocused = false;
 8 | 
 9 | export function focusWebView() {
10 |     if (isFocused) {
11 |         view.unfocus();
12 |         view.emit(WebViewEvents.toggleVisibility, false);
13 |         alt.showCursor(false);
14 |         alt.toggleGameControls(true);
15 |         native.triggerScreenblurFadeOut(100);
16 |         isFocused = false;
17 |     } else {
18 |         view.focus();
19 |         view.emit(WebViewEvents.toggleVisibility, true);
20 |         alt.showCursor(true);
21 |         alt.toggleGameControls(false);
22 |         native.triggerScreenblurFadeIn(100);
23 |         isFocused = true;
24 |     }
25 | }
26 | 
27 | alt.on('keydown', async (keyCode: number) => {
28 |     if (keyCode !== F2_KEY) {
29 |         return;
30 |     }
31 | 
32 |     if (view) {
33 |         focusWebView();
34 |         return;
35 |     }
36 | 
37 |     view = new alt.WebView('http://assets/webviews/index.html');
38 |     await new Promise((resolve: (...args: any[]) => void) => {
39 |         view.once('load', resolve);
40 |     });
41 | 
42 |     focusWebView();
43 | });
44 | 


--------------------------------------------------------------------------------
/src/core/server/utility/reconnect.ts:
--------------------------------------------------------------------------------
 1 | const enum Status {
 2 |     Loading = 'LOADING',
 3 |     MainMenu = 'MAIN_MENU',
 4 |     DownloadingFiles = 'DOWNLOADING_FILES',
 5 |     Connecting = 'CONNECTING',
 6 |     InGame = 'IN_GAME',
 7 |     Disconnecting = 'DISCONNECTING',
 8 |     Error = 'ERROR',
 9 | }
10 | 
11 | const RETRY_DELAY = 2500;
12 | const DEBUG_PORT = 9223;
13 | 
14 | async function getLocalClientStatus(): Promise<Status | null> {
15 |     try {
16 |         const response = await fetch(`http://127.0.0.1:${DEBUG_PORT}/status`);
17 |         return response.text() as unknown as Status;
18 |     } catch (error) {
19 |         return null;
20 |     }
21 | }
22 | 
23 | export async function connectLocalClient(): Promise<void> {
24 |     const status = await getLocalClientStatus();
25 |     if (status === null) {
26 |         return;
27 |     }
28 | 
29 |     if (status !== Status.MainMenu && status !== Status.InGame) {
30 |         setTimeout(() => connectLocalClient(), RETRY_DELAY);
31 |     }
32 | 
33 |     try {
34 |         await fetch(`http://127.0.0.1:${DEBUG_PORT}/reconnect`, {
35 |             method: 'POST',
36 |             body: 'serverPassword', // only needed when a password is set in the server.toml
37 |         });
38 |     } catch (error) {
39 |         console.log(error);
40 |     }
41 | }
42 | 


--------------------------------------------------------------------------------
/src-webviews/public/vite.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="31.88" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 257"><defs><linearGradient id="IconifyId1813088fe1fbc01fb466" x1="-.828%" x2="57.636%" y1="7.652%" y2="78.411%"><stop offset="0%" stop-color="#41D1FF"></stop><stop offset="100%" stop-color="#BD34FE"></stop></linearGradient><linearGradient id="IconifyId1813088fe1fbc01fb467" x1="43.376%" x2="50.316%" y1="2.242%" y2="89.03%"><stop offset="0%" stop-color="#FFEA83"></stop><stop offset="8.333%" stop-color="#FFDD35"></stop><stop offset="100%" stop-color="#FFA800"></stop></linearGradient></defs><path fill="url(#IconifyId1813088fe1fbc01fb466)" d="M255.153 37.938L134.897 252.976c-2.483 4.44-8.862 4.466-11.382.048L.875 37.958c-2.746-4.814 1.371-10.646 6.827-9.67l120.385 21.517a6.537 6.537 0 0 0 2.322-.004l117.867-21.483c5.438-.991 9.574 4.796 6.877 9.62Z"></path><path fill="url(#IconifyId1813088fe1fbc01fb467)" d="M185.432.063L96.44 17.501a3.268 3.268 0 0 0-2.634 3.014l-5.474 92.456a3.268 3.268 0 0 0 3.997 3.378l24.777-5.718c2.318-.535 4.413 1.507 3.936 3.838l-7.361 36.047c-.495 2.426 1.782 4.5 4.151 3.78l15.304-4.649c2.372-.72 4.652 1.36 4.15 3.788l-11.698 56.621c-.732 3.542 3.979 5.473 5.943 2.437l1.313-2.028l72.516-144.72c1.215-2.423-.88-5.186-3.54-4.672l-25.505 4.922c-2.396.462-4.435-1.77-3.759-4.114l16.646-57.705c.677-2.35-1.37-4.583-3.769-4.113Z"></path></svg>


--------------------------------------------------------------------------------
/src-webviews/src/index.css:
--------------------------------------------------------------------------------
 1 | :root {
 2 |     font-family: Inter, system-ui, Avenir, Helvetica, Arial, sans-serif;
 3 |     line-height: 1.5;
 4 |     font-weight: 400;
 5 | 
 6 |     color-scheme: light dark;
 7 |     color: rgba(255, 255, 255, 0.87);
 8 |     background-color: transparent;
 9 | 
10 |     font-synthesis: none;
11 |     text-rendering: optimizeLegibility;
12 |     -webkit-font-smoothing: antialiased;
13 |     -moz-osx-font-smoothing: grayscale;
14 |     -webkit-text-size-adjust: 100%;
15 | }
16 | 
17 | .hide {
18 |     display: none;
19 |     opacity: 0;
20 | }
21 | 
22 | a {
23 |     font-weight: 500;
24 |     color: #646cff;
25 |     text-decoration: inherit;
26 | }
27 | a:hover {
28 |     color: #535bf2;
29 | }
30 | 
31 | body {
32 |     margin: 0;
33 |     display: flex;
34 |     place-items: center;
35 |     min-width: 320px;
36 |     min-height: 100vh;
37 | }
38 | 
39 | h1 {
40 |     font-size: 3.2em;
41 |     line-height: 1.1;
42 | }
43 | 
44 | button {
45 |     border-radius: 8px;
46 |     border: 1px solid transparent;
47 |     padding: 0.6em 1.2em;
48 |     font-size: 1em;
49 |     font-weight: 500;
50 |     font-family: inherit;
51 |     background-color: #1a1a1a;
52 |     cursor: pointer;
53 |     transition: border-color 0.25s;
54 | }
55 | button:hover {
56 |     border-color: #646cff;
57 | }
58 | button:focus,
59 | button:focus-visible {
60 |     outline: 4px auto -webkit-focus-ring-color;
61 | }
62 | 
63 | @media (prefers-color-scheme: light) {
64 |     :root {
65 |         color: #213547;
66 |         background-color: #ffffff;
67 |     }
68 |     a:hover {
69 |         color: #747bff;
70 |     }
71 |     button {
72 |         background-color: #f9f9f9;
73 |     }
74 | }
75 | 


--------------------------------------------------------------------------------
/src-webviews/src/App.tsx:
--------------------------------------------------------------------------------
 1 | import { useEffect, useState } from 'react';
 2 | import reactLogo from './assets/react.svg';
 3 | import viteLogo from '/vite.svg';
 4 | import './App.css';
 5 | import { WebViewEvents } from '../../src/core/shared/webviewEvents';
 6 | 
 7 | function App() {
 8 |     const [count, setCount] = useState(0);
 9 |     const [isVisible, setVisibility] = useState(false);
10 | 
11 |     function invokeEvent() {
12 |         console.log('Test!');
13 | 
14 |         if ('alt' in window) {
15 |             alt.emit('emitToClient');
16 |         }
17 |     }
18 | 
19 |     useEffect(() => {
20 |         if (!alt) {
21 |             return;
22 |         }
23 | 
24 |         alt.on(WebViewEvents.toggleVisibility, (shouldBeVisible: boolean) => {
25 |             setVisibility(shouldBeVisible);
26 |         });
27 |     }, []);
28 | 
29 |     return (
30 |         <div className={isVisible ? '' : 'hide'}>
31 |             <div>
32 |                 <a href="https://vitejs.dev" target="_blank">
33 |                     <img src={viteLogo} className="logo" alt="Vite logo" />
34 |                 </a>
35 |                 <a href="https://react.dev" target="_blank">
36 |                     <img src={reactLogo} className="logo react" alt="React logo" />
37 |                 </a>
38 |             </div>
39 |             <h1>Vite + React</h1>
40 |             <div className="card">
41 |                 <button onClick={() => setCount((count) => count + 1)}>count is {count}</button>
42 |                 <button onClick={invokeEvent}>Test!</button>
43 |                 <p>
44 |                     Edit <code>src/App.tsx</code> and save to test HMR
45 |                 </p>
46 |             </div>
47 |             <p className="read-the-docs">Click on the Vite and React logos to learn more</p>
48 |         </div>
49 |     );
50 | }
51 | 
52 | export default App;
53 | 


--------------------------------------------------------------------------------
/package.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "altv-quickstart-ts",
 3 |     "version": "5.0.1",
 4 |     "description": "TypeScript with alt:V Made Easy",
 5 |     "scripts": {
 6 |         "[-] Server Deployment Commands (They All Do Different Things)": "",
 7 |         "build": "node ./scripts/compiler.js && npx vite build ./src-webviews && node ./scripts/copy.js && node ./scripts/transform.js",
 8 |         "windows": "npm run build && altv-server.exe",
 9 |         "linux": "npm run build && ./altv-server",
10 |         "dev": "node ./scripts/watch.js",
11 |         "[-] Utility": "",
12 |         "react-dev": "npx vite ./src-webviews --clearScreen=false --host=localhost --port=3000",
13 |         "update": "altv-pkg d release"
14 |     },
15 |     "author": "stuyk",
16 |     "license": "ISC",
17 |     "devDependencies": {
18 |         "@altv/types-client": "^2.5.3",
19 |         "@altv/types-natives": "^1.5.3",
20 |         "@altv/types-server": "^2.6.6",
21 |         "@altv/types-shared": "^1.4.2",
22 |         "@altv/types-webview": "^1.0.5",
23 |         "@swc/cli": "^0.1.62",
24 |         "@swc/core": "^1.3.52",
25 |         "@types/node": "^18.15.11",
26 |         "@types/react": "^18.0.28",
27 |         "@types/react-dom": "^18.0.11",
28 |         "@vitejs/plugin-react-swc": "^3.0.0",
29 |         "altv-pkg": "^2.0.11",
30 |         "fs-extra": "^11.1.1",
31 |         "glob": "^10.2.1",
32 |         "react": "^18.2.0",
33 |         "react-dom": "^18.2.0",
34 |         "typescript": "latest",
35 |         "watcher": "^2.2.2"
36 |     },
37 |     "prettier": {
38 |         "tabWidth": 4,
39 |         "semi": true,
40 |         "printWidth": 120,
41 |         "arrowParens": "always",
42 |         "singleQuote": true
43 |     },
44 |     "type": "module",
45 |     "dependencies": {
46 |         "vite": "^4.3.1"
47 |     },
48 |     "engines": {
49 |         "node": ">=18"
50 |     }
51 | }


--------------------------------------------------------------------------------
/scripts/watch.js:
--------------------------------------------------------------------------------
 1 | 
 2 | import { spawnSync, spawn, ChildProcess } from 'node:child_process'
 3 | import Watcher from 'watcher';
 4 | import { writeToIpc, sleep } from './shared.js';
 5 | 
 6 | const fileWatcher = new Watcher(['./src', './src-webviews'], { recursive: true, renameDetection: true });
 7 | const isWindows = process.platform === "win32";
 8 | const altvProcessName = isWindows ? './altv-server.exe' : './altv-server'
 9 | 
10 | /** @type {ChildProcess} */
11 | let childProcess = undefined
12 | let rebootDebounce = Date.now() + 0;
13 | 
14 | async function compiler() {
15 |     console.log(`Starting Compile`)
16 |     const webviewProcess = spawn(isWindows ? 'npx.cmd' : 'npx', ['vite', 'build', './src-webviews'], { stdio: 'inherit' })
17 | 
18 |     spawnSync('node', ['./scripts/compiler.js'], { stdio: 'inherit' })
19 |     spawnSync('node', ['./scripts/transform.js'], { stdio: 'inherit' })
20 | 
21 |     await new Promise((resolve) => {
22 |         webviewProcess.on('exit', resolve);
23 |     })
24 | 
25 |     spawnSync('node', ['./scripts/copy.js'], { stdio: 'inherit' })
26 |     console.log(`Compile Complete`)
27 | }
28 | 
29 | async function reboot() {
30 |     if (rebootDebounce > Date.now()) {
31 |         return;
32 |     }
33 | 
34 |     rebootDebounce = Date.now() + 1000;
35 |     writeToIpc('kick-all');
36 |     await sleep(250);
37 |     if (childProcess) {
38 |         try {
39 |             childProcess.kill();
40 |         } catch (err) { }
41 | 
42 |         await new Promise((resolve) => {
43 |             const interval = setInterval(() => {
44 |                 if (!childProcess.killed) {
45 |                     childProcess.kill();
46 |                     return;
47 |                 }
48 | 
49 |                 childProcess = undefined
50 |                 clearInterval(interval);
51 |                 resolve();
52 |             }, 100);
53 |         })
54 |     }
55 | 
56 |     await compiler();
57 |     childProcess = spawn(altvProcessName, { stdio: 'inherit' })
58 | }
59 | 
60 | function start() {
61 |     fileWatcher.on('change', reboot);
62 |     reboot();
63 | }
64 | 
65 | start();


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <p align="center" style="font-size: 26px">
 2 | 	<b>Typescript Boilerplate for alt:V with React - v5.0.1</b>
 3 | </p>
 4 | <p align="center">
 5 | 	<img src="https://thumbs.gfycat.com/FabulousFlawlessLamb-size_restricted.gif" width="350" title="hover text">
 6 | </p>
 7 | 
 8 | <p align="center">
 9 | 	<sup>Super Fast Compilation</sup>
10 | </p>
11 | 
12 | > [!IMPORTANT]  
13 | > This boilerplate will no longer be updated.
14 | > Consider using [Rebar Framework](https://rebarv.com/) for more up-to-date practices, and a plugin system.
15 | 
16 | # Features
17 | 
18 | A simple Typescript Boilerplate that builds incredibly fast using the [SWC Library](https://github.com/swc-project/swc).
19 | 
20 | - Auto Refresh Server
21 | - Auto Compile TypeScript Files
22 | - Auto Download Resources
23 | - Single Resource Code Support
24 | - Fastest Auto Reconnect Time on Recompile
25 | - Built-in React for WebViews
26 | 
27 | # Installation
28 | 
29 | * [Install NodeJS 18+](https://nodejs.org/en/download/current/)
30 | * [Install GIT](https://git-scm.com/downloads)
31 | 
32 | ## Clone the Repository
33 | 
34 | Use the command below in any terminal, command prompt, etc.
35 | 
36 | ```sh
37 | git clone https://github.com/Stuyk/altv-typescript-react
38 | ```
39 | 
40 | ## Install the Repository
41 | 
42 | Use the command below in any terminal, command prompt, etc.
43 | 
44 | ```sh
45 | cd altv-typescript-react
46 | npm install
47 | ```
48 | 
49 | ## Download Server Files
50 | 
51 | Use the command below in any terminal, command prompt, etc. This will download all necessary server files from an additional package used by this project.
52 | 
53 | ```sh
54 | npm run update
55 | ```
56 | 
57 | ## Start Production Server (Windows)
58 | 
59 | Run this command to run the server in production mode.
60 | 
61 | ```
62 | npm run windows
63 | ```
64 | 
65 | ## Start Production Server (Linux)
66 | 
67 | Run this command to run the server in production mode.
68 | 
69 | ```
70 | npm run linux
71 | ```
72 | 
73 | ## Start Developer Server
74 | 
75 | Run this command to run the server in development mode.
76 | 
77 | This will automatically reconnect your alt:V Client if you have `debug` mode turned on.
78 | 
79 | ```
80 | npm run dev
81 | ```
82 | 
83 | ## WebView Previews
84 | If you need to modify the WebView and want to work out of the browser, use the following command.
85 | 
86 | ```
87 | npm run react-dev
88 | ```
89 | 
90 | ## End Server Runtime
91 | 
92 | Use the key combination `ctrl + c` to kill your server in your terminal, command prompt, etc.
93 | 
94 | ## How to Add Mods, and New Resources
95 | 
96 | Always add your already compiled resources & mods into the `resources` folder.
97 | 


--------------------------------------------------------------------------------
/scripts/transform.js:
--------------------------------------------------------------------------------
 1 | import path from 'path';
 2 | import * as glob from 'glob';
 3 | import fs from 'fs';
 4 | 
 5 | /**
 6 |  * What does this do?
 7 |  * Appends `.js` to the end of all imports that are not 'nodejs' imports.
 8 |  * This is required for alt:V
 9 |  */
10 | 
11 | const resourcePath = path.join(process.cwd(), 'resources/core/**/*.js').replace(/\\/gm, '/');
12 | const filePaths = glob.sync(resourcePath);
13 | 
14 | const funcsToIgnore = [
15 |     //
16 |     'export function',
17 |     'export const',
18 |     'export let',
19 |     'export async function',
20 |     '=>',
21 | ];
22 | 
23 | for (let filePath of filePaths) {
24 |     const fileContents = fs.readFileSync(filePath, { encoding: 'utf-8' });
25 |     const splitContents = fileContents.split(/\r?\n/);
26 | 
27 |     const filePathing = filePath.split('/');
28 |     filePathing.pop();
29 |     const directoryPath = filePathing.join('/');
30 | 
31 |     let wasModified = false;
32 |     for (let i = 0; i < splitContents.length; i++) {
33 |         if (!splitContents[i].includes('import') && !splitContents[i].includes('export')) {
34 |             continue;
35 |         }
36 | 
37 |         let shouldSkip = false;
38 |         for (let funcToIgnore of funcsToIgnore) {
39 |             if (splitContents[i].includes(funcToIgnore)) {
40 |                 shouldSkip = true;
41 |                 break;
42 |             }
43 |         }
44 | 
45 |         if (shouldSkip) {
46 |             continue;
47 |         }
48 | 
49 |         const filePathReg = new RegExp(/('|").*.('|")/g);
50 |         const extractions = splitContents[i].match(filePathReg);
51 |         if (extractions === null || !extractions) {
52 |             continue;
53 |         }
54 | 
55 |         const relativeFilePath = extractions[0].replace(/'/gm, '').replace(/"/gm, '');
56 |         if (relativeFilePath.charAt(0) !== '.' && relativeFilePath.charAt(0) !== '/') {
57 |             continue;
58 |         }
59 | 
60 |         const actualFilePath = path.join(directoryPath, relativeFilePath).replace(/\\/gm, '/');
61 |         if (fs.existsSync(actualFilePath)) {
62 |             const barrelFileTest = fs.statSync(actualFilePath);
63 |             if (barrelFileTest.isDirectory()) {
64 |                 splitContents[i] = splitContents[i].replace(relativeFilePath, `${relativeFilePath}/index.js`);
65 |                 wasModified = true;
66 |                 continue;
67 |             }
68 |         }
69 | 
70 |         if (!splitContents[i].includes('.js')) {
71 |             splitContents[i] = splitContents[i].replace(relativeFilePath, `${relativeFilePath}.js`);
72 |             wasModified = true;
73 |         }
74 |     }
75 | 
76 |     if (!wasModified) {
77 |         continue;
78 |     }
79 | 
80 |     const finalFile = splitContents.join('\r\n');
81 |     fs.writeFileSync(filePath, finalFile, { encoding: 'utf-8' });
82 | }


--------------------------------------------------------------------------------
/src-webviews/src/assets/react.svg:
--------------------------------------------------------------------------------
1 | <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" class="iconify iconify--logos" width="35.93" height="32" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 228"><path fill="#00D8FF" d="M210.483 73.824a171.49 171.49 0 0 0-8.24-2.597c.465-1.9.893-3.777 1.273-5.621c6.238-30.281 2.16-54.676-11.769-62.708c-13.355-7.7-35.196.329-57.254 19.526a171.23 171.23 0 0 0-6.375 5.848a155.866 155.866 0 0 0-4.241-3.917C100.759 3.829 77.587-4.822 63.673 3.233C50.33 10.957 46.379 33.89 51.995 62.588a170.974 170.974 0 0 0 1.892 8.48c-3.28.932-6.445 1.924-9.474 2.98C17.309 83.498 0 98.307 0 113.668c0 15.865 18.582 31.778 46.812 41.427a145.52 145.52 0 0 0 6.921 2.165a167.467 167.467 0 0 0-2.01 9.138c-5.354 28.2-1.173 50.591 12.134 58.266c13.744 7.926 36.812-.22 59.273-19.855a145.567 145.567 0 0 0 5.342-4.923a168.064 168.064 0 0 0 6.92 6.314c21.758 18.722 43.246 26.282 56.54 18.586c13.731-7.949 18.194-32.003 12.4-61.268a145.016 145.016 0 0 0-1.535-6.842c1.62-.48 3.21-.974 4.76-1.488c29.348-9.723 48.443-25.443 48.443-41.52c0-15.417-17.868-30.326-45.517-39.844Zm-6.365 70.984c-1.4.463-2.836.91-4.3 1.345c-3.24-10.257-7.612-21.163-12.963-32.432c5.106-11 9.31-21.767 12.459-31.957c2.619.758 5.16 1.557 7.61 2.4c23.69 8.156 38.14 20.213 38.14 29.504c0 9.896-15.606 22.743-40.946 31.14Zm-10.514 20.834c2.562 12.94 2.927 24.64 1.23 33.787c-1.524 8.219-4.59 13.698-8.382 15.893c-8.067 4.67-25.32-1.4-43.927-17.412a156.726 156.726 0 0 1-6.437-5.87c7.214-7.889 14.423-17.06 21.459-27.246c12.376-1.098 24.068-2.894 34.671-5.345a134.17 134.17 0 0 1 1.386 6.193ZM87.276 214.515c-7.882 2.783-14.16 2.863-17.955.675c-8.075-4.657-11.432-22.636-6.853-46.752a156.923 156.923 0 0 1 1.869-8.499c10.486 2.32 22.093 3.988 34.498 4.994c7.084 9.967 14.501 19.128 21.976 27.15a134.668 134.668 0 0 1-4.877 4.492c-9.933 8.682-19.886 14.842-28.658 17.94ZM50.35 144.747c-12.483-4.267-22.792-9.812-29.858-15.863c-6.35-5.437-9.555-10.836-9.555-15.216c0-9.322 13.897-21.212 37.076-29.293c2.813-.98 5.757-1.905 8.812-2.773c3.204 10.42 7.406 21.315 12.477 32.332c-5.137 11.18-9.399 22.249-12.634 32.792a134.718 134.718 0 0 1-6.318-1.979Zm12.378-84.26c-4.811-24.587-1.616-43.134 6.425-47.789c8.564-4.958 27.502 2.111 47.463 19.835a144.318 144.318 0 0 1 3.841 3.545c-7.438 7.987-14.787 17.08-21.808 26.988c-12.04 1.116-23.565 2.908-34.161 5.309a160.342 160.342 0 0 1-1.76-7.887Zm110.427 27.268a347.8 347.8 0 0 0-7.785-12.803c8.168 1.033 15.994 2.404 23.343 4.08c-2.206 7.072-4.956 14.465-8.193 22.045a381.151 381.151 0 0 0-7.365-13.322Zm-45.032-43.861c5.044 5.465 10.096 11.566 15.065 18.186a322.04 322.04 0 0 0-30.257-.006c4.974-6.559 10.069-12.652 15.192-18.18ZM82.802 87.83a323.167 323.167 0 0 0-7.227 13.238c-3.184-7.553-5.909-14.98-8.134-22.152c7.304-1.634 15.093-2.97 23.209-3.984a321.524 321.524 0 0 0-7.848 12.897Zm8.081 65.352c-8.385-.936-16.291-2.203-23.593-3.793c2.26-7.3 5.045-14.885 8.298-22.6a321.187 321.187 0 0 0 7.257 13.246c2.594 4.48 5.28 8.868 8.038 13.147Zm37.542 31.03c-5.184-5.592-10.354-11.779-15.403-18.433c4.902.192 9.899.29 14.978.29c5.218 0 10.376-.117 15.453-.343c-4.985 6.774-10.018 12.97-15.028 18.486Zm52.198-57.817c3.422 7.8 6.306 15.345 8.596 22.52c-7.422 1.694-15.436 3.058-23.88 4.071a382.417 382.417 0 0 0 7.859-13.026a347.403 347.403 0 0 0 7.425-13.565Zm-16.898 8.101a358.557 358.557 0 0 1-12.281 19.815a329.4 329.4 0 0 1-23.444.823c-7.967 0-15.716-.248-23.178-.732a310.202 310.202 0 0 1-12.513-19.846h.001a307.41 307.41 0 0 1-10.923-20.627a310.278 310.278 0 0 1 10.89-20.637l-.001.001a307.318 307.318 0 0 1 12.413-19.761c7.613-.576 15.42-.876 23.31-.876H128c7.926 0 15.743.303 23.354.883a329.357 329.357 0 0 1 12.335 19.695a358.489 358.489 0 0 1 11.036 20.54a329.472 329.472 0 0 1-11 20.722Zm22.56-122.124c8.572 4.944 11.906 24.881 6.52 51.026c-.344 1.668-.73 3.367-1.15 5.09c-10.622-2.452-22.155-4.275-34.23-5.408c-7.034-10.017-14.323-19.124-21.64-27.008a160.789 160.789 0 0 1 5.888-5.4c18.9-16.447 36.564-22.941 44.612-18.3ZM128 90.808c12.625 0 22.86 10.235 22.86 22.86s-10.235 22.86-22.86 22.86s-22.86-10.235-22.86-22.86s10.235-22.86 22.86-22.86Z"></path></svg>


--------------------------------------------------------------------------------