Stalkpixel

A lightweight Node.js application to stalk Hypixel players

Table of Contents

• Table of Contents
• About The Project
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Specify a List of Players
  • Continuously Follow a Player
  • API Key as Argument
• Acknowledgements

About The Project

Stalkpixel is a lightweight Node.js CLI application that can determine whether and where a player is on the Hypixel Network. It utilizes the Mojang and Hypixel public APIs to get this information. Then, it uses data files from the Slothpixel API to parse this data. Stalkpixel can be used to stalk YouTubers, staff members, your friends, or any other player as long as they haven't turned off Online Status in API Settings in game.

Getting Started

This guide assumes that you have some experience with the terminal.

Prerequisites

To use this application, you must have npm and Node.js installed.

Installation

Run the following command to install Stalkpixel.

npm install -g stalkpixel

You can also clone or download this repository, and then install dependencies manually.

git clone https://github.com/BattleMage0231/Stalkpixel.git
cd stalkpixel
npm install
node . --stalk BattleMage_ # to run

Usage

Before you use the application, you must first run the following command and then set your API key in the JSON file. You can follow these instructions to get your API key. Please be aware that your API key is stored in plaintext form in the configuration file. This means that anybody with access to your device may be able to find your API key.

stalkpixel --config

To run the application, run

stalkpixel

By default, the application calls the APIs with all players specified in config.json. To call it with a different list of players, you can change that list using terminal flags specified in the documentation or see instructions below.

Specify a List of Players

stalkpixel --stalk PLAYER1 PLAYER2 PLAYER3 PLAYER4

The --stalk flag tells the application to call the APIs with the specified list of players rather than with those found in config.json.

Continuously Follow a Player

stalkpixel --follow PLAYER1

The --follow flag tells the application to continously stalk a player once every 5 seconds.

API Key as Argument

stalkpixel --key API_KEY

The --key flag is an alternative method of providing your API key. It overrides the key found in config.json.

Acknowledgements

• Mojang API
• Hypixel API
• Slothpixel Core
• Slothpixel Constants
• README Template