Skip to content

Commit a1a63d0

Browse files
authored
Merge pull request #70 from Jesewe/violetwing
Renamed all instances of "CS2 TriggerBot" to "VioletWing" in the codebase, build scripts, and documentation.
2 parents fa989cb + 87dc3f9 commit a1a63d0

27 files changed

+2497
-845
lines changed

.github/workflows/build.yml

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,12 @@ on:
66
tag_name:
77
description: "Tag for the release"
88
required: true
9-
default: "v1.2.0"
9+
default: "v1.0.0"
10+
prerelease:
11+
description: "Mark as pre-release"
12+
required: false
13+
default: "false"
14+
type: boolean
1015

1116
permissions:
1217
contents: write
@@ -31,18 +36,23 @@ jobs:
3136
python -m pip install --upgrade pip
3237
pip install -r requirements.txt
3338
39+
- name: Install PyMeow
40+
run: |
41+
curl -LO https://github.com/qb-0/pyMeow/releases/download/1.73.42/pyMeow-1.73.42.zip
42+
pip install pyMeow-1.73.42.zip
43+
3444
- name: Install PyInstaller
3545
run: pip install pyinstaller
3646

3747
- name: Package Application
3848
run: |
39-
pyinstaller --noconfirm --onefile --windowed --icon "src\img\icon.ico" --name "CS2.Triggerbot" --version-file "version.txt" --add-data "classes;classes/" --add-data "gui;gui/" --add-data "src/img/*;src/img" --add-data "src/fonts/*;src/fonts" --add-data "src/*;src" "main.py"
49+
pyinstaller --noconfirm --onefile --windowed --icon "src\img\icon.ico" --name "VioletWing" --version-file "version.txt" --add-data "classes;classes/" --add-data "gui;gui/" --add-data "src/img/*;src/img" --add-data "src/fonts/*;src/fonts" --add-data "src/*;src" "main.py"
4050
4151
- name: Upload Build Artifact
4252
uses: actions/upload-artifact@v4
4353
with:
44-
name: CS2_Triggerbot
45-
path: dist/CS2.Triggerbot.exe
54+
name: VioletWing
55+
path: dist/VioletWing.exe
4656

4757
release:
4858
needs: build
@@ -55,15 +65,15 @@ jobs:
5565
- name: Download Build Artifact
5666
uses: actions/download-artifact@v4
5767
with:
58-
name: CS2_Triggerbot
68+
name: VioletWing
5969
path: ./artifact-download
6070

6171
- name: Verify Downloaded Artifact
6272
run: |
6373
echo "Listing artifact-download directory:"
6474
ls -la ./artifact-download
65-
if [ ! -f ./artifact-download/CS2.Triggerbot.exe ]; then
66-
echo "Error: File CS2.Triggerbot.exe not found in artifact-download directory!"
75+
if [ ! -f ./artifact-download/VioletWing.exe ]; then
76+
echo "Error: File VioletWing.exe not found in artifact-download directory!"
6777
exit 1
6878
fi
6979
@@ -73,21 +83,22 @@ jobs:
7383
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
7484
with:
7585
tag_name: ${{ github.event.inputs.tag_name }}
76-
name: CS2 TriggerBot - Release ${{ github.event.inputs.tag_name }}
86+
name: VioletWing - ${{ github.event.inputs.prerelease == 'true' && 'Pre-release' || 'Release' }} ${{ github.event.inputs.tag_name }}
7787
body_path: ./ChangeLog.md
7888
files: |
79-
./artifact-download/CS2.Triggerbot.exe
89+
./artifact-download/VioletWing.exe
90+
prerelease: ${{ github.event.inputs.prerelease }}
8091

