DartsArmaMods · DartRuffian · Dec 16, 2023 · Dec 16, 2023 · Dec 16, 2023 · Dec 16, 2023
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+end_of_line = crlf
+insert_final_newline = false
+charset = utf-8
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,12 @@
+# Contributing Setup & Guidelines
+
+## Setting up the Development Environment
+### 1. Clone the repository from GitHub
+### 2. Install HEMTT
+The latest version of HEMTT can be installed by running:
+```cmd
+winget install hemtt
+```
+
+## Coding Guidelines
+This mod follows the same coding guidelines as the ACE3 mod, which can be found [here](https://ace3.acemod.org/wiki/development/coding-guidelines).
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a bug report to help us improve
+title: ''
+labels: kind/bug
+---
+
+## Describe the bug
+A clear and concise description of what the bug is.
+
+## To reproduce
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+## Attachments
+If applicable, add screenshots or RPT logs to help explain your problem.
+
+## Additional context
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,15 @@
+---
+name: Feature Request
+about: Suggest a feature to be added
+title: ''
+labels: kind/feature-request
+---
+
+## Describe the feature that you would like
+A clear and concise description of the feature you'd want.
+
+## Possible alternatives
+Possible alternatives to your suggestion.
+
+## Additional context
+Add any other context about the feature here.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,12 @@
+**When merged this pull request will:**
+- Describe what this pull request will do
+- Each change in a separate line
+
+### Important
+- [ ] If the contribution affects [the documentation](../docs), please include your changes in this pull request.
+- [ ] [Development Guidelines](../.github/CONTRIBUTING.md) are read, understood and applied.
+- [ ] Title of this PR uses our standard template `Component - Add|Fix|Improve|Change|Make|Remove {changes}`.
+
+<!-- Known issues that need to be addressed -->
+### Known Issues
+- [ ] Issue
diff --git a/.github/workflows/arma.yml b/.github/workflows/arma.yml
@@ -0,0 +1,22 @@
+name: Validate
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout the source code
+      uses: actions/checkout@v4
+    - name: Validate Config
+      run: python tools/config_style_checker.py
+    - name: Check for BOM
+      uses: arma-actions/bom-check@master
+      with:
+        path: "addons"
diff --git a/.github/workflows/hemtt.yml b/.github/workflows/hemtt.yml
@@ -0,0 +1,20 @@
+name: HEMTT
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout the source code
+      uses: actions/checkout@v4
+    - name: Setup HEMTT
+      uses: arma-actions/hemtt@v1
+    - name: Run HEMTT check
+      run: hemtt check
diff --git a/.hemtt/launch.toml b/.hemtt/launch.toml
@@ -0,0 +1,20 @@
+[default]
+workshop = [
+    "450814997",  # CBA
+    "2369477168", # ADT
+]
+presets = []
+dlc = []
+parameters = [
+    "C:\\Users\\skull\\OneDrive\\Documents\\Arma 3 - Other Profiles\\CE%2fSPC-0925%20%22Dart%22\\missions\\CWR_Test.VR",
+]
+
+[ace]
+extends = "default"
+workshop = [
+    "463939057",  # ACE
+]
+
+[vanillavoice]
+extends = "default"
+optionals = ["vanillavoice"]
diff --git a/.hemtt/project.toml b/.hemtt/project.toml
@@ -1,10 +1,10 @@
 name = "Chat Wheel Redux"
 author = "DartRuffian"
-prefix = "CWR"
-mainprefix = "DA"
+prefix = "cwr"
+mainprefix = "z"
 
 [version]
-path = "addons/Core/script_version.hpp"
+path = "addons/main/script_version.hpp"
 git_hash = 0
 
 [files]
@@ -13,33 +13,10 @@ include = [
     # "logo_cwr_ca.paa",
     # "logo_cwr_over_ca.paa",
     "LICENSE",
-    "README.md"
-]
-exclude = [
-    "*.psd"
+    "README.md",
 ]
+exclude = ["*.psd"]
 
 [properties]
 author = "DartRuffian"
-url = "https://github.com/Dart-Armory/ChatWheel-Redux"
-
-[hemtt.launch.default]
-workshop = [
-    "450814997", # CBA
-    "2369477168" # ADT
-]
-presets = []
-dlc = []
-optionals = []
-parameters = []
-
-[hemtt.launch.ace]
-workshop = [
-    "450814997", # CBA
-    "463939057", # ACE
-    "2369477168" # ADT
-]
-presets = []
-dlc = []
-optionals = []
-parameters = []
+url = "https://github.com/DartsArmaMods/ChatWheelRedux"
diff --git a/.hemtt/scripts/update_build.rhai b/.hemtt/scripts/update_build.rhai
@@ -1,6 +1,6 @@
 // Read the current contents of script_version.hpp
 let script_version = HEMTT_RFS.join("addons")
-    .join("core")
+    .join("main")
     .join("script_version.hpp")
     .open_file()
     .read();
@@ -9,12 +9,11 @@ let script_version = HEMTT_RFS.join("addons")
 let prefix = "#define BUILD ";
 let current = HEMTT.project().version().build();
 let next = current + 1;
-
 script_version.replace(prefix + current.to_string(), prefix + next.to_string());
 
 // Write the modified contents to script_version.hpp
 HEMTT_RFS.join("addons")
-    .join("core")
+    .join("main")
     .join("script_version.hpp")
     .create_file()
     .write(script_version);
diff --git a/.hemtt/scripts/update_minor.rhai b/.hemtt/scripts/update_minor.rhai
@@ -1,6 +1,6 @@
 // Read the current contents of script_version.hpp
 let script_version = HEMTT_RFS.join("addons")
-    .join("core")
+    .join("main")
     .join("script_version.hpp")
     .open_file()
     .read();
@@ -10,11 +10,14 @@ let prefix = "#define MINOR ";
 let current = HEMTT.project().version().minor();
 let next = current + 1;
 
+// Updating minor version should reset patch number
 script_version.replace(prefix + current.to_string(), prefix + next.to_string());
+current = HEMTT.project().version().patch();
+script_version.replace("#define PATCH " + current.to_string(), "#define PATCH 0");
 
 // Write the modified contents to script_version.hpp
 HEMTT_RFS.join("addons")
-    .join("core")
+    .join("main")
     .join("script_version.hpp")
     .create_file()
     .write(script_version);
diff --git a/.hemtt/scripts/update_patch.rhai b/.hemtt/scripts/update_patch.rhai
@@ -0,0 +1,20 @@
+// Read the current contents of script_version.hpp
+let script_version = HEMTT_RFS.join("addons")
+    .join("main")
+    .join("script_version.hpp")
+    .open_file()
+    .read();
+
+// Replace the current version with the new version
+let prefix = "#define PATCH ";
+let current = HEMTT.project().version().patch();
+let next = current + 1;
+
+script_version.replace(prefix + current.to_string(), prefix + next.to_string());
+
+// Write the modified contents to script_version.hpp
+HEMTT_RFS.join("addons")
+    .join("main")
+    .join("script_version.hpp")
+    .create_file()
+    .write(script_version);
diff --git a/.vscode/extensions.json b/.vscode/extensions.json
@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "brettmayson.hemtt",
+        "editorconfig.editorconfig"
+    ]
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -7,9 +7,12 @@
     "files.trimTrailingWhitespace": true,
     "files.insertFinalNewline": false,
 
