Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Crossver 2.0.21 #90

Merged
merged 24 commits into from
Jul 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "crossover",
"productName": "CrossOver",
"version": "1.3.2",
"version": "2.0.0-alpha",
"description": "A Crosshair Overlay for any screen",
"license": "MIT",
"repository": "lacymorrow/crossover",
Expand Down Expand Up @@ -42,11 +42,12 @@
"bindings": "^1.5.0",
"electron-context-menu": "^2.0.1",
"electron-debug": "^3.0.1",
"electron-preferences": "^2.2.0",
"electron-preferences": "../electron-preferences",
"electron-store": "^7.0.0",
"electron-unhandled": "^3.0.2",
"electron-updater": "^4.3.1",
"electron-util": "^0.15.0"
"electron-util": "^0.15.0",
"iohook": "^0.9.3"
},
"devDependencies": {
"ava": "^3.8.2",
Expand All @@ -61,6 +62,21 @@
"spectron": "^13.0.0",
"xo": "^0.37.1"
},
"iohook": {
"targets": [
"node-83",
"electron-85"
],
"platforms": [
"win32",
"darwin",
"linux"
],
"arches": [
"x64",
"ia32"
]
},
"xo": {
"envs": [
"node",
Expand Down
63 changes: 53 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
CrossOver allows you to place a customizable crosshair overlay above any application window.
Improve your aim and gain a competitive advantage with a permanant colored crosshair to mark center screen.

<p align="center" style="background:#282a36;box-shadow: 3px 3px 15px 2px rgba(40,42,54,1);">
<img src="https://github.com/lacymorrow/crossover/raw/master/src/static/meta/demo.png"/>
<p align="center">
<img src="https://github.com/lacymorrow/crossover/raw/master/src/static/meta/demo-main.png"/>
</p>

# Quick Start
Expand Down Expand Up @@ -54,8 +54,8 @@ Improve your aim and gain a competitive advantage with a permanant colored cross
##### [View all dowloads for any OS](https://github.com/lacymorrow/crossover/releases/latest)


<p align="center" style="background:#282a36;box-shadow: 3px 3px 15px 2px rgba(40,42,54,1);">
<img width="390" height="290" src="https://github.com/lacymorrow/crossover/raw/master/src/static/meta/demo2.png"/>
<p align="center">
<img src="https://github.com/lacymorrow/crossover/raw/master/src/static/meta/demo-duplicate.png"/>
</p>

Other crosshair programs offer a single style or color option, and often don't allow you to reposition them. CrossOver is a small, unintrusive crosshair overlay which has plenty of configuration options to assist with aiming and vision of your crosshair. CrossOver offers a huge improvement to many games' default crosshairs for those with colorblindness or contrast issues.
Expand Down Expand Up @@ -102,6 +102,11 @@ Other crosshair programs offer a single style or color option, and often don't a
###### _Further instructions for [Windows](https://www.techjunkie.com/windows-protected-your-pc-disable-smartscreen/) and [Mac](https://support.apple.com/en-us/HT202491)_




<p align="center">
<img src="https://github.com/lacymorrow/crossover/raw/master/src/static/meta/demo-chooser.png"/>
</p>
---

## Usage
Expand All @@ -112,28 +117,66 @@ Other crosshair programs offer a single style or color option, and often don't a

**Choose Crosshair:** Click the bullseye ◎ to select from tons of preloaded crosshairs. Drag an image to the window to use your own custom crosshair.

**Customize** settings using the "gear" icon.
**Customize** settings using the "gear" icon. _See [Settings](#settings) below._

**Unlock the app to quit**. In Windows: right-click > `Close`.
**Unlock the app to quit** using <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>X</kbd>, then click the close icon in the top-left corner. In Windows you can right-click on the crosshair window > `Close`.

#### Keyboard Shortcuts
#### Default Keyboard Shortcuts

Description | Keys
-----------------------| -----------------------
Move the crosshair a single pixel | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>Arrows</kbd>
Toggle the settings window and lock the crosshair in place | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>X</kbd>
Move the crosshair a single pixel | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>Arrows</kbd>
Quickly hide/show the application | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>H</kbd>
Center the crosshair window | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>C</kbd>
Move the crosshair to the next connected display | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>M</kbd>
Duplicate your crosshair in a shadow window | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>D</kbd>
Reset all settings and center the window | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>R</kbd>
Display the "About" window details | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>A</kbd>
Reset all settings and center the window | <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>R</kbd>

###### Mac: the <kbd>Option</kbd> key is used instead of <kbd>Alt</kbd>.
###### Linux: Some distributions do not center on double-click.

<p align="center">
<img src="https://github.com/lacymorrow/crossover/raw/master/src/static/meta/demo-settings.png"/>
</p>
---


## Settings

##### Crosshair
Choose from over 100 real and fictional crosshairs, or use your own by dragging an image to the window. You can change the size and opacity.

##### Reticle
The reticle is the small dot or cross at the center of the sight. You can select the shape and the color, or this can be turned off.

##### Hide on ADS
Choose a mouse button to use as your ADS button. The crosshair will be hidden while this button is held down.

##### Harware acceleration
A handful of users have reported FPS issues with certain games ([#70](https://github.com/lacymorrow/crossover/issues/70)), CrossOver should not add any FPS or latency so if you experience it, toggle this setting on or off and disable [`Hide on ADS`](#hide-on-ads)

##### Start on boot
You can automatically set CrossOver to start when your system starts on your gaming PC, so you're always ready to pop heads.

##### Automatic Updates
By default CrossOver will automatically keep itself updated with bug fixes and improvements. You can disable this in the settings to prevent all network requests.
CrossOver will _only_ connect to GitHub to download published releases and does not send or store _any_ personal data. I'm a solo developer and you aren't important to me 🙂 I just want to game.

#### Keybinds
> See [default keyboard shortcuts](#default-keyboard-shortcuts).
All of the keybinds can be changed or disabled except for the bind to reset all settings. Click into the input and press your bind, or press <kbd>Backspace</kbd> or <kbd>Delete</kbd> to disable a bind.

Keep in mind that keybinds may conflict with other programs so be careful about what you choose. There's no real mechanism for preventing you from setting two conflicting keyinds within the app, so don't do that.

##### Duplicate crosshairs

Duplicate crosshair windows use the same settings as the main window and do not support all of the features of the main window. Settings for duplicate crosshairs will not be saved and all duplicate windows will be closed if the main window is closed.
Duplicate crosshair windows use the same settings as the main window and do not support all of the features of the main window. Settings for duplicate crosshairs will not be saved and all duplicate windows will be closed if the main window is closed. Duplicate crosshairs cannot follow the mouse.

##### Reset
To reset all settings and binds to default, press <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>R</kbd>


<p align="center">
<br />
Expand Down
33 changes: 2 additions & 31 deletions src/config.js
Original file line number Diff line number Diff line change
@@ -1,46 +1,17 @@
'use strict'
const Store = require( 'electron-store' )

// Default app settings
const defaults = {
crosshair: 'static/crosshairs/Actual/leupold-dot.png',
color: '#FFF83B',
appOpacity: 80,
opacity: 80,
positionX: null,
positionY: null,
sight: 'dot',
size: 60,
windowLocked: false,

app: {
DISABLE_GPU: false,
OS_STARTUP: false,
WINDOW_FRAME: false
}
}

// Initialize app state
const config = new Store( {
defaults
} )

// Constants
const APP_HEIGHT = 124
const MAX_SHADOW_WINDOWS = 20
const SETTINGS_WINDOW_HEIGHT = 250
const SETTINGS_WINDOW_DEVTOOLS = false
const SHADOW_WINDOW_OFFSET = 40

const SUPPORTED_IMAGE_FILE_TYPES = [ '.bmp', '.jpg', '.jpeg', '.png', '.gif', '.webp' ]

module.exports = {
config,

defaults,

APP_HEIGHT,
MAX_SHADOW_WINDOWS,
SETTINGS_WINDOW_HEIGHT,
SETTINGS_WINDOW_DEVTOOLS,
SHADOW_WINDOW_OFFSET,

SUPPORTED_IMAGE_FILE_TYPES
Expand Down
Loading