{"id":21076073,"url":"https://github.com/shaack/chess-console","last_synced_at":"2025-05-16T06:31:57.675Z","repository":{"id":50905187,"uuid":"137775542","full_name":"shaack/chess-console","owner":"shaack","description":"Browser based, mobile friendly, resposive chess game gui. Uses cm-chessboard  and Bootstrap.","archived":false,"fork":false,"pushed_at":"2024-11-17T23:47:05.000Z","size":1619,"stargazers_count":24,"open_issues_count":2,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-17T23:51:35.325Z","etag":null,"topics":["chess","chessmail","es6","game","javascript","released"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shaack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-18T16:08:46.000Z","updated_at":"2024-11-17T23:47:08.000Z","dependencies_parsed_at":"2023-01-23T12:31:22.218Z","dependency_job_id":"088cb199-0b8c-46b0-be3d-f0109ecc0684","html_url":"https://github.com/shaack/chess-console","commit_stats":{"total_commits":488,"total_committers":1,"mean_commits":488.0,"dds":0.0,"last_synced_commit":"8d0f684faa38a5ff33a84c8ebe57dc6832dd3daa"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaack%2Fchess-console","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaack%2Fchess-console/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaack%2Fchess-console/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shaack%2Fchess-console/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shaack","download_url":"https://codeload.github.com/shaack/chess-console/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225412834,"owners_count":17470459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["chess","chessmail","es6","game","javascript","released"],"created_at":"2024-11-19T19:26:21.636Z","updated_at":"2024-11-19T19:26:22.211Z","avatar_url":"https://github.com/shaack.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# chess-console\n\nChessConsole is a JavaScript-based chess game client framework that uses [cm-chessboard](https://github.com/shaack/cm-chessboard) and [Bootstrap](https://getbootstrap.com/) to create a browser-based, mobile-friendly, responsive chess game GUI.\n\n- **[Repository on GitHub](https://github.com/shaack/chess-console)**\n- **[Demo pages](https://shaack.com/projekte/chess-console)**\n\n### chess-console is used in Production\n\n**[Used by chessmail as a framework for an online chess computer.](https://www.chessmail.eu/pages/chess-computer.html)**\n\n## Component structure\n\nBecause of its component architecture chess-console is expandable for all kind of chess pages. You may check out the [Stockfish Player](https://github.com/shaack/chess-console-stockfish) for chess-console, a fully functional online chess computer.\n\n## Screenshot\n\n![Example chess-console](https://shaack.com/projekte/assets/img/example_chess_console_checkmate.png)\n\n## Installation\n\n### Option 1: Download from GitHub\n\n1. Clone the repository:\n    ```sh\n    git clone https://github.com/shaack/chess-console.git\n    ```\n2. Navigate to the project directory and install dependencies:\n    ```sh\n    cd chess-console\n    npm install\n    ```\n\n### Option 2: Install via npm\n\n1. Install the npm package:\n    ```sh\n    npm install chess-console\n    ```\n\n## Usage\n\n### Initialization\n\nTo initialize a new ChessConsole instance, you need to provide the context, player, opponent, and optional properties.\n\n```javascript\nimport { ChessConsole } from 'chess-console';\n\nconst context = document.getElementById('chess-console');\n// a LocalPlayer, that can be controlled by the user\nconst player = { type: LocalPlayer, name: 'Player 1', props: {} };\n// an engine player, that playes random moves\nconst opponent = { type: RandomPlayer, name: 'Player 2', props: {} };\n\nconst chessConsole = new ChessConsole(context, player, opponent, {\n    locale: 'en',\n    playerColor: 'w',\n    pgn: undefined,\n    accessible: false\n});\n```\n\n## Licenses\n\nSource code license: \u003ca href=\"https://github.com/shaack/chess-console/blob/master/LICENSE\"\u003eMIT\u003c/a\u003e,\u003cbr/\u003e\nLicense for the Sounds: \u003ca href=\"https://creativecommons.org/licenses/by/4.0/\"\u003eCC BY 4.0\u003c/a\u003e,\u003cbr/\u003e\nLicense of the SVG pieces \u003ca href=\"https://creativecommons.org/licenses/by-sa/3.0/\"\u003eCC BY-SA 3.0\u003c/a\u003e.\n\nCopyright \u0026copy; [shaack.com](https://shaack.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshaack%2Fchess-console","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshaack%2Fchess-console","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshaack%2Fchess-console/lists"}