{"id":23396327,"url":"https://github.com/stuyk/altv-quickstart","last_synced_at":"2025-08-24T14:31:28.893Z","repository":{"id":48452214,"uuid":"231924662","full_name":"Stuyk/altv-quickstart","owner":"Stuyk","description":"The fastest alt:V JS setup on GitHub.","archived":false,"fork":false,"pushed_at":"2021-11-17T23:58:11.000Z","size":40,"stargazers_count":32,"open_issues_count":0,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-07-30T16:53:24.986Z","etag":null,"topics":["altv","boilerplate","fivem","ragemp"],"latest_commit_sha":null,"homepage":"https://stuyk.com/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Stuyk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["stuyk"]}},"created_at":"2020-01-05T13:52:45.000Z","updated_at":"2024-01-04T23:35:35.000Z","dependencies_parsed_at":"2022-09-12T15:00:34.250Z","dependency_job_id":null,"html_url":"https://github.com/Stuyk/altv-quickstart","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Stuyk%2Faltv-quickstart","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Stuyk%2Faltv-quickstart/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Stuyk%2Faltv-quickstart/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Stuyk%2Faltv-quickstart/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Stuyk","download_url":"https://codeload.github.com/Stuyk/altv-quickstart/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230806835,"owners_count":18282993,"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":["altv","boilerplate","fivem","ragemp"],"created_at":"2024-12-22T07:35:04.301Z","updated_at":"2024-12-22T07:35:04.727Z","avatar_url":"https://github.com/Stuyk.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stuyk","https://github.com/sponsors/Stuyk/"],"categories":[],"sub_categories":[],"readme":"## alt:V - Quick Start\n\n---\n\n[❤️ Become a Sponsor of my Open Source Work](https://github.com/sponsors/Stuyk/)\n\n[⌨️ Learn how to script for alt:V](https://altv.stuyk.com)\n\n[💡 Need a Roleplay Script? Try Athena!](https://gtavathena.com/)\n\n⭐ This repository if you found it useful!\n\n---\n\nThis repo will do everything for you; including download the latest server files.\n\nIncludes the following:\n* Chat\n* Chat Commands\n* Weapon Commands\n* Vehicle Commands\n* Kill Feed\n* Respawn on Death\n* A scale-able folder structure\n\n## Requirements\n\n-   [Git](https://git-scm.com/downloads)\n-   [NodeJS 13+](https://nodejs.org/en/download/current/)\n\n## Links\n\n-   [alt:V Website](https://altv.mp/#/)\n-   [alt:V Unofficial Documentation](https://altv.stuyk.com/)\n\n### Installation\n\n#### GIF Instructions:\n\n[Step 1 GIF](https://gfycat.com/DefiniteConstantJoey)\n\n[Step 2 GIF](https://gfycat.com/PowerfulOrderlyGartersnake)\n\n[Step 3 GIF](https://gfycat.com/CourageousDefensiveHarpyeagle)\n\n#### Text Instructions:\n\n0. Open a command prompt in a folder.\n\n1. Run this:\n\n```\ngit clone https://github.com/Stuyk/altv-quickstart\ncd altv-quickstart\n```\n\n2. Run the code block below this.\n\n    2.1. This can be used whenever you need to update your server files.\n\n    2.2. Run the code block below; wait for packages to install.\n\n    2.3. Then follow the instructions on screen.\n\n```\nnpm run update\n```\n\n3. Bootup the Server\n\n    3.1. This script downloads for Linux or Windows automatically.\n\n    3.2. Use a screen on Linux to run the server in the background.\n\n    3.3. Use a built in command prompt such as in VSCode to run the server.\n\n    3.4. You may press `Ctrl + C` to stop the server at any time.\n\nLinux:\n\n```\n./start.sh\n```\n\nWindows (CMD):\n\n```\naltv-server.exe\n```\n\nWindows (Powershell):\n\n```\n./altv-server.exe\n```\n\n### Connecting to your Quick-Start alt:V Server\n\nSimply put in the following direct connect url: `127.0.0.1:7788`\n\n### Broadcasting Your Server\n\nYour server can be broadcasted by getting a token from the alt:V bot in the Discord.\n\nMessage `Master-Bot#3667` and it will instruct you on what to type.\n\nAfter doing this simply set announce to true in your `server.cfg`.\n\n### Reconnecting to your Server\n\nIf you wish to reconnect to your server after restarting you need to enable debug mode on both your client and your server.\n\nIn your server.cfg put the following:\n\n`debug: true`\n\nIn your altv.cfg for your alt:V client put the following:\n`debug: true`\n\nThis will fully allow you to reconnect to your server by press `f8` and typing `reconnect \u003cpassword\u003e`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuyk%2Faltv-quickstart","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstuyk%2Faltv-quickstart","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuyk%2Faltv-quickstart/lists"}