chess_bead
Package for the both chess and Chinese poetry game. Inspired by Das Glasperlenspiel by Hermann Hesse.
Science Score: 67.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.6%) to scientific vocabulary
Keywords
chess-game
chinese-chess
chinese-language
esoteric
package
Last synced: 6 months ago
·
JSON representation
·
Repository
Package for the both chess and Chinese poetry game. Inspired by Das Glasperlenspiel by Hermann Hesse.
Basic Info
- Host: GitHub
- Owner: nevmenandr
- License: agpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://chess-bead.readthedocs.io/en/latest/
- Size: 8.84 MB
Statistics
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 1
Topics
chess-game
chinese-chess
chinese-language
esoteric
package
Created over 4 years ago
· Last pushed over 1 year ago
Metadata Files
Readme
License
Citation
README.rst
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.12814015.svg
:target: https://doi.org/10.5281/zenodo.12814015
|License| |Docs| |Contact| |Site|
Chess Bead Game ♖♝♘♟️♕
=================
Description
----------------
Package for the both chess and Chinese poetry game. The rules of the game involve chess moves from games in pgn format. The board for the game is a Chinese poem of the Tang era, in which the line is equal to 7 characters (the last, 8th vertical is most often punctuation marks). When a piece makes a move, the characters on the board change places. The character on which the piece was is moved to the place of the character to which the move was made.
.. figure:: https://github.com/nevmenandr/chess_bead/raw/main/example/game21_poem130.gif
:scale: 40 %
:align: center
:alt: How the game works.
You can get the result texts and visualize it with the package.
You can use custom game in PGN format.
Inspired by Das Glasperlenspiel by Hermann Hesse.
Quick start
----------------
.. code:: python
import chess_bead as cb
g = cb.Game() # use random chess game from the example PGN
# file included in the package
verses = g.start_game() # get all the permutations in the poem
v = cb.Viz(verses, g.author, g.title) # prepare visualization
v.gif() # make the GIF animation with the name
#'game.gif' in the working directory
del v # clean up the tmp dir
Installation
----------------
The tool could be installed with pip
::
pip3 install chess_bead
Examples and Docs
-------------------
You can explore the `brief examples `_ that could give you a clue. For the deep sinking read the `documentation `_.
* The package uses cwTeXFangSong font licensed with SIL Open Font License (Version 1.1), `see here `_ .
* `Compiled TTFs `_ .
.. |License| image:: https://img.shields.io/badge/license-GPL-blue.svg
:target: https://opensource.org/licenses/GPL-3.0
.. |Docs| image:: https://readthedocs.org/projects/numeral-system-py/badge/?version=latest&style=flat
:target: https://chess-bead.readthedocs.io/en/latest/
.. |Contact| image:: https://img.shields.io/badge/telegram-write%20me-blue.svg
:target: https://t.me/nevmenandr
.. |Site| image:: https://img.shields.io/badge/site-nevmenandr-yellowgreen.svg
:target: http://nevmenandr.net/bo.php
Owner
- Name: Boris Orekhov
- Login: nevmenandr
- Kind: user
- Location: Moscow
- Website: https://nevmenandr.github.io
- Twitter: nevmenandr
- Repositories: 42
- Profile: https://github.com/nevmenandr
Digital humanities researcher
Citation (CITATION.cff)
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!
cff-version: 1.2.0
title: Chess Bead Game
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Boris
family-names: Orekhov
email: nevmenandr@gmail.com
affiliation: HSE University
orcid: 'https://orcid.org/0000-0002-9099-0436'
identifiers:
- type: doi
value: 10.5281/zenodo.12814015
repository-code: 'https://github.com/nevmenandr/chess_bead'
url: 'https://chess-bead.readthedocs.io/en/latest/'
abstract: >-
Package for the both chess and Chinese poetry game. The
rules of the game involve chess moves from games in pgn
format. The board for the game is a Chinese poem of the
Tang era, in which the line is equal to 7 characters (the
last, 8th vertical is most often punctuation marks). When
a piece makes a move, the characters on the board change
places. The character on which the piece was is moved to
the place of the character to which the move was made.
keywords:
- chess
- go game
license: GPL-3.0
commit: 484218477ea0348679e42ee53ee2b2c593d6f282
version: 1.0.0
date-released: '2021-09-06'
GitHub Events
Total
Last Year
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 30 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
- Total maintainers: 1
pypi.org: chess_bead
Package for the both Chinese poetry and chess game. The rules of the game
- Homepage: https://github.com/nevmenandr/chess_bead
- Documentation: https://chess_bead.readthedocs.io/
- License: GNU General Public License v3 or later (GPLv3+)
-
Latest release: 1.0.2
published over 4 years ago
Rankings
Dependent packages count: 6.6%
Stargazers count: 23.8%
Average: 24.2%
Forks count: 28.4%
Dependent repos count: 30.6%
Downloads: 31.4%
Maintainers (1)
Last synced:
6 months ago
Dependencies
docs/requirements.txt
pypi
- sphinx ==2.3.1
- sphinx_rtd_theme ==0.4.3
.github/workflows/build.yml
actions
- actions/checkout v2 composite
- actions/setup-python v2 composite
- codecov/codecov-action v1 composite
.github/workflows/publish.yml
actions
- actions/checkout v2 composite
- actions/setup-python v2 composite
pyproject.toml
pypi