https://github.com/jwodder/nhmoon

Scrollable terminal calendar highlighting NetHack's new & full moons
https://github.com/jwodder/nhmoon

calendar moon moon-phase nethack ratatui rust terminal tui

Last synced: 2 months ago
JSON representation

Scrollable terminal calendar highlighting NetHack's new & full moons

• Host: GitHub
• URL: https://github.com/jwodder/nhmoon
• Owner: jwodder
• License: mit
• Created: 2023-11-18T13:25:25.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2025-02-03T22:46:46.000Z (3 months ago)
• Last Synced: 2025-02-03T23:28:47.361Z (3 months ago)
• Topics: calendar, moon, moon-phase, nethack, ratatui, rust, terminal, tui
• Language: Rust
• Homepage:
• Size: 160 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)

[![CI Status](https://github.com/jwodder/nhmoon/actions/workflows/test.yml/badge.svg)](https://github.com/jwodder/nhmoon/actions/workflows/test.yml)

[![codecov.io](https://codecov.io/gh/jwodder/nhmoon/branch/master/graph/badge.svg)](https://codecov.io/gh/jwodder/nhmoon)

[![Minimum Supported Rust Version](https://img.shields.io/badge/MSRV-1.80-orange)](https://www.rust-lang.org)

[![MIT License](https://img.shields.io/github/license/jwodder/nhmoon.svg)](https://opensource.org/licenses/MIT)

`nhmoon` is a [Rust](https://www.rust-lang.org) program for viewing & scrolling

through a slice of the calendar in your terminal.  Days with [new or full

moons][moon] in [NetHack][] are highlighted, though the code can easily be

adjusted to use different highlighting criteria instead.

[moon]: https://nethackwiki.com/wiki/Time#Moon_phase_and_date

[NetHack]: https://www.nethack.org

Screenshot of the program on startup on 2025 February 4:

![Screenshot of the program](screenshot.png)

Installation

============

In order to install `nhmoon`, you first need to have [Rust and Cargo

installed](https://www.rust-lang.org/tools/install).  You can then build the

latest version of `nhmoon` and install it in `~/.cargo/bin` by running:

    cargo install --git https://github.com/jwodder/nhmoon

Usage

=====

    nhmoon []

Opens a view of a proleptic Gregorian calendar centered on the given date, or

centered on the current date if no date is given.  Dates are given in the form

`YYYY-MM-DD` using [astronomical year numbering][years].  Only dates from

10,000 BC (-9999 in astronomical year numbering) through 9,999 AD are

supported.

[years]: https://en.wikipedia.org/wiki/Astronomical_year_numbering

Key Bindings

------------

| Key                                | Command                 |

| ---------------------------------- | ----------------------- |

| j, Up        | Scroll up one week      |

| k, Down      | Scroll down one week    |

| w, Page Up   | Scroll up one page      |

| z, Page Down | Scroll down one page    |

| 0, Home      | Jump to today           |

| g                       | Input a date to jump to |

| ?                       | Show help               |

| q, Escape    | Quit                    |

Pressing g brings up an input prompt for entering a date in the form

`YYYY-MM-DD`.  (Enter digits only; the hyphens are filled in for you.)

Pressing - or + at the beginning of the prompt changes

the sign of the year.  Pressing g, q, or

Escape at any point while editing dismisses the prompt.  After

entering eight digits, press Enter to jump to the given date.