HugoNikanor / VimCC

A port of Vim to the Minecraft mod "ComputerCraft".

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

VimCC

The current pastebin code: Q45Vadaw

By default tab is binded to exit insert mode, this can be rebound in the vimrc!

Dissatisfied with the existing editor in ComputerCraft (seriously, try using it while relying on alt-gr for special characters!) so I decided to port Vim.

This is far from a perfect port, but it gets the job done for quick code edits on the fly. But I would still recommend opening the code files in a more well built editor for longer editing.

Forks

A fork of this program for the "OpenComputers" mod is available here. This is an "official" port, but I'm not personally responsible for its development.

Installation

There are two ways to install the program:

Via the Installer

The installer is both available as part of this repo, and as a download from pastebin, which can be directly gotten in the game by running the following command in a ComputerCraft terminal:

pastebin run Q45Vadaw

Manually

download all the files from here. All files needed for running are in the vimfiles directory.

In ComputerCraft the files need to be placed as following: /utils/vimfiles/*

Then I would also recommend creating a /bin directory and copying the vim file there, and then adding that directory to your path, to allowing for starting vim anywhere without having all the other files clutter up your path.

Updating

Delete the old files and download the new version.

Features and Bugs

Most basic vim movements are here, along with some other features (deletion, merging lines...)

Feature availability

If the feature isn't listed below as not available then it probably is available, or I might just not be aware of it.

Vimrc

There are currently only very limited vimrc support. The default vimrc (with usage information) is avalible here. A user configured file can be placed in the ComputerCraft computers root directory, and must be named .vimrc.

Logging

There are logs, created in the hidden directory .vimlog in the ComputerCraft computers root directory. By default the log level is set to NONE, but this can be changed in the vimrc file.

Currently almost nothing is logged, but the support is there.

Unsupported Features

  • Ex commands!
  • buffers (at least one)
  • undo
  • reverse find (F & T)
  • . (repeat last command)
  • support for commands executed by holding down CTRL and another key
  • Replace mode
  • splits (like the screen is big enough for that...)
  • syntax highlighting (but this shouldn't be to hard)
  • better vimrc support
  • ; & ,
  • (, ), {, }, [[, [], ]], ][
  • searching
  • % (go to matching bracket)
  • Line numbering
  • Characters that aren't ASCII 7 (limitiation in ComputerCraft/Minecraft)
  • useful user configuration

Contributing

If you are interested in trying to add new features or fix the already existing ones, look to the command since there is where both the vi and the ex commands are defined.

If you make changes to the installer, be sure to use upload.py to create a new pastebin link. You will need a pastebin api key, this should be stored in a file named PASTEBIN_API_KEY in the root directory.

General pull requests should be to the master branch. Only create a pull request to another branch if you really believe that the request is only applicable to that branch.

About

A port of Vim to the Minecraft mod "ComputerCraft".

License:MIT License


Languages

Language:Lua 96.9%Language:Python 3.1%