-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
112 changed files
with
567 additions
and
407 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2023 rodpolako | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| MIT License | ||
| Copyright (c) 2023 rodpolako | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,69 +1,69 @@ | ||
| # Chess PGN Trainer | ||
| Online tool that opens chess PGN files and allows the user to practice the moves. This tool is to help with drilling, ***as efficiently as possible***, a set group of puzzles/games in an appropriately configured PGN file. Once the set is complete, the player sees how many errors they made as well as how long the set took to complete. | ||
|
|
||
| The original design goal was to help with implementing a learning approach where a player repeatedly completes the same series of puzzles, striving to reduce both errors and time needed with each round. | ||
| The idea for this came from a recommendation by Dan Heisman (https://www.danheisman.com/recommended-books.html) on how to practice tactics puzzles. In the article, Dan strongly recommends the idea of "repeatedly going through the book faster and faster until you can get 85%+ within 10-15 seconds". You can read about my own results following this approach using this tool [here](https://www.chess.com/forum/view/for-beginners/applying-dan-heismans-guide-to-using-chess-tactics-for-students). | ||
|
|
||
| Since then, the tool has grown and can now be used to: | ||
| * Practice puzzles | ||
| * Practice openings for black or white | ||
| * Practice entire games (useful for learning full games or for playing solitaire chess such as "Guess the Move") | ||
|
|
||
| See the sample PGN files in the /examples folder for more information. The samples include puzzles, openings for both white and black, as well as some famous games to practice. | ||
|
|
||
| Also included is a PGN of a slighly modified [Aman Hambleton's reset mate](https://www.youtube.com/watch?v=XAlcDWQ6iTM) for those who want to practice that sequence along with the same sequence mirrored for black pieces. The PGN also highlights some of the annotation features available including embedding a YouTube video as well as comments during the move sequence. | ||
|
|
||
| [A live online copy of tool is available here](https://rodpolako.github.io/) | ||
|
|
||
|  | ||
| ## Features | ||
| This tool has a number of features that you might find useful: | ||
| * Auto move to next puzzle - Automatically advances to the next puzzle/game upon completion of the current one. This can be disabled via the use of the "Next button" option. | ||
| * Play both sides - Allows the player to play both sides of the puzzle/game | ||
| * Randomize - Presents the puzzles/games in the set in a random order | ||
| * Flipped - Allows you to play the puzzle/game from the other side of the board. May help to develop sense when a given tactic is being used on you. | ||
| * Play Opposite Side - Allows the player to go second instead and makes the computer play the first move from the PGN. Useful for when you want to practice opening defenses instead of puzzles. For example, if you wanted to practice a defense as black, load a PGN with the move order you want to practice and this feature will play as white and play the moves in the PGN while you play the response. Recommended that you use the Flipped option in conjunction with this one. | ||
| * Analysis board - More useful for puzzles, this option generates a link to a Lichess analysis board of the currently displayed puzzle as per the PGN. Useful when you want to analyze a specific puzzle during a run in order to analyze or troubleshoot. This will place a link below the title of the puzzle which if clicked will open an analysis board in Lichess with the position in a new tab. | ||
| * Pause - Useful if you are doing a large number of puzzles/games and need to step away. Click on the pause button and the board will clear and the timer will stop. Click Resume in order to continue. Your elapsed time will not include the paused time. | ||
| * Hints - You can press the hint button at any time during a puzzle/game to see the next expected move. Just know that if a hint is used, it will be counted as an error in your performance. | ||
| * Restart/replay - You can repeat the current puzzle/game set upon completion with a single click. Useful if you want to try again with the same settings. When the current set is complete, just click on "Restart" to try the current PGN file again. If you want, you can choose different settings like random, flipped, etc. before restarting. | ||
| * Feature settings via PGN Tags - You can configure a PGN to set a default combination of features by adding the relevant tag to the top of the PGN. Details below. | ||
| * Responsive design allows the app to be used in either portrait or landscape mode which means that it is able to be used on phones and tablets along with desktop. | ||
| * Choice of multiple piece designs - Note this will reset the board so don't change sets while in the middle of puzzle set. | ||
| * Ability to specify custom board colors either by manual entry or color picking | ||
| * Dark mode | ||
| * Ability to copy results to clipboard ready to paste into a spreadsheet. | ||
| * Ability to export results to CSV file along with setting to include the headers | ||
| * Ability to add additional piece sets (either PNG for SVG) for hosted instances only. Not available on github.io page. | ||
| * Support for annotations - Comments in PGN files will display in the annotation panel to the left of the board. Annotations can use HTML tags so the PGN comments can be fully featured with things like headings, bullets, bold, italics, links, thumbnails, video, etc. If present, annotations will display while completing the puzzle. Board-level annotations, like circles and arrows is not yet available, but planned. | ||
| **Note:** The annotation panel will only be available on screens wider than 992 pixels (1024 or higher recommended). | ||
|
|
||
| ## Setup Instructions | ||
| If you just want to use the trainer and and not bother hosting the page yourself, you can just use the live link [here](https://rodpolako.github.io/). The latest version of the trainer will always be hosted there. | ||
|
|
||
| If you want to host a copy on your own environment and/or make changes: | ||
| 1. Download & extract the zip into a folder and start a web server from there. | ||
| 2. In a browser, point to ```index.html```. On my own setup, the URL is ```localhost:8000/index.html``` but may be different for your setup. Refer to your web server for details. | ||
|
|
||
| ## Usage | ||
| 1. Click on "Open PGN File" | ||
| 2. Navigate to the desired PGN file and then click on OK | ||
| 3. Activate any desired features (such as random, flipped, play both sides) | ||
| 4. When ready, click on start and the first puzzle in the set will be displayed and you can make your first move. | ||
| 5. When the puzzle/game is finished, the next puzzle/game in the set will be automatically loaded. This is the default action unless you select the "next button" option. If you used the "next button" option, click on the next button to proceed to the next puzzle. | ||
| 6. When the set of puzzles/games is complete, your final stats will be displayed. | ||
| 7. You can pause any time if you need to step away. | ||
| 8. If you get stuck you can get a hint by clicking the hint button. | ||
|
|
||
| You can then start a new PGN file by repeating these steps. | ||
|
|
||
| Once a test group is completed, tool displays the following performance information: | ||
| * Number of errors | ||
| * Time to completion | ||
| * Average time per puzzle/game (Calculated) | ||
| * Error rate (Calculated) | ||
|
|
||
|  | ||
|
|
||
| ## Documentation | ||
| See the [Wiki](https://github.com/rodpolako/Chess-PGN-Trainer/wiki) for a complete documentation. | ||
| # Chess PGN Trainer | ||
| Online tool that opens chess PGN files and allows the user to practice the moves. This tool is to help with drilling, ***as efficiently as possible***, a set group of puzzles/games in an appropriately configured PGN file. Once the set is complete, the player sees how many errors they made as well as how long the set took to complete. | ||
|
|
||
| The original design goal was to help with implementing a learning approach where a player repeatedly completes the same series of puzzles, striving to reduce both errors and time needed with each round. | ||
| The idea for this came from a recommendation by Dan Heisman (https://www.danheisman.com/recommended-books.html) on how to practice tactics puzzles. In the article, Dan strongly recommends the idea of "repeatedly going through the book faster and faster until you can get 85%+ within 10-15 seconds". You can read about my own results following this approach using this tool [here](https://www.chess.com/forum/view/for-beginners/applying-dan-heismans-guide-to-using-chess-tactics-for-students). | ||
|
|
||
| Since then, the tool has grown and can now be used to: | ||
| * Practice puzzles | ||
| * Practice openings for black or white | ||
| * Practice entire games (useful for learning full games or for playing solitaire chess such as "Guess the Move") | ||
|
|
||
| See the sample PGN files in the /examples folder for more information. The samples include puzzles, openings for both white and black, as well as some famous games to practice. | ||
|
|
||
| Also included is a PGN of a slighly modified [Aman Hambleton's reset mate](https://www.youtube.com/watch?v=XAlcDWQ6iTM) for those who want to practice that sequence along with the same sequence mirrored for black pieces. The PGN also highlights some of the annotation features available including embedding a YouTube video as well as comments during the move sequence. | ||
|
|
||
| [A live online copy of tool is available here](https://rodpolako.github.io/) | ||
|
|
||
|  | ||
| ## Features | ||
| This tool has a number of features that you might find useful: | ||
| * Auto move to next puzzle - Automatically advances to the next puzzle/game upon completion of the current one. This can be disabled via the use of the "Next button" option. | ||
| * Play both sides - Allows the player to play both sides of the puzzle/game | ||
| * Randomize - Presents the puzzles/games in the set in a random order | ||
| * Flipped - Allows you to play the puzzle/game from the other side of the board. May help to develop sense when a given tactic is being used on you. | ||
| * Play Opposite Side - Allows the player to go second instead and makes the computer play the first move from the PGN. Useful for when you want to practice opening defenses instead of puzzles. For example, if you wanted to practice a defense as black, load a PGN with the move order you want to practice and this feature will play as white and play the moves in the PGN while you play the response. Recommended that you use the Flipped option in conjunction with this one. | ||
| * Analysis board - More useful for puzzles, this option generates a link to a Lichess analysis board of the currently displayed puzzle as per the PGN. Useful when you want to analyze a specific puzzle during a run in order to analyze or troubleshoot. This will place a link below the title of the puzzle which if clicked will open an analysis board in Lichess with the position in a new tab. | ||
| * Pause - Useful if you are doing a large number of puzzles/games and need to step away. Click on the pause button and the board will clear and the timer will stop. Click Resume in order to continue. Your elapsed time will not include the paused time. | ||
| * Hints - You can press the hint button at any time during a puzzle/game to see the next expected move. Just know that if a hint is used, it will be counted as an error in your performance. | ||
| * Restart/replay - You can repeat the current puzzle/game set upon completion with a single click. Useful if you want to try again with the same settings. When the current set is complete, just click on "Restart" to try the current PGN file again. If you want, you can choose different settings like random, flipped, etc. before restarting. | ||
| * Feature settings via PGN Tags - You can configure a PGN to set a default combination of features by adding the relevant tag to the top of the PGN. Details below. | ||
| * Responsive design allows the app to be used in either portrait or landscape mode which means that it is able to be used on phones and tablets along with desktop. | ||
| * Choice of multiple piece designs - Note this will reset the board so don't change sets while in the middle of puzzle set. | ||
| * Ability to specify custom board colors either by manual entry or color picking | ||
| * Dark mode | ||
| * Ability to copy results to clipboard ready to paste into a spreadsheet. | ||
| * Ability to export results to CSV file along with setting to include the headers | ||
| * Ability to add additional piece sets (either PNG for SVG) for hosted instances only. Not available on github.io page. | ||
| * Support for annotations - Comments in PGN files will display in the annotation panel to the left of the board. Annotations can use HTML tags so the PGN comments can be fully featured with things like headings, bullets, bold, italics, links, thumbnails, video, etc. If present, annotations will display while completing the puzzle. Board-level annotations, like circles and arrows is not yet available, but planned. | ||
| **Note:** The annotation panel will only be available on screens wider than 992 pixels (1024 or higher recommended). | ||
|
|
||
| ## Setup Instructions | ||
| If you just want to use the trainer and and not bother hosting the page yourself, you can just use the live link [here](https://rodpolako.github.io/). The latest version of the trainer will always be hosted there. | ||
|
|
||
| If you want to host a copy on your own environment and/or make changes: | ||
| 1. Download & extract the zip into a folder and start a web server from there. | ||
| 2. In a browser, point to ```index.html```. On my own setup, the URL is ```localhost:8000/index.html``` but may be different for your setup. Refer to your web server for details. | ||
|
|
||
| ## Usage | ||
| 1. Click on "Open PGN File" | ||
| 2. Navigate to the desired PGN file and then click on OK | ||
| 3. Activate any desired features (such as random, flipped, play both sides) | ||
| 4. When ready, click on start and the first puzzle in the set will be displayed and you can make your first move. | ||
| 5. When the puzzle/game is finished, the next puzzle/game in the set will be automatically loaded. This is the default action unless you select the "next button" option. If you used the "next button" option, click on the next button to proceed to the next puzzle. | ||
| 6. When the set of puzzles/games is complete, your final stats will be displayed. | ||
| 7. You can pause any time if you need to step away. | ||
| 8. If you get stuck you can get a hint by clicking the hint button. | ||
|
|
||
| You can then start a new PGN file by repeating these steps. | ||
|
|
||
| Once a test group is completed, tool displays the following performance information: | ||
| * Number of errors | ||
| * Time to completion | ||
| * Average time per puzzle/game (Calculated) | ||
| * Error rate (Calculated) | ||
|
|
||
|  | ||
|
|
||
| ## Documentation | ||
| See the [Wiki](https://github.com/rodpolako/Chess-PGN-Trainer/wiki) for a complete documentation. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,5 @@ | ||
| # Changes in this version: | ||
|
|
||
| * Added ability for the app to show dots for legal moves (can be managed via settings) | ||
| * Incorrect moves will now briefly flash the incorrect square red | ||
| * Added ability to set the movement speed of the pieces. | ||
| * Upgraded the legacy pawn promotion code to bootstrap and removed dependence on jQuery-UI. This cut down code size by nearly 25%. | ||
| * Added the ability for Circles & Arrows in the PGN annotation to be shown on the board. The example PGNs have been updated again to showcase this feature. | ||
| * Code cleanup and bug fixes | ||
| * | ||
| * Updated the analysis link option to always send current position instead of puzzle beginning. | ||
| * Updated the handling of null moves | ||
| * Fixed a bug where moving a piece from a square that had a circle would require a double-click to drop in new location |
Oops, something went wrong.