https://github.com/defuncart/kifu_viewer

An application to view Shogi games by loading Kifu files.
https://github.com/defuncart/kifu_viewer

Last synced: 2 months ago
JSON representation

An application to view Shogi games by loading Kifu files.

• Host: GitHub
• URL: https://github.com/defuncart/kifu_viewer
• Owner: defuncart
• License: mit
• Created: 2021-01-16T12:57:47.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-01-01T19:23:33.000Z (6 months ago)
• Last Synced: 2025-03-22T15:22:58.261Z (3 months ago)
• Language: C++
• Homepage:
• Size: 7.18 MB
• Stars: 6
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kifu Viewer

Shogi (将棋) is a two-player strategy board game native to Japan, belonging to the same family as chess and xiangqi. Kifu (棋譜) is the Japanese term for abstract strategy game record.

Kifu Viewer is a desktop application which allows the loading of `kif` files and viewing shogi games. **This application does not feature a shogi engine, thus the user cannot analyze games nor play against the computer.**

## How to Use

A `kif` file can be loaded by either opening a file or pasting from system clipboard. Both these actions can be achieved via the menu bar, shortcuts or via buttons in the upper-right corner of the application.

Once a kif file is loaded, moves can be stepped through using the arrow keys:

| Key   | Action               |

|-------|----------------------|

| UP    | To the initial board |

| LEFT  | Back one move        |

| RIGHT | Forward one move     |

| DOWN  | To the final board   |

![](docs/screenshots/01.gif)

## Download

Please see [https://github.com/defuncart/kifu_viewer/releases](https://github.com/defuncart/kifu_viewer/releases) for the latest desktop release.

The application may also be run in the browser at [https://defuncart.com/kifu_viewer](https://defuncart.com/kifu_viewer).

For Windows, note that C++ redistributable is required to run the app.

## Getting Started

If you would like to build the app yourself, then you simply need:

- Flutter >= 2.10

- Dart >= 2.16

- macOS:

    - Xcode >= 13

    - CocoaPods >= 1.11.2

- windows:

    - Developer Mode enabled

- linux:

    - clang

    - ninja-build

    - libgtk-3-dev

    - libblkid-dev

- web:

    - Chrome

To generate `NotoSansJP-RegularLite.otf`, ensure that `fonttools` is installed and that a copy of `NotoSansJP-Regular.otf` resides in `assets_dev/fonts/`. Then run the following command:

```

pyftsubset assets_dev/fonts/NotoSansJP-Regular.otf --output-file=assets/fonts/NotoSansJP-RegularLite.otf --unicodes-file=assets_dev/fonts/lite_unicode.txt

```

## Raising Issues and Contributing

Please report bugs and issues, and raise feature requests [here](https://github.com/defuncart/kifu_viewer/issues).

To contribute, submit a PR with a detailed description and tests, if applicable.