-    "files.associations":
-    {
-        "*.hpp": "cpp"
+    "files.associations": {
+        "*.cpp": "cpp",
+        "*.hpp": "cpp",
+        "*.inc": "cpp",
+        "*.cfg": "cpp",
+        "*.rvmat": "cpp"
     },
 
     "C_Cpp.errorSquiggles": "disabled"

diff --git a/LICENSE b/LICENSE
diff --git a/addons/ChatWheel/XEH_PREP.hpp → LICENSE.md b/addons/ChatWheel/XEH_PREP.hpp → LICENSE.md
diff --git a/PREFIX.code-workspace b/PREFIX.code-workspace
diff --git a/README.md b/README.md
@@ -1,29 +1,46 @@
-<div align="center">
+<!-- If you want to make changes to this README, you need to also modify the README.md in the docs folder as well -->
+
+<h1 align="center">Chat Wheel Redux</h1>
+<p align="center">
+    <img src="https://img.shields.io/badge/Version-1.4.0-blue?style=flat-square" alt="Chat Wheel Redux Version">
+    <a href="https://github.com/DartsArmaMods/ChatWheelRedux/issues">
+        <img src="https://img.shields.io/github/issues-raw/DartsArmaMods/ChatWheelRedux.svg?style=flat-square&label=Issues" alt="Chat Wheel Redux Issues">
+    </a>
+    <a href="https://steamcommunity.com/sharedfiles/filedetails/?id=3005504621">
+        <img src="https://img.shields.io/steam/downloads/3005504621.svg?style=flat-square&label=Downloads" alt="Chat Wheel Redux Downloads">
+    </a>
+    <a href="https://github.com/DartsArmaMods/ChatWheelRedux/blob/master/LICENSE">
+        <img src="https://img.shields.io/badge/License-APL ND-red?style=flat-square" alt="Chat Wheel Redux License">
+    </a>
+    <br>
+    <img src="https://img.shields.io/github/actions/workflow/status/DartsArmaMods/ChatWheelRedux/hemtt.yml?style=flat-square&label=HEMTT" alt="HEMTT">
+    <img src="https://img.shields.io/github/actions/workflow/status/DartsArmaMods/ChatWheelRedux/arma.yml?style=flat-square&label=Validate" alt="Validate">
+</p>
+
+<p align="center">
+    <b>Requires the latest version of <a href="https://github.com/CBATeam/CBA_A3/releases/latest">CBA A3</a></b>
+</p>
 
-<div id="user-content-toc">
-  <ul>
-    <summary><h1 style="display: inline-block;">Chat Wheel Redux</h1></summary>
-  </ul>
-</div>
-
-[![Developers](https://img.shields.io/github/contributors/DartRuffian/A3-ChatWheel-Redux?logo=github&label=Dev%20Team%20Size&labelColor=444D56)](https://github.com/DartRuffian/A3-ChatWheel-Redux/graphs/contributors)
-[![Last Updated](https://img.shields.io/steam/update-date/3005504621?logo=steam&label=Last%20Updated&labelColor=2a475e&color=66c0f4)](https://steamcommunity.com/sharedfiles/filedetails/?id=3005504621)
+**Chat Wheel Redux** (_CWR_) is a mostly client-side communication mod, allowing players without the ability to speak to communicate with other players easier. It is primarily intended for mute players who cannot communicate via microphone, but can also assist deaf or hard-of-hearing players if other players also use the mod to help communicate with them.
 
-</div>
+The project is entirely **open-source** and any contributions to fix other mods are welcome.
 
----
+Chat Wheel Redux is mostly feature complete; however, some of the planned features are: messages when taking damage; when a player is knocked unconcious (ACE); or killed. These will be able to be toggled on or off, similar to the automated messages for throwing grenades functions. They may each recieve their own settings in the future for more customization options.
 
-> "Thank you Dart for making my 'minimum fit for purpose' mod I made for, like, three of my unit members into something legit super accessible to the broader community."
-> <br>- _Jenna_, the original creator of the script this mod is based on. [Source (Legion Studios Discord)](https://ptb.discord.com/channels/461042140756180992/1130867599345987604/1130901200498343938)
+## Contributing
+For new contributers, see the [Contributing Setup & Guidelines](./.github/CONTRIBUTING.md).
 
-**Chat Wheel Redux** (_CWR_) is a mostly client-side communication mod, allowing players without the ability to speak to communicate with other players easier. It is primarily intended for mute players who cannot communicate via microphone, but can also assist deaf or hard-of-hearing players if other players also use the mod to help communicate with them.
+## Issues
+Experiencing an issue? Check out the [Common Issues post](https://github.com/DartsArmaMods/A3-ChatWheel-Redux/issues/1) to see if your issue is listed.<br>
+If your issue is not listed, please create [a new issue](https://github.com/DartsArmaMods/ChatWheelRedux/issues/new)
 
-Chat Wheel Redux is mostly feature complete; however, some of the planned features are: messages when taking damage; when a player is knocked unconcious (ACE); or killed. These will be able to be toggled on or off, similar to the automated messages for throwing grenades functions. They may each recieve their own settings in the future for more customization options.
+## Usage and modification
+This mod can be freely used by any player or any non-monetized server.<br>
+You are free to modify the mod for you or your group's own purposes if you:
+ - Notify me on Discord (dartruffian).
+ - Acknowledge that a fork Chat Wheel Redux is included in your mod(s).
 
-## Issues
-Experiencing an issue? Check out the [Common Issues post](https://github.com/DartRuffian/A3-ChatWheel-Redux/issues/1) to see if your issue is listed.<br>
-If your issue is not listed, please create one with the appropiate [label](https://github.com/DartRuffian/A3-ChatWheel-Redux/labels).
+---
 
-## Usage & Modification
-This mod can be freely used by any player or any server.<br>
-Future work will remove the need to download and modify the scripts yourself, as the message options available will be moved to a config class instead of being defined in the scripts themselves.
+> "Thank you Dart for making my 'minimum fit for purpose' mod I made for, like, three of my unit members into something legit super accessible to the broader community."
+> <br>- _Jenna_, the original creator of the script this mod is based on. [Source (Legion Studios Discord)](https://ptb.discord.com/channels/461042140756180992/1130867599345987604/1130901200498343938)