https://github.com/sameersismail/obsidian-perilous-writing

An Obsidian plugin which demands writing output, at the threat of bludgeoning your in-progress work.
https://github.com/sameersismail/obsidian-perilous-writing

obsidian obsidian-md obsidian-plugin writing-tool

Last synced: 25 days ago
JSON representation

An Obsidian plugin which demands writing output, at the threat of bludgeoning your in-progress work.

• Host: GitHub
• URL: https://github.com/sameersismail/obsidian-perilous-writing
• Owner: sameersismail
• License: mit
• Created: 2023-02-10T02:47:27.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-03T06:29:51.000Z (5 months ago)
• Last Synced: 2024-03-01T08:24:36.740Z (4 months ago)
• Topics: obsidian, obsidian-md, obsidian-plugin, writing-tool
• Language: TypeScript
• Homepage: https://perilous.sameerismail.org
• Size: 50.8 KB
• Stars: 22
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• jimsghstars - sameersismail/obsidian-perilous-writing - An Obsidian plugin which demands writing output, at the threat of bludgeoning your in-progress work. (TypeScript)

README

        
# Perilous Writing

An [Obsidian](https://obsidian.md) plugin which *demands* writing output, at the threat of bludgeoning your in-progress work. Emulates [Manu Ebert's](https://github.com/maebert) excellent [The Most Dangerous Writing App](https://github.com/maebert/themostdangerouswritingapp).

[Try it out! ↗](https://perilous.sameerismail.org) ☨

[☨] (Experimental—bug reports welcome.)

# Usage

> **Warning:** If a session is not completed successfully then your in-session work will be **irrevocably deleted**. Caveat emptor.

1. Install the plugin. See below.

2. Open the command palette and choose either a short session (default of five minutes), a long session (default of ten minutes), or a custom-length session. (The respective default durations can be changed in the settings tab.)

    

3. A light gray bar will appear at the top of the editor. It represents the session's progress. The session will begin after the next keypress.

    

4. Begin writing. If you stop writing for five seconds your in-session additions will be **deleted**. You'll be warned after two seconds of inactivity.

    

    

    

5. Only new characters reset the timer—backspace does *not*. Neither do normal-mode operations under Vim emulation. On completion of a successful session, progress is preserved.

    

6. Remove the progress bar with the “Clear session” command.

# Installation

## Community Plugins

Search for [“Perilous Writing”](https://obsidian.md/plugins?search=perilous%20writing) in the community plugins tab.

## Manual

Download the latest release, and copy the `main.js`, `styles.css`, and `manifest.json` files into a new plugin directory, like (4) and (5) below.

## From source

1. Clone the repository.

2. Install the dependencies. Through `yarn` or `npm install` in the directory root.

3. Build the plugin with `yarn build` or `npm run build`. This will produce a `main.js` file.

4. Create a directory for the plugin in your vault's directory.

    ```sh

    mkdir -p $VAULT_SOURCE/.obsidian/plugins/perilous-writing

    ```

5. Copy the `main.js`, `styles.css`, and `manifest.json` files into that directory.

    ```sh

    cp main.js styles.css manifest.json $VAULT_SOURCE/.obsidian/perilous-writing

    ```

6. Enable the plugin in Obsidian's settings tab.

# Acknowledgements

Inspired by [Manu Ebert's](https://github.com/maebert) [The Most Dangerous Writing App](https://github.com/maebert/themostdangerouswritingapp).