https://github.com/mirthturtle/shimari-extension

Companion to the Shimari Go platform. Modifies OGS with discipline helpers and UX features.
https://github.com/mirthturtle/shimari-extension

baduk discipline go weiqi

Last synced: 11 days ago
JSON representation

Companion to the Shimari Go platform. Modifies OGS with discipline helpers and UX features.

• Host: GitHub
• URL: https://github.com/mirthturtle/shimari-extension
• Owner: mirthturtle
• License: mit
• Created: 2023-07-16T00:09:06.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-08T03:28:41.000Z (about 1 month ago)
• Last Synced: 2024-11-08T04:25:02.015Z (about 1 month ago)
• Topics: baduk, discipline, go, weiqi
• Language: JavaScript
• Homepage: https://mirthturtle.com/shimari
• Size: 781 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Shimari Extension](https://github.com/mirthturtle/shimari-extension/blob/main/img/shimari-extension-border.png "Shimari Extension")

A Chrome Extension for [Go](https://en.wikipedia.org/wiki/Go_(game)) training. Extends [Shimari Go Discipline](https://mirthturtle.com/shimari) to modify your [OGS](https://online-go.com/) experience.

## Features

- **NEW!** Tag moves as you play to review later

- Discipline helpers: Blocks you from starting a new game unless you've:

  - reviewed your last game on [Shimari](https://mirthturtle.com/shimari)

  - recently done a [Pre-game Focus](https://mirthturtle.com/go/pregame)

- Gameover effects: More visually stunning wins and losses. Great for streamers!

## Installation

Installing browser extensions is generally unwise from a security perspective, so Shimari Extension remains open source to allow you to audit the code before installing manually.

- Download or clone this repo

- Open your Chrome Extensions panel (chrome://extensions/) and turn on Developer Mode

- Click "Load Unpacked" and select the downloaded `shimari-extension` folder.

## Usage

After installation, this extension will automatically take effect on OGS.

- To use the discipline blockers, make sure you're logged into Shimari in your browser session.

- To tag moves during play, ensure you've set up an OGS integration for the account you're playing with.

Enable or disable specific features in your [settings](https://mirthturtle.com/go/settings).

## Issues & Contributions

To report a bug or request a new feature, please open an Issue or Pull Request. Thanks!

## Support

If you enjoy this extension, please consider a [Mirth Turtle Membership](https://mirthturtle.com/memberships) or burning some [Raccooncoin](https://mirthturtle.com/raccooncoin). If you use it on stream, a [shoutout](https://twitch.tv/mirthturtle) is always appreciated.

## License

This project's code is released under the MIT License. It also uses images from the [go-assets](https://github.com/atarnowsky/go-assets) repository, available under a [Creative Commons Attribution-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/) license.