{"id":19763071,"url":"https://github.com/fdiskas/server","last_synced_at":"2025-04-30T14:31:38.028Z","repository":{"id":48540854,"uuid":"321189681","full_name":"FDiskas/server","owner":"FDiskas","description":null,"archived":false,"fork":false,"pushed_at":"2021-07-20T23:41:34.000Z","size":8543,"stargazers_count":3,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-05-01T19:54:01.963Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FDiskas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-14T00:22:26.000Z","updated_at":"2023-10-31T18:51:10.000Z","dependencies_parsed_at":"2022-09-03T07:23:24.753Z","dependency_job_id":null,"html_url":"https://github.com/FDiskas/server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FDiskas%2Fserver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FDiskas%2Fserver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FDiskas%2Fserver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FDiskas%2Fserver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FDiskas","download_url":"https://codeload.github.com/FDiskas/server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224214099,"owners_count":17274524,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T04:07:55.166Z","updated_at":"2024-11-12T04:07:55.716Z","avatar_url":"https://github.com/FDiskas.png","language":"TypeScript","readme":"\u003cp align=\"center\" style=\"font-size: 26px\"\u003e\n\t\u003cb\u003eGTA V Role Play playground for alt:V server\u003c/b\u003e\n\u003c/p\u003e\n\u003cp align=\"center\" style=\"font-size: 26px\"\u003e\n\t[ \u003ca href=\"https://altv.mp\"\u003ealtv.mp\u003c/a\u003e | \u003ca href=\"https://stuyk.com/\"\u003eThanks Stuyk\u003c/a\u003e ]\n\u003c/p\u003e\n\n## Documentation links\n\n-   [ALT Client Docs](https://docs.altv.mp/js/api/alt-client.html)\n-   [ALT Server Docs](https://docs.altv.mp/js/api/alt-server.html)\n-   [Native Docs](https://natives.altv.mp/)\n-   [Unofficial alt:V Docs](https://stuyk.github.io/altv-javascript-guide/)\n\n⭐ This repository if you found it useful!\n\n### Development\n\nalt:V has a lot of Boilerplates for TypeScript. However, they have one feature missing. They fail to create an environment where you can support multiple resource compilations. This boilerplate aims to fix that and allow multiple resources to be compiled at once and all your mods.\n\n### Features\n\n-   Full alt:V Type Support for VSCode\n-   Built in script auto-compilation through `npm run watch`.\n-   Built in auto-copy for non-typescript files.\n-   Built in handling of multiple resources for compilation.\n-   Easily expandable resource directory.\n-   [altv-pkg](https://github.com/Stuyk/altv-pkg) support for auto-downloading alt:V Server Binaries.\n-   Prettier Configuration for code formatting.\n\n### Installation\n\n[Get NodeJS 13+](https://nodejs.org/en/download/current/)\n\nLogin to github packages. For password use your github access token or create new one with read packages permission\n\n```\nnpm login --scope=@durtyfree --registry=https://npm.pkg.github.com\n```\n\nInstall the node modules\n\n```sh\nnpm install\n```\n\nDownload Server Files\n\n```sh\nnpm run update\n```\n\nBuild Typescript Files\n\n```sh\nnpm run build\n```\n\n### Start the Server\n\nUse any of the following commands to start it.\n\nBased on your environment.\n\n| Linux        | Windows (CMD)     | Windows (Powershell) |\n| ------------ | ----------------- | -------------------- |\n| `./start.sh` | `altv-server.exe` | `./altv-server.exe`  |\n\n\u003cbr /\u003e\n\n### Development Mode\n\nIf you wish to work your game-mode simply open up VSCode. Open up a terminal and split it (`Ctrl + Shift + 5`).\n\nRun the following in a terminal:\n\n```sh\nnpm run watch\n```\n\nRun your server in another terminal:\n\n| Linux        | Windows (CMD)     | Windows (Powershell) |\n| ------------ | ----------------- | -------------------- |\n| `./start.sh` | `altv-server.exe` | `./altv-server.exe`  |\n\n\u003cbr /\u003e\n\n### End Server Runtime\n\n`ctrl + c` to kill your server.\n\n### Reload changed resources\n\nDirectly on running server terminal type `reload RESOURCE_NAME` to reload module.\n\n### src vs src-copy\n\n### src\n\nThis folder should be used to write your typescript based game modes.\n\n### src-copy\n\nThis folder should be used to copy car mods, mlos, etc. to your resources folder after compilation.\n\nSimply add your modded resources, resource dependencies, etc. into this folder.\n\nThe build script will handle the rest.\n\n### Ingame keybindings\n\n-   `E` Raises his hand and whistles. If you are close to the vehicle - opens the door. If you are in the vehicle opens a window. If you are near the trunk / hood opens it\n\n-   `F` Sits in the driver's seat. Do not turn off the engine by exiting and holding the `F` key\n\n-   `G` Sits as a passenger in the nearest seat\n\n-   `B` Pointing finger\n\n-   `X` Raises his hands (surrenders)\n\n-   `C` Hold to Crouch\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffdiskas%2Fserver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffdiskas%2Fserver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffdiskas%2Fserver/lists"}