Skip to content

Vimlantis is a Neovim plugin inspired by Gitlantis and Ayla Croft (@AylaCroft) that transforms your codebase into an immersive 3D ocean environment. Navigate your files and folders by sailing a boat through a virtual sea!

License

Notifications You must be signed in to change notification settings

JRH89/vimlantis

Repository files navigation

Vimlantis

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

Vimlantis

Inspired by

  • Ayla Croft (@aylacroft)
  • Gitlantis created by @liltrendi.

Install (Neovim or LazyVim)

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

The script checks for Neovim + Node.js, installs dependencies, and wires the plugin into your config. When it finishes, open a project in Neovim (or LazyVim) and run:

:Vimlantis

That’s the whole flow: clone → cd → install → :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 {
  {
    'jrh89/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.

Happy sailing, Pirates! 🌊

About

Vimlantis is a Neovim plugin inspired by Gitlantis and Ayla Croft (@AylaCroft) that transforms your codebase into an immersive 3D ocean environment. Navigate your files and folders by sailing a boat through a virtual sea!

Resources

License

Stars

Watchers

Forks