Vimlantis

Transform any project into an explorable 3D ocean directly from Neovim.

Inspired by

• Ayla Croft
• Gitlantis created by @liltrendi.

Install (Neovim or LazyVim)

Linux/macOS:

git clone https://github.com/jrh89/vimlantis.git
cd vimlantis
./install.sh

Windows:

git clone https://github.com/jrh89/vimlantis.git
cd vimlantis
install.bat

The installer will:

• Check for Node.js (v16+) and Neovim
• Install npm dependencies
• Ask how you want to install the Neovim plugin
• Copy files to the correct location for automatic loading

After installation, open any project in Neovim and run:

:Vimlantis

LazyVim specifics

LazyVim users follow the same three shell commands above. The installer can drop a plugin spec into ~/.config/nvim/lua/plugins/vimlantis.lua for you, but here’s the snippet if you prefer to add it manually:

return {
  {
    dir = '~/vimlantis',
    config = function()
      require('vimlantis').setup()
    end,
    keys = {
      { '<leader>vl', '<cmd>Vimlantis<cr>', desc = 'Open Vimlantis' },
    },
  },
}

Everyday usage

1. Open Neovim/LazyVim inside any repo.
2. Run :Vimlantis to launch the 3D view.
3. Sail to a barrel/lighthouse and click to open the file/folder back in Neovim.

Optional command palette:

• :VimlantisClose – stop the session
• :VimlantisToggle – reopen/close quickly

Need help?

• ⭐ Star the repo and open issues for bugs/ideas.
• � Run :Vimlantis after reinstalling if things get out of sync.