mirror of
https://github.com/BubbaGumpShrump/AutoTrackR2.git
synced 2025-05-02 16:55:30 +00:00
Merge pull request #12 from Heavybob/default
Updated Readme and added Git Actions
This commit is contained in:
BubbaGumpShrump
GitHub
commit
82b9e365c1
4 changed files with 156 additions and 67 deletions
71
.github/workflows/build.yml
vendored
Normal file
71
.github/workflows/build.yml
vendored
Normal file
|
|
@ -0,0 +1,71 @@
|
|||
name: Build and Package
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [default]
|
||||
pull_request:
|
||||
branches: [default]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: windows-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
|
||||
- name: Extract version
|
||||
id: version
|
||||
run: |
|
||||
$version = (Select-String -Path "AutoTrackR2/UpdatePage.xaml.cs" -Pattern 'currentVersion = "(.+?)"' | Select-Object -First 1).Matches.Groups[1].Value
|
||||
echo "version=$version" >> $env:GITHUB_OUTPUT
|
||||
|
||||
- name: Setup .NET
|
||||
uses: actions/setup-dotnet@v3
|
||||
with:
|
||||
dotnet-version: "9.0.x"
|
||||
|
||||
- name: Restore dependencies
|
||||
run: dotnet restore AutoTrackR2.sln
|
||||
|
||||
- name: Build
|
||||
run: dotnet build AutoTrackR2.sln --configuration Release --no-restore
|
||||
|
||||
- name: List build output directories
|
||||
run: |
|
||||
Write-Host "Listing build output directories:"
|
||||
Get-ChildItem -Recurse -Directory -Filter "Release" | ForEach-Object { Write-Host $_.FullName }
|
||||
|
||||
- name: Create artifacts directory
|
||||
run: mkdir artifacts
|
||||
|
||||
- name: Copy build output
|
||||
run: |
|
||||
$releaseDir = Get-ChildItem -Recurse -Directory -Filter "Release" | Select-Object -First 1
|
||||
if ($releaseDir) {
|
||||
Write-Host "Copying from: $($releaseDir.FullName)"
|
||||
Copy-Item "$($releaseDir.FullName)\*" "artifacts\" -Recurse
|
||||
} else {
|
||||
Write-Host "No Release directory found"
|
||||
exit 1
|
||||
}
|
||||
|
||||
- name: Upload application artifact
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: AutoTrackR2-${{ steps.version.outputs.version }}
|
||||
path: artifacts/
|
||||
retention-days: 5
|
||||
|
||||
- name: Upload visorwipe script
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: visorwipe.ahk
|
||||
path: AutoTrackR2/scripts/visorwipe.ahk
|
||||
retention-days: 5
|
||||
|
||||
- name: Upload videorecord script
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: videorecord.ahk
|
||||
path: AutoTrackR2/scripts/videorecord.ahk
|
||||
retention-days: 5
|
||||
2
AutoTrackR2/scripts/videorecord.ahk
Normal file
2
AutoTrackR2/scripts/videorecord.ahk
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
; AutoHotkey v2 script to press Win + Alt + G
|
||||
Send("{LWin Down}{Alt Down}g{Alt Up}{LWin Up}") ; Simulate pressing Win + Alt + G
|
||||
2
AutoTrackR2/scripts/visorwipe.ahk
Normal file
2
AutoTrackR2/scripts/visorwipe.ahk
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
; AutoHotkey v2 script to press Alt + X
|
||||
Send("{Alt Down}x{Alt Up}") ; Simulate pressing Alt + X
|
||||
148
README.md
148
README.md
|
|
@ -1,90 +1,104 @@
|
|||
AutoTrackR2 - Star Citizen Kill-Tracking Tool
|
||||
# AutoTrackR2 - Star Citizen Kill-Tracking Tool
|
||||
|
||||
AutoTrackR2 is a powerful and customizable kill-tracking tool for Star Citizen. Designed with gankers and combat enthusiasts in mind, it integrates seamlessly with the game to log, display, and manage your kills, providing detailed information and optional API integration for advanced tracking.
|
||||
|
||||
🚀 Features
|
||||
Log File Integration: Point to Star Citizen's live game.log to track kills in real-time.
|
||||
## Features
|
||||
|
||||
API Integration (Optional):
|
||||
Configure a desired API to send kill data for external tracking or display.
|
||||
Secure your data with an optional API key.
|
||||
- **Log File Integration**: Point to Star Citizen's live game.log to track kills in real-time.
|
||||
- **API Integration (Optional)**:
|
||||
- Configure a desired API to send kill data for external tracking or display.
|
||||
- Secure your data with an optional API key.
|
||||
- **Video Clipping (Optional)**:
|
||||
- Set a path to your clipping software to save kills automatically.
|
||||
- **Visor Wipe Integration (Optional)**:
|
||||
- Automates visor wiping using an AutoHotkey script (`visorwipe.ahk`).
|
||||
- Requires AutoHotkey v2.
|
||||
- Script must be placed in `%LOCALAPPDATA%\AutoTrackR2\`.
|
||||
- **Video Record Integration (Optional)**:
|
||||
- Customize the `videorecord.ahk` script for your specific video recording keybinds.
|
||||
- Requires AutoHotkey v2.
|
||||
- Script must be placed in `%LOCALAPPDATA%\AutoTrackR2\`
|
||||
- **Offline Mode**:
|
||||
- Disables API submissions. The tool will still scrape and display information from the RobertsSpaceIndustries website for the profile of whomever you have killed.
|
||||
- **Custom Themes**:
|
||||
- Easily add or modify themes by adjusting the `ThemeSlider_ValueChanged` function in `ConfigPage.xaml.cs`.
|
||||
- Update the ThemeSlider maximum value in `ConfigPage.xaml` to reflect the number of themes added.
|
||||
|
||||
Video Clipping (Optional):
|
||||
Set a path to your clipping software to save kills automatically.
|
||||
## Setup
|
||||
|
||||
Visor Wipe Integration:
|
||||
Automates visor wiping using an AutoHotkey script (visorwipe.ahk).
|
||||
Requires AutoHotkey v2.
|
||||
Script must be placed in C:\Users\<Username>\AppData\Local\AutoTrackR2\.
|
||||
1. **Prerequisites**:
|
||||
|
||||
Video Record Integration:
|
||||
Customize the videorecord.ahk script for your specific video recording keybinds.
|
||||
Requires AutoHotkey v2.
|
||||
Script must be placed in C:\Users\<Username>\AppData\Local\AutoTrackR2\
|
||||
- Windows 10 or later
|
||||
- .NET Framework 4.7.2 or higher
|
||||
- Star Citizen installed
|
||||
- AutoHotkey v2 (optional - only needed for visor wipe and video recording features):
|
||||
- Download from the official website at https://www.autohotkey.com/
|
||||
- Install AutoHotkey v2 (not v1.x as they are not compatible)
|
||||
- Verify installation by right-clicking on your desktop and confirming "New > AutoHotkey v2 Script" appears in the context menu
|
||||
|
||||
Offline Mode:
|
||||
Disables API submissions. The tool will still scrape and display information from the RobertsSpaceIndustries website for the profile of whomever you have killed.
|
||||
2. **Installation Steps**:
|
||||
|
||||
Custom Themes:
|
||||
Easily add or modify themes by adjusting the ThemeSlider_ValueChanged function in ConfigPage.xaml.cs.
|
||||
Update the ThemeSlider maximum value in ConfigPage.xaml to reflect the number of themes added.
|
||||
- Download the latest release package from the releases page
|
||||
- Run the installer and follow the on-screen instructions
|
||||
- Launch AutoTrackR2 after installation completes
|
||||
|
||||
📁 Configuration
|
||||
Log File:
|
||||
Specify the path to Star Citizen's game.log.
|
||||
3. **Initial Configuration**:
|
||||
- Open the Configuration panel within the application
|
||||
- Set the path to your Star Citizen game.log file (typically found in `[Star Citizen Install Path]\LIVE\game.log`)
|
||||
- Configure API settings if desired (leave blank for offline mode)
|
||||
- Set up video clipping paths if using this feature
|
||||
- If using AutoHotkey features, verify the scripts are properly placed in the `%LOCALAPPDATA%\AutoTrackR2\` location
|
||||
|
||||
API Settings (Optional):
|
||||
## Configuration
|
||||
|
||||
API URL: Provide the endpoint for posting kill data.
|
||||
- **Log File**:
|
||||
- Specify the path to Star Citizen's `game.log`.
|
||||
- **API Settings (Optional)**:
|
||||
- API URL: Provide the endpoint for posting kill data.
|
||||
- API Key: Secure access to the API with your unique key.
|
||||
- **Video Clipping Path (Optional)**:
|
||||
- Set the directory where your clipping software saves kills.
|
||||
- **Visor Wipe Setup (Optional)**:
|
||||
- Place `visorwipe.ahk` in `%LOCALAPPDATA%\AutoTrackR2\`.
|
||||
- AutoHotkey v2 is required.
|
||||
- **Video Recording Setup (Optional)**:
|
||||
- Modify `videorecord.ahk` to use the keybinds of your video recording software.
|
||||
- Place `videorecord.ahk` in `%LOCALAPPDATA%\AutoTrackR2\`.
|
||||
- AutoHotkey v2 is required.
|
||||
- **Offline Mode**:
|
||||
- Enable to disable API submission. Restart the tracker to apply changes.
|
||||
|
||||
API Key: Secure access to the API with your unique key.
|
||||
## Privacy & Data Usage
|
||||
|
||||
Video Clipping Path (Optional):
|
||||
Set the directory where your clipping software saves kills.
|
||||
- **No Personal Data Collection**:
|
||||
- AutoTrackR2 does not collect or store personal or system information, other than common file paths to manage necessary files.
|
||||
- **Access and Permissions**:
|
||||
- The tool reads its own `config.ini` and the `game.log` from Star Citizen. It will also create a CSV file of all your logged kills, stored locally on your machine in the `%LOCALAPPDATA%\AutoTrackR2\` folder.
|
||||
- **Optional Data Submission**:
|
||||
- Data is only sent to an API if explicitly configured by the user. Offline Mode disables all outgoing submissions.
|
||||
- **Killfeed Scraping**:
|
||||
- The program scrapes the profile page of killed players to display their information locally. This feature remains active even in Offline Mode.
|
||||
|
||||
Visor Wipe Setup:
|
||||
Place visorwipe.ahk in C:\Users\<Username>\AppData\Local\AutoTrackR2\.
|
||||
AutoHotkey v2 is required.
|
||||
## Customization
|
||||
|
||||
Video Recording Setup:
|
||||
Modify videorecord.ahk to use the keybinds of your video recording software.
|
||||
Place videorecord.ahk in C:\Users\<Username>\AppData\Local\AutoTrackR2\.
|
||||
AutoHotkey v2 is required.
|
||||
|
||||
Offline Mode:
|
||||
Enable to disable API submission. Restart the tracker to apply changes.
|
||||
|
||||
🛡️ Privacy & Data Usage
|
||||
No Personal Data Collection:
|
||||
AutoTrackR2 does not collect or store personal or system information, other than common file paths to manage necessary files.
|
||||
|
||||
Access and Permissions:
|
||||
The tool reads its own config.ini and the game.log from Star Citizen. It will also create a CSV file of all your logged kills, stored locally on your machine in the AppData folder.
|
||||
|
||||
Optional Data Submission:
|
||||
Data is only sent to an API if explicitly configured by the user. Offline Mode disables all outgoing submissions.
|
||||
|
||||
Killfeed Scraping:
|
||||
The program scrapes the profile page of killed players to display their information locally. This feature remains active even in Offline Mode.
|
||||
|
||||
⚙️ Installation
|
||||
Download the latest release from the releases page.
|
||||
Follow the setup instructions included in the installer.
|
||||
Configure the tool using the settings outlined above.
|
||||
|
||||
💡 Customization
|
||||
To customize themes or behaviors:
|
||||
|
||||
Add Themes:
|
||||
Update the ThemeSlider_ValueChanged function in ConfigPage.xaml.cs with your desired colors and logos.
|
||||
Adjust the ThemeSlider maximum value in ConfigPage.xaml to match the number of themes.
|
||||
- **Add Themes**:
|
||||
- Update the `ThemeSlider_ValueChanged` function in `ConfigPage.xaml.cs` with your desired colors and logos.
|
||||
- Adjust the ThemeSlider maximum value in `ConfigPage.xaml` to match the number of themes.
|
||||
- **Modify AHK Scripts (Optional)**:
|
||||
- Edit `visorwipe.ahk` and `videorecord.ahk` to fit your specific keybinds and preferences.
|
||||
|
||||
Modify AHK Scripts:
|
||||
Edit visorwipe.ahk and videorecord.ahk to fit your specific keybinds and preferences.
|
||||
## Support
|
||||
|
||||
📞 Support
|
||||
For questions, issues, or feature requests, please visit discord.gg/griefernet.
|
||||
For questions, issues, or feature requests:
|
||||
|
||||
- Join our Discord server: [discord.gg/griefernet](https://discord.gg/griefernet)
|
||||
- Report bugs through the Discord's #autotrackr-bugs channel
|
||||
- For urgent issues, you can escalate in Discord by tagging moderators
|
||||
|
||||
## License
|
||||
|
||||
🔒 License
|
||||
AutoTrackR2 is released under the GNU v3 License.
|
||||
|
||||
GRIEFERNET VICTORY!
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue