Git Product home page Git Product logo

mygirlfriendisasleep's Introduction

My Girlfriend Is Asleep

MyGirlfriendIsAsleep is a planned cross-platform script designed to help users turn off their physical displays with the option to automatically turn them back on at a specified time. Especially useful when you want to keep your room dark while streaming content! This will probably require use of a hardware EDID emulator (aka Headless dongle).

Build and Release

Features

  • Cross-Platform: Will eventually work on Windows and Linux. Potential macOS support in the future
  • Dependency Checks: Automatically verifies the presence of required tools and provides installation guidance.
  • Delayed Monitor Activation: With the --shesasleepuntil flag, set a specific time for the monitors to reactivate. Use --force to turn on the display before the set time.

Usage

To run the executable:

  • Turn off the display:

    ./mygirlfriendisasleep off
  • Turn on the display:

    ./mygirlfriendisasleep on
  • Turn off the display and turn it back on at a specified time (e.g., 2:25 PM):

    ./mygirlfriendisasleep off --shesasleepuntil 14:25
  • Turn on the display forcibly (useful after setting a --shesasleepuntil time):

    ./mygirlfriendisasleep on --force

Dependencies

This script interacts with or can trigger the installation of the following software:

  1. nircmd (Windows)

    • Description: A command-line utility for various tasks without a user interface.
    • License: Freeware by NirSoft. Redistribution is permitted, but selling without permission is prohibited.
    • NirSoft nircmd
  2. caffeinate (macOS)

    • Description: A built-in macOS command to prevent the system from sleeping.
    • License: Part of Apple's proprietary macOS. No redistribution.
  3. xset (Linux)

    • Description: A utility from the x11-xserver-utils package, providing user access to several X server settings.
    • License: Typically under the MIT License.
    • X.Org xset

Licensing

MyGirlfriendIsAsleep is licensed under the LGPLv3. Please adhere to the terms of the LGPLv3 when using or redistributing this software.

Third-party tools that the script interacts with have their own licenses, as detailed above. While the script does not redistribute any third-party software, it can facilitate their installation or usage.

Contributing

Contributions, suggestions, and issues are welcome! Open an issue or pull request on the project's repository.


Developed with ❤️ by KTheMan.

mygirlfriendisasleep's People

Contributors

ktheman 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.