https://github.com/lopi-py/kickstart-roblox.nvim
https://github.com/lopi-py/kickstart-roblox.nvim
Last synced: 23 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lopi-py/kickstart-roblox.nvim
- Owner: lopi-py
- License: mit
- Created: 2024-04-27T02:27:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-24T18:33:09.000Z (5 months ago)
- Last Synced: 2025-05-07T03:03:48.416Z (about 2 months ago)
- Language: Lua
- Size: 47.9 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kickstart-roblox.nvim
Starting point for your Neovim configuration for Roblox. This is **NOT** a Neovim distro.
## Requirements
- Neovim 0.10+
- A C++ compiler (gcc, g++, clang, etc)
- A [nerd font](https://www.nerdfonts.com/) (optional)
## Features
- Single and small configuration file
- Detailed comments to understand the configuration
- Support for editing your Neovim config
- Support for Roblox lua/luau projects
- Support for Roblox typescript projects
- Support for luau-lsp studio plugin
- Git integration
- LSP configuration:
+ Autoimports
+ Completion
+ Diagnostics
+ Go to definition
- Snippets
- Format on save
- Fuzzy file finder
- Syntax highlight
## Installation
### I do not have a config (first time using Neovim)
Download [init.lua](https://github.com/lopi-py/kickstart-roblox.nvim/blob/main/init.lua) and place it into your Neovim config
Linux and Mac
```bash
mkdir ~/.config/nvim
cd ~/.config/nvim
curl https://raw.githubusercontent.com/lopi-py/kickstart-roblox.nvim/main/init.lua -o ~/.config/nvim/init.lua
```
Windows (powershell)
```bash
mkdir ~\AppData\Local\nvim
cd ~\AppData\Local\nvim
curl https://raw.githubusercontent.com/lopi-py/kickstart-roblox.nvim/main/init.lua -o $env:USERPROFILE\AppData\Local\nvim\init.lua
```
Start Neovim in your project folder
```bash
nvim
```
### I already have a config (I just want to try)
Linux and Mac
```bash
curl https://raw.githubusercontent.com/lopi-py/kickstart-roblox.nvim/main/init.lua -o /tmp/kickstart-roblox.lua
# start Neovim in your project folder
nvim -u /tmp/kickstart-roblox.lua
```
Windows (powershell)
```bash
curl https://raw.githubusercontent.com/lopi-py/kickstart-roblox.nvim/main/init.lua -o $env:USERPROFILE\Downloads\kickstart-roblox.lua
# start Neovim in your project folder
nvim -u $env:USERPROFILE\Downloads\kickstart-roblox.lua
```
## Getting Started
Here are some essential key mappings to help you navigate and search through your files efficiently:
- `sf`: Search files - Quickly find and open files within the project.
- `sg`: Search by grep - Perform a text search within your project files using grep.
- ``: List opened buffers - View and switch between currently opened buffers.