gtavjs-template-mod/README.md

Create single-player mods using Typescript/Javascript.

# GTAVJS Template Mod
Template mod for **GTAVJS**.  

[![npm version](https://badge.fury.io/js/gtavjs-template-mod.svg)](https://badge.fury.io/js/gtavjs-template-mod)

[GTAVJS](https://github.com/GTAVJS/GTAVJS/)|[Typing](https://github.com/GTAVJS/gtavjs-typing)|[Template](https://github.com/GTAVJS/gtavjs-template-mod/)|[Wiki](https://github.com/GTAVJS/GTAVJS/wiki)
---|---|---|---

> About **GTAVJS**  
> - Create single-player mods using Typescript.  
> - Add your own DLL Assemblies and generate typing directly in-game.  
> - Reload mods faster using F9, it doesn't need to reload the AppDomain.  
> - Quick project setup, simply use this template and you are good to go.  
> - Complete typing for ScriptHookVDotNet3 and LemonUI included.  
> - Generate typing for your mods and share them using npm.  

<br>

# Requirements
This mod template uses `gtavjs-utils-mod` by default.  
- [Download GTAVJS Utils Mod](https://github.com/GTAVJS/gtavjs-utils-mod/releases/) latest release

<br>

# Installation
To use this mod into your game:
1) Install [GTAVJS](https://github.com/GTAVJS/GTAVJS/)
2) Install [Required Mods](#requirements)
3) [Download GTAVJS Template Mod](https://github.com/GTAVJS/gtavjs-template-mod/releases/) latest release
4) Unzip into `.../Grand Theft Auto V/scripts/GTAVJS/Mods/` directory

<br>

# Developper
To use this mod into your own mods
1) install the type definition.
```bash
npm install gtavjs-template-mod
```
2) add it to your `tsconfig.json` types array
```json
...
    "types": [
      "gtavjs-typing",
      "gtavjs-template-mod"
    ],
...
```
> You must also install the mod into `.../Grand Theft Auto V/scripts/GTAVJS/Mods/`

<br>

# Instructions:
> Find complete tutorial at [Wiki - Create a GTAVJS mod](https://github.com/GTAVJS/GTAVJS/wiki/Create-a-GTAVJS-mod)