8192
- name: Send Telegram Notification
8293
if: success()
8394
run: |
8495
curl -s -X POST https://api.telegram.org/bot${{ secrets.TELEGRAM_BOT_TOKEN }}/sendMessage \
8596
-d chat_id=${{ secrets.TELEGRAM_CHAT_ID }} \
86-
-d text="🎉 New Release: CS2 TriggerBot ${{ github.event.inputs.tag_name }} has been published! Check it out: ${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.event.inputs.tag_name }}"
97+
-d text="🎉 New ${{ github.event.inputs.prerelease == 'true' && 'Pre-release' || 'Release' }}: VioletWing ${{ github.event.inputs.tag_name }} has been published! Check it out: ${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ github.event.inputs.tag_name }}"
8798
8899
- name: Send Telegram Notification on Failure
89100
if: failure()
90101
run: |
91102
curl -s -X POST https://api.telegram.org/bot${{ secrets.TELEGRAM_BOT_TOKEN }}/sendMessage \
92103
-d chat_id=${{ secrets.TELEGRAM_ADMIN_CHAT_ID }} \
93-
-d text="🚨 Release Failed: CS2 TriggerBot ${{ github.event.inputs.tag_name }}. Check the workflow run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
104+
-d text="🚨 ${{ github.event.inputs.prerelease == 'true' && 'Pre-release' || 'Release' }} Failed: VioletWing ${{ github.event.inputs.tag_name }}. Check the workflow run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"

CONTRIBUTING.md

Lines changed: 64 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing to CS2 TriggerBot
1+
# Contributing to VioletWing
22

3-
Thank you for your interest in contributing to the CS2 TriggerBot project. This guide will assist you from setting up the development environment to submitting pull requests.
3+
Thank you for your interest in contributing to the VioletWing project. This guide outlines the process for setting up your development environment, contributing code, and submitting changes.
44

55
## Table of Contents
66

@@ -16,103 +16,130 @@ Thank you for your interest in contributing to the CS2 TriggerBot project. This
1616

1717
## Code of Conduct
1818

19-
By participating in this project, you agree to abide by the [Code of Conduct](CODE_OF_CONDUCT.md). Please be respectful, considerate, and open to constructive feedback.
19+
By participating, you agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful, inclusive, and open to constructive feedback.
2020

2121
## Getting Started
2222

23-
1. **Fork the Repository**: Create a personal fork of the repository on GitHub.
24-
2. **Clone Your Fork**: Clone your fork to your local environment:
23+
1. **Fork the Repository**: Create a personal fork on GitHub.
24+
2. **Clone Your Fork**: Clone your fork locally:
2525

2626
```bash
27-
git clone https://github.com/Jesewe/cs2-triggerbot.git
28-
cd cs2-triggerbot
27+
git clone https://github.com/Jesewe/VioletWing.git
28+
cd VioletWing
2929
```
3030

31-
3. **Add Upstream Remote**: Stay updated with the original repository:
31+
3. **Add Upstream Remote**: Sync with the original repository:
3232

3333
```bash
34-
git remote add upstream https://github.com/Jesewe/cs2-triggerbot.git
34+
git remote add upstream https://github.com/Jesewe/VioletWing.git
3535
```
3636

3737
## Development Setup
3838

39-
1. **Install Python**: Ensure you have Python version **≥ 3.8** and **< 3.12.5** installed.
39+
1. **Install Python**: Use Python **≥ 3.8** and **< 3.12.5**.
4040
2. **Install Dependencies**: Install required packages:
4141

4242
```bash
4343
pip install -r requirements.txt
4444
```
4545

46-
3. **Run the Application**: Launch the application for testing and development:
46+
3. **Run the Application**: Test the application:
4747

4848
```bash
4949
python main.py
5050
```
5151

5252
### Testing Changes
5353

54-
- Execute the application to verify your modifications.
55-
- Review logs at `%LOCALAPPDATA%\Requests\ItsJesewe\crashes\tb_logs.log` for debugging.
54+
- Run the application to validate changes.
55+
- Check logs at `%LOCALAPPDATA%\Requests\ItsJesewe\crashes\vw_logs.log` or `vw_detailed_logs.log` for debugging.
56+
- Test in Counter-Strike 2 (casual or offline modes) to ensure TriggerBot, Overlay, Bunnyhop, and NoFlash features work as expected.
5657

