/altv-PlayVFreeroam

PlayV.mp Freeroam

Primary LanguageTypeScriptMIT LicenseMIT

PlayV.mp Freeroam Server

This resource is made for the alt:V release branch (V15.57). Special thanks to our users, team members and co-developer tomatenbaumful ❤️

Feel free to help us with the project by implementing your own fixes or new features and create a pull request :)

Features

  • Ready to start Freeroam Server
  • Feature rich menu & framework
  • Synced NPC Traffic with a lot tweaking options
  • Vehicle spawner, tuning, handling editor + database storing
  • Menyoo Import/ Export
  • Full fledged character editor + database storing
  • Noclip & Freecam
  • Lobby system to create own lobbys + presets
  • Synced weather and time
  • Speedometers
  • IPL & Interior Browser
  • Blips for players
  • Voice
  • Discord Integration (optional for users)
  • And more...

Installation

  1. Clone this repo to your local pc

  2. Database setup: For a smooth experience we suggest installing and using PostgreSQL for the database. Since we used typeorm you can also use any other database tool, that works with typeorm. To change the database type change the 'type' value in src/playv/server/systems/db/TypeORM.ts . Also when changing the database type you need to change some types for the database entities, otherwise the server start will fail.

  3. alt:V setup: Download the release server version of alt:V and paste it into the root folder of the cloned git repo

  4. Node Modules: Make sure you have the latest Node.js version installed on your machine, then navigate into the cloned repo and run npm i. Also navigate to the CEF folder and also run npm i.

  5. Server Config: Open the server.toml file and edit the database config matching your database credentials. If you consider using the server public make sure you create a Discord Bot and add the matching token to the server.toml

Starting the server

Open a terminal and run in the root folder of the project the command npm run dev.

When using debug = true in the client config run npm run dev:ui to start the UI. If you don't use the debug mode, please build the UI once by using the npm run build:ui once.

Start your alt:V client on release branch and direct connect to localhost:7788

After your first connect to the server change your authLevel to any higher then 0 to access the admin menu on the server.

Screenshots

Spawn area Main Menu Our spawn protectors Kaniggel and Tomatenbaum

Known Errors

  • High bandwidth usage on player disconnect (maybe caused by our blip sync)
  • Traffic vehicles migration is buggy and vehicles are randomly deleted
  • Laggy vehicle spawner menu page
  • Lobby presets need a rework

Useful information

  • The src/playv/shared/conf/ConVars.ts file contains a lot of important configurations. Change them to your liking.
  • Feel free to use any part of the code in your project, but respect the licensing of the codebase.
  • To add modded vehicles load the resources and add the vehicle spawn names to the database table modded_vehicles (needs a server restart).
  • When building the resource for production make sure to use debug = false in the server.toml!
  • Never ever use the server in production without your own auth method for the users! We implemented CloudAuth and you need a valid token & benefit from alt:V to use it!

Sources & Used Packages

UI

Server & Client

Help

Please note, that we don't provide support for the database connection, or the Discord Authentication! In case you have any questions or concerns regarding this resource, feel free to contact us on Discord by opening a support ticket https://playv.mp/discord .

License

This project is written by Kaniggel and tomatenbaumful and the project source files are published under MIT License Google Fonts are being used within this project. For commerical use, please check for licensing!

Any trademarks used belong to their respective owners. This project is not affiliated with or endorsed by Take-Two Interactive Software.