Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MaximilianLloyd/ascii.nvim
A collection of ascii art as lua tables
https://github.com/MaximilianLloyd/ascii.nvim
lua neovim neovim-plugin
Last synced: 13 days ago
JSON representation
A collection of ascii art as lua tables
- Host: GitHub
- URL: https://github.com/MaximilianLloyd/ascii.nvim
- Owner: MaximilianLloyd
- Created: 2022-10-13T22:12:50.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-05-12T05:06:02.000Z (6 months ago)
- Last Synced: 2024-08-01T22:54:09.229Z (3 months ago)
- Topics: lua, neovim, neovim-plugin
- Language: Lua
- Homepage:
- Size: 827 KB
- Stars: 169
- Watchers: 3
- Forks: 12
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Ascii.nvim
A curated collection of ascii art and utilities for your Neovim dashboard.
---
## Installaton
- Install using your favorite plugin manager (here i'm using packer)
- Nui.nvim is used for preview functionality
```lua
...
use({ "MaximilianLloyd/ascii.nvim", requires = {
"MunifTanjim/nui.nvim"
} })
...
```
Then set the art you want in your dashboard configuration. Here i'm using alpha.nvim.
Set a specific art piece.
```lua
...
local options = {
header = {
...
val = ascii.art.animals.dogs.lucky,
...
},
}
...
```
Or get one at random
```lua
...
local options = {
header = {
...
val = ascii.get_random_global(),
...
},
}
...
```
Or get one at random from a subcategory.
```lua
...
local options = {
header = {
...
val = ascii.get_random("animals", "dogs"),
...
},
}
...
```
---
## Usage
See what subcategories are available.
### Browse using poup
```lua
lua require("ascii").preview()
```
`j` to move down in the list and `k` to move up. The path is the value that can be copied to your dashboard configuration.
---
Non-popup way to browse plugins.
```lua
lua require("ascii").print_category("animals")
```
Preview the art available in the subcategory.
```lua
lua require("ascii").print_subcategory("animals", "dogs")
```
Get a random art piece from a subcategory.
```lua
lua require("ascii").get_random("animals", "dogs")
```
## Telescope integration
```lua
telescope.load_extension("ascii")
```
Then you can do
```
Telescope ascii
```
To fuzzy search. The name is the path you can use in your config.
## Categories
- Animals
- [Dogs](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/animals/dogs.lua)
- [Cats](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/animals/cats.lua)
- [Lions](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/animals/lions.lua)
- [Pandas](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/animals/pandas.lua)
- Anime
- [One Piece](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/anime/onepiece.lua)
- Movies
- [Starwars](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/movies/starwars.lua)
- Gaming
- [Doom](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/gaming/doom.lua)
- [Pacman](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/gaming/pacman.lua)
- [Undertale](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/gaming/undertale.lua)
- Misc
- [Hydra](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/misc/hydra.lua)
- [Skulls](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/misc/skulls.lua)
- [Krakens](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/misc/krakens.lua)
- Text
- [Slogons](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/text/slogons.lua)
- [Neovim](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/text/neovim.lua)
- [Doom](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/text/doom.lua)
- Planets
- [Planets](https://github.com/MaximilianLloyd/ascii.nvim/blob/master/lua/ascii/planets/planets.lua)
## Create your own and contribute
I created a small [rust cli tool](https://github.com/MaximilianLloyd/ascii-lua-table) that converts ascii art to a lua table, so you can easily contribute.
---
### Todo
- [x] Implement telescope extension
- [ ] Random independant of category