5758
## Coding Standards
5859

59-
Adhere to the following guidelines for consistency and readability:
60+
Follow these guidelines for consistent, high-quality code:
6061

61-
- **PEP 8**: Follow the [PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/).
62-
- **Naming**: Use clear, descriptive names for variables, functions, and classes.
63-
- **Error Handling**: Handle exceptions gracefully and log errors appropriately.
64-
- **Documentation**: Comment complex or critical sections to explain intent.
65-
- **Modularity**: Decompose large functions into smaller, reusable units.
62+
- **PEP 8**: Adhere to the [PEP 8 style guide](https://www.python.org/dev/peps/pep-0008/).
63+
- **Naming**: Use descriptive, meaningful names for variables, functions, and classes (e.g., `trigger_key` instead of `tk`).
64+
- **Error Handling**: Implement robust exception handling and log errors using the `Logger` class.
65+
- **Documentation**: Add docstrings for functions and comments for complex logic.
66+
- **Modularity**: Break down large functions into smaller, reusable components.
6667

6768
### GUI Development
6869

69-
- **customtkinter**: Use `customtkinter` for any enhancements or changes to the graphical interface.
70+
- **Customtkinter**: Use `customtkinter` for GUI enhancements.
71+
- **Consistency**: Match the existing UI theme (colors, fonts: Chivo, Gambetta) and layout (e.g., scrollable frames, card designs).
72+
- **Responsiveness**: Ensure GUI elements adapt to different window sizes.
73+
74+
### Feature-Specific Guidelines
75+
76+
- **TriggerBot**: Ensure compatibility with offset updates from [cs2-dumper](https://github.com/a2x/cs2-dumper).
77+
- **Overlay (ESP)**: Test visual elements (bounding boxes, snaplines, minimap) in various game resolutions.
78+
- **Bunnyhop**: Verify smooth movement automation across different surfaces.
79+
- **NoFlash**: Confirm flashbang mitigation without affecting game performance.
7080

7181
### Logging
7282

73-
- **Format**: Use the `Logger` class format for log entries.
74-
- **Levels**: Apply appropriate log levels (`INFO`, `WARNING`, `ERROR`) based on severity.
83+
- **Format**: Follow the `Logger` class format for log entries.
84+
- **Levels**: Use appropriate levels (`INFO`, `WARNING`, `ERROR`) based on context.
85+
- **Location**: Logs are saved to `%LOCALAPPDATA%\Requests\ItsJesewe\crashes\`.
7586

7687
## Submitting Issues
7788

78-
Before submitting a new issue:
89+
Before opening an issue:
7990

8091
1. Search existing issues to avoid duplicates.
81-
2. Provide a clear problem description, steps to reproduce, expected behavior, and relevant logs or screenshots.
92+
2. Include:
93+
- A clear description of the problem or bug.
94+
- Steps to reproduce.
95+
- Expected vs. actual behavior.
96+
- Screenshots or log excerpts (from `vw_logs.log` or `vw_detailed_logs.log`).
97+
98+
Use the [Issues tab](https://github.com/Jesewe/VioletWing/issues) and select the appropriate template (e.g., Bug Report).
8299

83100
## Pull Request Process
84101

85-
1. **Create a Branch**: Use a descriptive branch name:
102+
1. **Create a Branch**: Use a descriptive name:
86103

87104
```bash
88-
git checkout -b feature/your-feature
105+
git checkout -b feature/add-new-feature
89106
```
90107

91-
2. **Commit Changes**: Ensure each commit message is concise and descriptive:
108+
2. **Commit Changes**: Write clear, concise commit messages:
92109

93110
```bash
94-
git commit -m "Brief description of changes"
111+
git commit -m "Add bunnyhop timing adjustment in settings"
95112
```
96113

97114
3. **Push to Fork**:
98115

99116
```bash
100-
git push origin feature/your-feature
117+
git push origin feature/add-new-feature
101118
```
102119

103-
4. **Open a Pull Request**: On GitHub, submit a PR to the main repository, including:
120+
4. **Open a Pull Request**: Submit a PR to the main repository, including:
104121

105-
- Purpose of your changes.
106-
- Potential impact on existing functionality.
107-
- Testing steps and results.
122+
- Purpose of the changes (e.g., “Adds NoFlash toggle to General Settings”).
123+
- Impact on existing features (e.g., “No changes to TriggerBot”).
124+
- Testing details (e.g., “Tested in CS2 casual mode, 1920x1080”).
125+
- Screenshots for GUI changes.
108126

109127
### Review Process
110128

111-
- **Code Review**: PRs are reviewed for quality, functionality, and adherence to standards.
112-
- **Feedback**: Address requested changes promptly.
129+
- PRs are reviewed for code quality, functionality, and adherence to standards.
130+
- Respond to feedback promptly and make requested changes.
131+
- PRs may require rebasing if the upstream repository updates:
132+
133+
```bash
134+
git fetch upstream
135+
git rebase upstream/main
136+
git push --force
137+
```
113138

114139
## Feature Requests and Feedback
115140

116-
For new ideas or improvements, open an issue labeled **Feature Request** in the [Issues tab](https://github.com/Jesewe/cs2-triggerbot/issues).
141+
Submit new ideas or improvements via the [Issues tab](https://github.com/Jesewe/VioletWing/issues) with the **Feature Request** label. Include:
117142

118-
We appreciate your contributions to CS2 TriggerBot and your efforts in improving this project!
143+
- Description of the feature (e.g., “Add customizable snapline colors for Overlay”).
144+
- Use case or benefit.
145+
- Any mockups or examples (optional).

ChangeLog.md

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
### Summary
22

3-
- **A complete rework of all GUI elements**.
4-
- Reworking the logic of binding the triggerbot to the side mouse buttons.
5-
- Moved memory functions into a **MemoryManager** class.
6-
- Moved offset initialization to a **Utility** class.
7-
- Updated trigger_bot.py to use the new **MemoryManager** and **Utility** classes.
8-
- Improved styling.
9-
- Improved logging system.
10-
- Fixed logging system in **"Application Logs"** tab.
11-
- Fixed a bug displaying TriggerBot status in the **"DashBoard"** tab.
12-
- Added Line Limiting Logic.
13-
- Added **"Supporters"** tab.
14-
- Added **"Auto-Update"** Logic.
15-
- Added fonts: **Chivo** and **Gambetta**.
16-
- Redesigned the **"Supporters"** tab.
3+
- Renamed all instances of **"CS2 TriggerBot"** to **"VioletWing"** in the codebase, build scripts, and documentation.
4+
- Added new classes for bunnyhop, ESP, and noflash features.
5+
- Implemented new GUI tabs for overlay and trigger settings.
6+
- Integrated new settings into the configuration manager.
7+
- Improved the general settings tab with new options.
8+
- Improved configuration updates.
9+
- Refactored code for better organization and readability.
10+
- Removed unused image files.
11+
- Threads optimization.
12+
- Fixed a bug with the **"Start Client"** and **"Stop Client"** buttons.
13+
- Fixed a bug where `None` values were added to detailed logging.
1714

18-
![Downloads](https://img.shields.io/github/downloads/Jesewe/cs2-triggerbot/v1.2.5/total?style=for-the-badge&logo=github&color=D5006D) ![Platforms](https://img.shields.io/badge/platform-Windows-blue?style=for-the-badge&color=D5006D) ![License](https://img.shields.io/github/license/jesewe/cs2-triggerbot?style=for-the-badge&color=D5006D)
15+
![Downloads](https://img.shields.io/github/downloads/Jesewe/VioletWing/v1.2.5.1/total?style=for-the-badge&logo=github&color=D5006D) ![Platforms](https://img.shields.io/badge/platform-Windows-blue?style=for-the-badge&color=D5006D) ![License](https://img.shields.io/github/license/jesewe/cs2-triggerbot?style=for-the-badge&color=D5006D)

0 commit comments

Comments
 (0)