https://github.com/muleyuck/jikan.nvim
Braille art clock on your Neovim start screen.
https://github.com/muleyuck/jikan.nvim
clock lua neovim neovim-plugin nvim start-screen startup
Last synced: about 1 month ago
JSON representation
Braille art clock on your Neovim start screen.
- Host: GitHub
- URL: https://github.com/muleyuck/jikan.nvim
- Owner: muleyuck
- License: mit
- Created: 2026-04-21T22:48:39.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-04-25T03:39:32.000Z (about 1 month ago)
- Last Synced: 2026-04-25T04:27:18.595Z (about 1 month ago)
- Topics: clock, lua, neovim, neovim-plugin, nvim, start-screen, startup
- Language: Lua
- Homepage:
- Size: 37.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/muleyuck/jikan.nvim/actions/workflows/unit-test.yml)
[](https://github.com/muleyuck/jikan.nvim/releases/latest)
# jikan.nvim
Your Neovim start screen, replaced by a clock.
jikan.nvim shows the current time when you open Neovim without a file. No configuration, no clutter — just the time.
## Features
- Braille art clock shown automatically on startup
- Blinking colon for a live feel
- Clock color auto-detected from your colorscheme background
- Horizontally and vertically centered in any window size
- Skipped automatically when opening a file (`nvim file.txt`)
- Zero configuration required
## Requirements
- Neovim >= 0.9
## Installation
### lazy.nvim
```lua
{
'muleyuck/jikan.nvim',
lazy = false,
opts = {},
}
```
### vim-plug
```vim
Plug 'muleyuck/jikan.nvim'
```
Then in your `init.lua`:
```lua
require('jikan').setup()
```
### packer.nvim
```lua
use {
'muleyuck/jikan.nvim',
config = function()
require('jikan').setup()
end,
}
```
### mini.deps
```lua
MiniDeps.add('muleyuck/jikan.nvim')
require('jikan').setup()
```
### Manual
```sh
cd ~/.config/nvim/pack/plugins/start
git clone https://github.com/muleyuck/jikan.nvim
```
Then in your `init.lua`:
```lua
require('jikan').setup()
```
## Configuration
No configuration is required. If you want to customize, the following options are available:
```lua
require('jikan').setup({
-- Font for the braille art. Built-in: 'Inter' (default), 'Digital'
font = 'Inter',
-- Fixed foreground color for the clock (e.g. '#AED6F1').
-- When nil, the color is auto-detected from the colorscheme background.
color = nil,
})
```
## Highlights
jikan.nvim defines one highlight group:
| Group | Used for |
|--------------|------------------|
| `JikanClock` | Clock foreground |
The color is set automatically — light on dark backgrounds, dark on light backgrounds. To override:
```lua
vim.api.nvim_set_hl(0, 'JikanClock', { fg = '#your-color' })
```
Or pass `color` in `setup()` to fix it permanently.
## LICENSE
[The MIT License](https://github.com/muleyuck/jikan.nvim/blob/main/LICENSE)