Skip to content

Latest commit

 

History

History
104 lines (66 loc) · 2.39 KB

README.md

File metadata and controls

104 lines (66 loc) · 2.39 KB
Raw

altv-crc core

A TypeScript Cross Resource Reloader, Transpiler, and Reconnector
Spend more time coding, and less time restarting

Features

A simple Typescript Boilerplate that builds incredibly fast using the SWC Library.

  • Auto restart individual resources on file change.
  • Auto build resources on file change.
  • Flag individual resources for full reconnection.
  • Compile multiple resources at once
  • Auto reconnect on a Windows PC instantly
  • Auto download latest alt:V Binaries on installation

Installation

Clone the Repository

Use the command below in any terminal, command prompt, etc.

git clone https://github.com/altv-crc/altv-crc-core

Install the Repository

Use the command below in any terminal, command prompt, etc.

cd altv-crc-core
npm install

Update / Download Server Files

If the binaries for the server did not download, you can always use this command to update.

npm run update

Start Developer Server

Run this command to run the server in development mode.

This will automatically reconnect your alt:V Client if you have debug mode turned on.

This will also automatically rebuild and restart resources on file change.

npm run dev

Start Production Server (Windows)

Run this command to run the server in production mode.

npm run windows

Start Production Server (Linux)

Run this command to run the server in production mode.

npm run linux

FAQ

Where do I get resources?

Resources can be obtained from https://github.com/altv-crc

End Server Runtime

Use the key combination ctrl + c to kill your server in your terminal, command prompt, etc.

How to Add Mods, and New Resources

Always add your already compiled resources & mods into the resources folder.

How to ignore specific resources from compiling

Add file name .nocompile to the resource folder you want to ignore from compiling.

How to mark a resource as requiring a full reconnect?

Add a file called reconnect.txt to the base folder of the resource.