Merge pull request #152 from matsn0w/feat/misc-support

feat: support miscs as light sources

.github/workflows/configurator.yml

@@ -2,28 +2,28 @@ name: Configurator deployer
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   workflow_dispatch:
 
 jobs:
   build:
     runs-on: ${{ matrix.os }}
-    
+
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [14]
+        node: [20]
 
     defaults:
       run:
         working-directory: ./configurator
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Setup node env
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
 
@@ -34,7 +34,6 @@ jobs:
         run: npm run generate
 
       - name: Deploy
-        uses: peaceiris/actions-gh-pages@v3
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./configurator/dist
+          folder: ./configurator/.output/public

README.md

@@ -1,134 +1,143 @@
-# MISS-ELS: Matsn0w's Incredible Server-Sided ELS
+# 🚨 MISS-ELS: Matsn0w's Incredible Server-Sided ELS
 
 ![MISS-ELS](assets/MISS-ELS_Logo.png)
 
 MISS-ELS is an all-in-one configurable Emergency Lighting System (ELS) for the popular Grand Theft Auto V (GTA V) multiplayer client called FiveM.
 
-The server-side element restricts controls to the driver (and optionally his passengers) and allows you to activate primary, secondary and warning lighting each with individually configurable key-bindings. Welcome to the best server-sided Emergency Lighting System for FiveM!
+The server-side element restricts controls to the driver (and optionally his passengers) and allows you to activate primary, secondary and warning lighting each with individually configurable key-bindings.
+
+Welcome to the best server-sided Emergency Lighting System for FiveM!
 
 Oh, and you might ask yourself where all the 'Els' or 'Miss Els' jokes come from. It's a [meme](https://youtu.be/X-PgamXIWRQ?t=75). Loes is calling her grandchild Els. Els? Els! ELS!
 
