ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Typewriter

by alehandrof ST2/ST3

Typewriter-inspired modes for Sublime Text 3

Details

  • 2 2013.10.01.18.32.29
    3 0.4.0
  • github.​com
  • github.​com
  • 3 months ago
  • 55 minutes ago
  • 2 years ago

Installs

  • Total 1K
  • Win 459
  • OS X 784
  • Linux 192
Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6 Jun 5 Jun 4 Jun 3 Jun 2 Jun 1 May 31 May 30 May 29 May 28 May 27 May 26 May 25 May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16
Windows 0 0 0 0 1 0 0 2 1 0 0 1 0 1 2 1 1 1 0 1 1 2 0 0 0 0 3 2 0 0 0 1 1 2 0 1 0 2 0 0 0 0 1 1 1 0
OS X 1 2 0 2 3 3 3 0 0 2 2 2 1 0 5 2 3 1 0 1 2 1 0 0 1 1 2 2 2 0 0 2 4 6 1 0 2 1 2 1 2 0 2 2 1 2
Linux 0 1 0 0 0 0 0 0 0 0 1 0 0 0 0 0 1 1 0 1 0 1 0 0 1 1 0 0 0 1 0 0 0 2 0 0 0 0 0 0 1 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Typewriter

This plugin provides two typewriter-inspired modes for Sublime Text 3*:

  • Typewriter Scrolling keeps the view centered on the current line, when there is more than half a screenful of text, à la iA Writer, WriteRoom and the like.

    This mode keeps you from craning your neck to look at the bottom of the screen for hours on end. (If you happen to write for hours on end.)

    Thanks to Rahul Ramadas scrolling mode includes mouse support.

  • Typewriter Typing moves your cursor to the end of the file and disables mouse clicks and all commands that move the cursor and/or select text – leaving you only with letters, numbers, symbols, Backspace, Delete and Enter.

    Stay in the flow of writing and don't let your inner editor stifle your verbiage ever again. (Also: experience the joy of not being able to go back and correct your typos.)

* The ST2 version is no longer being maintained.

Installation

This plugin is available through Package Control.

Select the Package Control: Install Package command via the palette and choose the Typewriter package.

Manual Install

  1. Download the latest release from here: https://github.com/alehandrof/Typewriter/releases/
  2. Extract it in your Packages folder. (You can find out its location by clicking the Preferences > Browse Packages… menu inside Sublime Text.)

or

Clone the repository in your Packages folder: git clone https://github.com/alehandrof/Typewriter.git

Usage

The typewriter modes can be toggled via the command palette. Just search for typewriter. There are three commands: one to toggle each mode and one to toggle both modes together.

You can use the typewriter_mode_scrolling setting to enable or disable the Scrolling mode. For example, I have "typewriter_mode_scrolling" : true, in my Distraction Free settings.

The Typing mode needs to be triggered by the typewriter_typing_toggle command. In earlier versions, you could also toggle this mode via a setting, but this doesn't work well in the current version.

Settings

The scrolling mode should work fine as configured. But there are two settings which allow you to tweak the commands that trigger scrolling mode. Look in the settings file for more details.

You can also use offset the centered line in scrolling mode using the typewriter_mode_scrolling_offset setting; positive numbers move the centered line up, while negative ones move it down.

Warnings

  • For best results in Scrolling mode you should set "scroll_past_end": true. (By default it is set to true in Windows and Linux, but false in OSX.)
  • Mouse clicking is disabled in typing mode, but it is possible to scroll.

Changelog & History

  • 0.4.0 - Rahul Ramadas added mouse support.
  • 0.3.1 - Expanded usage warnings
  • 0.3.0 - The mouse is now disabled in both Scrolling and Typing mode. The Typing mode now moves the cursor to the end of the file and is much more robust in general. Because the APIs used are only available for ST3, I will no longer be maintaining the much glitchier ST2 version. (It's still available, though.)
  • 0.2.3 - Added offset option for Scrolling mode (requested by Luis Martins), along with some small fixes & tweaks.
  • 0.2.2 - Typing mode now supports OSX as well.
  • 0.2.1 - Renamed settings to typewriter_mode_scrolling and typewriter_mode_typing so they won't conflict with BufferScroll.
  • 0.2 - Added Typing mode for Windows & Linux. typewriter_mode renamed typewriter_scrolling.
  • 0.1 - Initial release. Typewriter was created upon my request by castles_made_of_sand & facelessuser.

Issues/Todo

  • Neither mode is designed to work with multiple cursors, though nothing terrible is likely to happen. I need to do some more testing with cloned views as well.
  • Figure out how to toggle Typing mode via setting correctly.
  • Per Issue #6, change Scrolling mode to a command that can toggle scroll_past_end if needed.
  • Add Markdown syntax (Current state: rough draft)
  • Add color scheme designed for prose/long text (Current state: near complete) See: Writerly

Alternatives

  • BufferScroll also provides a version of “typewriter scrolling” and many other features besides.
  • MarkdownEditing has added typewriter scrolling among other more Markdown-specific features.