diff --git a/README.md b/README.md index 5c9c748..fc61353 100644 --- a/README.md +++ b/README.md @@ -1,71 +1,99 @@ ---- - -# Blitz for League ONLY - -An Electron-based application that automatically starts the Blitz app when the League of Legends client or game is running and closes Blitz when they are not. - -## Features - -- Monitors the presence of both the `LeagueClient.exe` (the launcher) and `League of Legends.exe` (the game client). -- Automatically launches the Blitz app when either of the League processes is detected. -- Closes the Blitz app when neither of the League processes is active. -- System tray interface for easy toggling of monitoring and setting the Blitz executable path. -- Option to start the application on system boot. +# Pairkiller + +
+ +
+ ++ Key Features • + Installation • + How To Use • + Configuration • + Download +
+ +## Key Features + +* **Dynamic App Monitoring** - Monitor multiple applications and respond to their states +* **Flexible Group Configuration** - Create groups with different monitoring conditions +* **Smart Actions** - Multiple action types for controlled apps: + - Start when triggered + - Stop when triggered + - Sync with trigger (run alongside) + - Opposite of trigger (run inversely) +* **Reverse Logic** - Invert any group's behavior with a single click +* **System Tray Integration** - Runs quietly in your system tray +* **Auto-Updates** - Always stay up to date with the latest features +* **Cross Platform** - Windows support, with macOS and Linux coming soon ## Installation -### Downloading from Releases +Download the latest version from the [releases page](https://github.com/hybes/pairkiller/releases) and run the installer. -1. Go to the [Releases](https://github.com/Hybes/blitz-for-league-only/releases) section of the GitHub repository. -2. Download the latest release for your platform (Windows). -3. Install the application by following the on-screen instructions. +## How to Use -### Handling Windows SmartScreen +1. **Create a Group** + - Click "Add New Group" + - Give your group a name + - Choose monitoring condition (All or Any) + - Optionally enable reverse logic -When installing applications downloaded from the internet, Windows SmartScreen might show a warning. This is a security feature to help protect against unrecognized or malicious applications. To continue the installation: +2. **Add Monitored Apps** + - Click "Add App" in the Monitored Apps section + - Browse to select your application + - Repeat for all apps you want to monitor -1. Click on "More Info". -2. Select "Run Anyway". -3. Follow the installation prompts. +3. **Add Controlled Apps** + - Click "Add App" in the Controlled Apps section + - Browse to select your application + - Choose the desired action: + * Start when triggered + * Stop when triggered + * Sync with trigger + * Opposite of trigger -### Building from Source +4. **Save and Run** + - Click "Save & Close" + - The app will run in your system tray + - Right-click the tray icon for options -1. Clone the repository: - ``` - git clone https://github.com/Hybes/blitz-for-league-only.git - ``` +## Configuration -2. Navigate to the project directory: - ``` - cd blitz-for-league-only - ``` +### Group Settings +- **Name**: Identify your group +- **Condition**: Choose between: + * All apps must be running + * Any app must be running +- **Reverse Logic**: Invert the condition -3. Install the necessary dependencies: - ``` - npm install - ``` +### App Actions +- **Start when triggered**: Launches the app when condition is met +- **Stop when triggered**: Closes the app when condition is met +- **Sync with trigger**: Runs alongside monitored apps +- **Opposite of trigger**: Runs inverse to monitored apps -4. Build the application: - ``` - npm run build - ``` +## Development -5. The built application will be available in the `dist` folder. +```bash +# Clone this repository +git clone https://github.com/hybes/pairkiller -## Usage +# Install dependencies +npm install -1. Start the application. An icon will appear in the system tray. -2. Right-click on the system tray icon to access the options: - - **Toggle Monitoring**: Start or stop the automatic monitoring of the League processes. - - **Set Blitz Path**: If you have a custom installation path for Blitz, use this option to select the Blitz executable. - - **Start on Boot**: Enable or disable starting the application automatically when your system boots. +# Run the app +npm start -## Safety and Anti-virus +# Build the app +npm run build +``` -The application performs simple monitoring tasks and doesn't engage in any behaviors that would typically trigger anti-virus software. However, always ensure that you download the application from the official GitHub repository or trusted sources. +## License -## Contributing +MIT -Contributions are welcome! Please fork the repository and create a pull request with your changes, or open an issue to discuss potential improvements or bug fixes. +## Credits ---- +Created by [Ben Hybert](https://github.com/hybes) diff --git a/about.html b/about.html index a6a0267..dfbb684 100644 --- a/about.html +++ b/about.html @@ -81,15 +81,11 @@Built by Ben Hybert
-I made this because Fraser plays all the other Blitz games, but doesn't want Blitz to be used in them.
-I made this because Fraser plays all the Blitz games, but doesn't want Blitz to be used in any except League of Legends.