-## Key Features
+## ⚡ Key Features
+
+MISS ELS is very different compared to most other ELS resources! These are some key features:
+
+- Fully customizable light patterns
+- Support for up to 36 independent light sources (12 extras + 26 miscs)
+- Use native game sirens or use your own with [WMServerSirens](https://github.com/Walsheyy/WMServerSirens)
+- Optional light reflections around the vehicle
+- [A VCF configuration wizard](https://matsn0w.github.io/MISS-ELS) to make your life easier
 
-* Sirens and lights synced across the entire server
-* Customizable light patterns per vehicle
-* Use native game sirens or use your own with [WMServerSirens](https://github.com/Walsheyy/WMServerSirens)
-* A simple yet comprehensive configuration
-* Support for 3 different light stages
-* Support for up to 4 different sirens per vehicle
-* Optional light reflections around the vehicle
-* Indicator controls
-* Customizable keybinds (client side!)
-* [A simple VCF configuration wizard](https://matsn0w.github.io/MISS-ELS)
+Furthermore...
 
-*...and more!*
+- Sirens and lights synced across the entire server
+- Support for 3 different light stages
+- Support for up to 4 different sirens per vehicle
+- Indicator controls
+- Flashing high beams
+- Stop sign beeping
+- Customizable personal keybinds
+- ...
 
-## Requirements
+## 🧩 Requirements
 
 You need to have the following resources installed on your server:
 
-* [FiveM baseevents](https://docs.fivem.net/docs/resources/baseevents) (shipped by default)
-* [NativeUILua](https://github.com/FrazzIe/NativeUILua/releases/latest)
+- [FiveM baseevents](https://docs.fivem.net/docs/resources/baseevents) (shipped by default)
+- [NativeUILua](https://github.com/FrazzIe/NativeUILua/releases/latest)
 
-## Installation and Configuration
+## ⚙️ Installation and Configuration
 
 See the instructions in the [documentation](docs/README.md)!
 
-## Vehicle Configuration Files
+## 🚓 Vehicle Configuration Files
 
-If you have any existing VCF files from the original author of this resource, then you'll probably be fine. The XML should be fully backwards compatible. If you have a VCF from any other resource, that'll most likely not work.
+If you have any existing VCF files from the [original author](https://github.com/InfImpSolutions) of this resource, then you'll probably be fine. The XML should be fully backwards compatible.
 
-In both cases, it's probably best to re-create them by either writing them yourself OR... use my convient configuration GUI! Using this tool, you can easily generate configuration files for your vehicles. You can find it here:
+**⚠️ If you have a VCF from any other resource, that'll most likely not work.**
+
+In both cases, it's probably best to re-create them by either writing them yourself OR... use the convient configuration GUI! Using this tool, you can easily generate configuration files for your vehicles. You can find it here:
 
 [![Open VCF Configurator](https://dabuttonfactory.com/button.png?t=MISS+ELS+VCF+Configurator&f=Open+Sans-Bold&ts=16&tc=fff&hp=45&vp=20&c=10&bgt=unicolored&bgc=1a37a8&be=1&bs=1&bc=fff)](https://matsn0w.github.io/MISS-ELS)
 
-## Questions or problems?
+## 💭 Questions or problems?
+
+👉 Please read the [documentation](docs/README.md) first and check the [Q&A section](https://github.com/matsn0w/IIS-EmergencyLS-ELS-FiveM/discussions/categories/q-a) on Github if your question has already been asked. It probably is!
 
-Please read the [documentation](docs/README.md) first and check the [Q&A section](https://github.com/matsn0w/IIS-EmergencyLS-ELS-FiveM/discussions/categories/q-a) on Github if your question has already been asked. It probably is!
+👉 Didn't find and answer? Then feel free to [start a new topic](https://github.com/matsn0w/IIS-EmergencyLS-ELS-FiveM/discussions/new?category=q-a). The community is here to help you! You can also join the official [MISS ELS Discord server](https://matsn0w.dev/discord).
 
-Didn't find and answer? Then feel free to [start a new topic](https://github.com/matsn0w/IIS-EmergencyLS-ELS-FiveM/discussions/new?category=q-a). The community is here to help you!
+👉 Found a bug? Please [make an issue](https://github.com/matsn0w/MISS-ELS/issues/new)!
 
-Found a bug? Please [make an issue](https://github.com/matsn0w/MISS-ELS/issues/new)!
+## 🛣️ Roadmap
+
+👀 You can take a look at the [Milestones](https://github.com/matsn0w/MISS-ELS/milestones) for this project to see what's coming to MISS ELS!
+
+💡 Feel free to [create an issue](https://github.com/matsn0w/MISS-ELS/issues/new) if you have an idea.
+
+## ❤️ Credits
+
+This resource wasn't possible without these libraries:
 
-## Roadmap
+- [semver.lua](https://github.com/kikito/semver.lua) by _kikito_
+- [SLAXML](https://github.com/Phrogz/SLAXML) by _Phrogz_
 
-You can take a look at the [Milestones](https://github.com/matsn0w/MISS-ELS/milestones) for this project to see what's coming to MISS ELS!
+### Special thanks
 
-Feel free to [create an issue](https://github.com/matsn0w/MISS-ELS/issues/new) if you have an idea.
+- [@ImperiousTT](https://github.com/ImperiousTT) - for all his help in setting up this resource, especially writing documentation, creating the logo and providing support
+- [@JustinRijsdijk](https://github.com/JustinRijsdijk) 🐔🎩 - for all his help in many areas, especially the VCF Configurator
 
-## Changelog
+_...and everyone else who contributed to the development of this resource - it would never have been this good without you! ❤️_
+
+## 📃 Changelog
 
 ### v2.1.1
 
 #### Resource
 
-* Fixed the automatic directory scanner not working on Windows based servers
+- Fixed the automatic directory scanner not working on Windows based servers
 
 ### v2.1.0
 
 #### Resource
 
-* Added automatic scanning for VCF's
-* Added 'missing zero' detection in the XML parser
-* Fixed a bunch of errors thrown in the console when 'others' activated their lights 
+- Added automatic scanning for VCF's
+- Added 'missing zero' detection in the XML parser
+- Fixed a bunch of errors thrown in the console when 'others' activated their lights
 
 #### Configurator
 
-* Added importing of existing VCF's
-* Fixed missing zeros in XML output
+- Added importing of existing VCF's
+- Fixed missing zeros in XML output
 
 ### v2.0.1
 
 #### Resource
 
-* Fixed a bug in the update checking script
+- Fixed a bug in the update checking script
 
 ### v2.0.0
 
 #### Resource
 
-* Added configuration option to allow passengers to control the sirens
-* Added configuration option to customize indicator controls
-* Added configuration option to customize environmental light reflections
-* Added new documentation
-* Added `/extra <extra>` command to quickly toggle a vehicle extra
-* Added an option to control the sirens regardless of the light stage
-* Added a in-game menu for static extra's
-* Added automatic check for updates
-* Added some documentation
-* VCF: Added `AllowUse` flag to enable or disable the main horn
-* VCF: Added `SoundSet` flag to specify a custom sound for the main horn
-* VCF: Added new `STATIC` section
-* VCF: `IsElsControlled` is now actually respected
-* VCF: It's no longer needed to specify flash numbers within a pattern (Flash01, Flash02, etc. can now be Flash Flash Flash!)
-* Fixed `AllowEnvLight` setting not doing anything
-* Fixed `AudioString` on MainHorn not doing anything
-* Fixed some weird keybind behaviour
-* Fixed crash on invalid VCF syntax
-* Removed fallback to default patterns when no VCF is present for an ELS-enabled vehicle
-* Organized file structure
-* Updated SLAXML parser to version 0.8
-* Lots of code improvements and optimizations
+- Added configuration option to allow passengers to control the sirens
+- Added configuration option to customize indicator controls
+- Added configuration option to customize environmental light reflections
+- Added new documentation
+- Added `/extra <extra>` command to quickly toggle a vehicle extra
+- Added an option to control the sirens regardless of the light stage
+- Added a in-game menu for static extra's
+- Added automatic check for updates
+- Added some documentation
+- VCF: Added `AllowUse` flag to enable or disable the main horn
+- VCF: Added `SoundSet` flag to specify a custom sound for the main horn
+- VCF: Added new `STATIC` section
+- VCF: `IsElsControlled` is now actually respected
+- VCF: It's no longer needed to specify flash numbers within a pattern (Flash01, Flash02, etc. can now be Flash Flash Flash!)
+- Fixed `AllowEnvLight` setting not doing anything
+- Fixed `AudioString` on MainHorn not doing anything
+- Fixed some weird keybind behaviour
+- Fixed crash on invalid VCF syntax
+- Removed fallback to default patterns when no VCF is present for an ELS-enabled vehicle
+- Organized file structure
+- Updated SLAXML parser to version 0.8
+- Lots of code improvements and optimizations
 
 #### Configurator
 
-* Added a VCF configuration GUI
+- Added a VCF configuration GUI
 
 ### v1.2.0 - v1.3.0
 
 Original releases from [Infinite Impact Solutions](https://github.com/InfImpSolutions)
-
-## Video Demonstration (+ Installation)
-
-*Note that this video was made for version 1.x of this resource.*
-
-[![EmergencyLS | FiveM Resource | Teaser/Trailer](https://res.cloudinary.com/marcomontalbano/image/upload/v1641479116/video_to_markdown/images/youtube--MZnO9eIjFWA-c05b58ac6eb4c4700831b2b3070cd403.jpg)](https://www.youtube.com/watch?v=MZnO9eIjFWA "EmergencyLS | FiveM Resource | Teaser/Trailer")
-
-## Credits
-
-This resource wasn't possible without these libraries:
-
-* [semver.lua](https://github.com/kikito/semver.lua) by *kikito*
-* [SLAXML](https://github.com/Phrogz/SLAXML) by *Phrogz*
-
-*Special thanks to everyone who contributed to the development of this resource - it would never have been this good without you!*