Code Monkey home page Code Monkey logo

nightlight-uploader's Introduction

Nightlight Uploader

Nightlight Uploader is a simple tool written in Rust to automate the process of uploading Dead by Daylight end game scoreboard screenshots to the Nightlight website. It eliminates the manual effort required to capture and upload screenshots, providing convenience for Linux users who cannot use the Windows-only desktop app.

Features

  • Takes screenshots of the Dead by Daylight end game scoreboard.
  • Uploads the screenshots to the Nightlight website.
  • Simple configuration using environment variables or directly in the code.

Building

Prerequisites

Before building Nightlight Uploader on linux, ensure you have the following dependencies installed:

  • libxcb
  • libxrandr
  • dbus
  • OpenSSL

Building from Source

Nightlight Uploader is built using Cargo, the Rust package manager. Follow these steps to build and install the application:

  1. Clone the repository:

    git clone https://github.com/Nyjako/nightlight-uploader.git
  2. Navigate to the project directory:

    cd nightlight-uploader
  3. Set NIGHTLIGHT_API_KEY varible with your Nightlight API key:

    • Export before starting app:

      export NIGHTLIGHT_API_KEY="your_api_key"
    • In the .cargo/config.toml file:

      [env]
      NIGHTLIGHT_API_KEY = "your_api_key"
    • directly in the code:

      const API_KEY: &str = "your api key";
  4. Build the project:

    cargo build --release
  5. Run the application:

    cargo run --release

Usage

  1. Press the configured hotkey (default: CTRL + Numpad1) when the end game scoreboard is visible to take a screenshot.
  2. Nightlight Uploader will automatically upload the screenshot to the Nightlight website.
  3. To exit the application, press the exit hotkey (default: CTRL + Numpad2).
  4. You need to verify your uploads on NightLight website

Configuration

Hotkeys

Hotkeys for capturing screenshots and exiting the application can be customized by modifying the code:

let capture_hotkey = HotKey::new(Some(Modifiers::CONTROL), Code::Numpad1);
let exit_hotkey    = HotKey::new(Some(Modifiers::CONTROL), Code::Numpad2);

Planned Features

  • Automatic detection of the end game scoreboard to streamline the process further.

Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request on GitHub.

License

This project is licensed under the MIT License - see the LICENSE file for details.

nightlight-uploader's People

Contributors

nyjako avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.