Skip to content

Latest commit

 

History

History
98 lines (57 loc) · 3.97 KB

README.md

File metadata and controls

98 lines (57 loc) · 3.97 KB
Raw

NiceStalker

"Day walker, night stalker."

NiceStalker is a simple Discord bot designed to notify users when people become online on Discord. The project name is a playful nod to Night Stalker, a character from the popular game Dota 2.

Picture of an example notification

Features

✅ Real-time notifications: NiceStalker keeps track of users' statuses and sends notifications whenever someone comes online on Discord.

✅ Customizable settings: You can customize your notification preferences, including which users to monitor.

✅ Tray Option: NiceStalker provides a tray icon functionality allowing you to run the app in the background and access it conveniently from the system tray. NiceStalker can also be stopped through the tray icon menu.

✅ Automatic startup: If required, NiceStalker can automatically start up on system boot, ensuring that you never miss out on any important alerts.

✅ Easy-to-use interface for configuring the app NiceStalker offers an intuitive interface to configure the bot's settings. You can easily adjust your notification preferences without the need to use any command-line commands directly.

Installation

Windows

  1. Download the latest release from the Releases page.

  2. Double-click the downloaded .exe file to install the application.

  3. Start the application, configure the settings and press "Start". To automatically run the application on startup, check the corresponding checkbox.

Linux and macOS

Currently, there is no standalone executable for Linux and macOS. You can still run NiceStalker using Python as described below.

Using Python

Pre-requisites

Ensure that you have Python 3.12 installed on your system. Make sure pip is installed. You can check by running pip --version in your terminal.

Installation Steps

To install NiceStalker, follow these steps:

  1. Clone the repository to your local machine.
git clone https://github.com/naghim/NiceStalker.git
  1. Install the necessary dependencies.
python -m pip install -r requirements.txt

  1. Ensure that you are logged into the Discord client.

  2. Optional: Configure the bot: see steps below.

  3. Run the bot.

python -m nicestalker

Adding the --discord flag at the end will only run the bot without the GUI.

Configuration

NiceStalker allows you to customize your notification preferences via a config.json file. The preferred way of configuration is through the GUI. However, you can also edit the config.json file manually.

For manual configuration, follow the steps below to set up your bot:

  1. Create a file named config.json in the root directory of the NiceStalker project.

  2. Use the following scheme to structure your config.json file:

{
  "peopleToStalk": ["discord_username", "discord_displayname"],
  "peopleToIgnore": ["discord_username", "discord_displayname"],
  "runOnStartup": true
}

Replace "discord_username" and "discord_displayname" with the Discord usernames (users' unique identifier) or display names (which is shown to other users) of the individuals you wish to monitor. NiceStalker will notify you whenever these users become online.

Note: NiceStalker also supports partial matches for usernames and display names. If you provide a partial username or display name, NiceStalker will match it with any user whose username or display name contains the provided text.

If the "peopleToStalk" array is left blank, NiceStalker will notify you whenever any user becomes online.

There is also an option to blacklist users. Create another array in the config.json file named "peopleToIgnore" to add users to the list.

NiceStalker can also be configured to run on startup, to do so, add "runOnStartup": true to the config file.