README.md

🎯 Welcome to KOS Sniper! 🎯

Automatically sign up for parallels when a spot opens up!

---

Instalation

Requires Node.js v22.13.1 or higher to run.

# Clone the repository
git pull https://github.com/devicarus/kos-sniper
# Install the dependencies  
cd kos-sniper && npm install 
# Copy the example configuration
cp .env.example .env

Configuration

Most of the configuration is done in the .env file, there are the following properties:

Property	Description	Default
KOS_USERNAME (required)	Your KOS username
KOS_PASSWORD (required)	Your KOS password
SECONDS_BETWEEN_CHECKS	Time between schedule checks in seconds	180
SECONDS_BEFORE_RESTART	Time before the program restarts after an error in seconds	1200
SECONDS_TIMEOUT	Time to wait for KOS to respond before timing out in seconds	30

Which parallels you want is defined in the wishlist.json file like so:

{
  "bi-osy.21": [
    "1P",
    "2P",
    "2C",
    "3L",
    "4C"
  ],
  "bi-ma1.21": [
    "25C",
    "29C"
  ]
}

💭 Tip:
The order indicates your preference to the Sniper, topmost being the most desirable
It will run until it gets a spot in the most preferred parallel, then it will stop

e.g. in the example above, the Sniper will try to get into bi-osy.21 2C first, if it's full, it tries 4C; even if it gets into 4C, it will keep trying to get into 2C until it succeeds

Usage

npm start # That's it, now sit back and relax!

Known Issues

⚠️ Warning: For obvious reasons the program is being worked on only during the schedule creation period

• puppeteer sometimes throws net::ERR_CONNECTION_TIMED_OUT instead of the usual TimeoutError which results in the Sniper throwing a generic error, rather than the specific one. Doesn't affect the functionality of the app.