image.nvim

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #llm #golang #machine-learning #rust #deep-learning #macos #vue #awesome-list #mcp #ios

(★ 170)

🖼️ Image Viewer as ASCII Art for Neovim written in Lua

파일 탐색기

최종 버전 다운로드 (.zip)

- - format.yml
  - lint.yml
- - config.lua
  - init.lua
.editorconfig
.gitignore
.luacheckrc
.stylua.toml
LICENSE
README.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

> [!NOTE]
> Due to lack of time, this plugin has been archived. Please switch to a newer and maintained [3rd/image.nvim](https://github.com/3rd/image.nvim).

<h1 align="center">image.nvim</h1>

<p align="center">
	<b>Image Viewer as ASCII Art for Neovim, written in Lua</b>
</p>

## Features
- Supports many file formats (.png, .jpg, .jpeg, .bmp, .webp, ...)
- Colored images
- Almost **no code** runs on startup
- Rendering with a [dither](https://en.wikipedia.org/wiki/Dither) method makes images more visible than traditional ascii art
- Images are centered and have labels!

## How does it work?
When you open an image file (e.g. `portrait.png`), the open buffer becomes non-editable and non-saveable to ensure the file contents won't be overwritten. Then the buffer is filled with the ascii art generated by [ascii-image-converter](https://github.com/TheZoraiz/ascii-image-converter). I found out that a plugin similiar to this was already implemented for vim in vimscript: [image.vim](https://github.com/ashisha/image.vim), so you can consider this a modern, lua version.

## Prerequisites
- Install [ascii-image-converter](https://github.com/TheZoraiz/ascii-image-converter) and make sure it is in your path
- [plenary.nvim](https://github.com/nvim-lua/plenary.nvim)
- [baleia.nvim](https://github.com/m00qek/baleia.nvim) (optional for color support)
- Neovim 0.7+

## Install 
With packer
```lua
use {
  'samodostal/image.nvim',
  requires = {
    'nvim-lua/plenary.nvim'
  },
},
```
With vim.plug
```lua
Plug 'samodostal/image.nvim'
Plug 'nvim-lua/plenary.nvim'
```

## Setup
```lua
-- Require and call setup function somewhere in your init.lua
require('image').setup {
  render = {
    min_padding = 5,
    show_label = true,
		show_image_dimensions = true,
    use_dither = true,
    foreground_color = false,
    background_color = false
  },
  events = {
    update_on_nvim_resize = true,
  },
}
```

## Colors support:
**Colors are turned off by default.**
- The reason for colors not being on by default is a significant delay when opening images + an additional dependency: plugin [baleia.nvim](https://github.com/m00qek/baleia.nvim) (no need to call setup, only install)
- Enable options`render.foreground_color` and `render.background_color`
- `render.background_color` setting is a nice addition that enables colors not only for characters, but also for the space behind them.

image.nvim

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

image.nvim

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README