Elite-Gaming-FiveM/resources/Fire-Script/README.md

![Logo](https://i.imgur.com/cfPLDVh.png)

[![License GNU-GPL v3](https://img.shields.io/github/license/gimicze/firescript?style=for-the-badge)](https://github.com/gimicze/firescript/blob/master/LICENSE "License")
[![Latest release](https://img.shields.io/github/v/release/gimicze/firescript?style=for-the-badge)](https://github.com/gimicze/firescript/releases/latest "Latest release")
[![Total downloads](https://img.shields.io/github/downloads/gimicze/firescript/total?style=for-the-badge)](https://github.com/gimicze/firescript/releases/latest "Total downloads")

A FiveM resource enabling whitelisted users to create a (*somewhat*) realistic fires. As far as I am aware, the only fire script compatible with OneSync Infinity / Beyond.

<details>
<summary>In-game screenshots</summary>

![Example fire](https://i.imgur.com/XOLJN7v.png "Example fire")
![Example fire](https://i.imgur.com/IYmE6qn.png)
</details>

# Instalation

1. Extract the contents into folder called `firescript` into your resources folder.
2. Start the script: **a)** in the `server.cfg` file; **b)** through the console

## Starting a resource through console

1. In a server console, or client console (F8), type in `refresh` and confirm using ENTER
2. Type in `start firescript` and confirm using ENTER

## Starting a resource in `server.cfg`
1. Add this line to your server.cfg
```
start firescript
```
2. Save the file and restart the server.

# Usage & Commands

*Tutorial moved to [the wiki](https://github.com/gimicze/firescript/wiki).*

# Known bugs
*None! Feel free to open issue when you find any!*

# Credits
- Albo1125 and foregz - I borrowed some particles from their fire scripts. Thanks!
- MadMick#0773, Mickey#2590 and MadLadClip for testing and help with the script.

# Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

# License
[GNU GPL 3.0](https://github.com/gimicze/firescript/blob/main/LICENSE)