2 |
3 | 📌 This app is under active development and may experience minor issues.
4 | Please report any bugs on Discord, and we will fix them promptly.
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 | [](https://discord.gg/3yQth8YBp8)
15 | [](#contributors-)
16 |
17 | Replace Chess eBoards with your phone camera using ChessCam (https://www.chesscam.net).
18 |
19 | Download the free app on [Google Play](https://play.google.com/store/apps/details?id=com.camerachess.www.twa).
20 |
21 | Do you have ideas, bugs to report or training footage? Join our [Discord Server](https://discord.gg/3yQth8YBp8).
22 |
23 |
24 |
25 | ## Demo
26 | [](https://youtu.be/AAs4EX372bc)
27 |
28 | ## Roadmap
29 |
30 | * Raise an alert when an illegal move is played (currently they're just ignored)
31 | * Add sounds for the opponents moves in "/play"
32 | * Add support for variants
33 | * Develop a testing framework for different board + piece sets
34 | * ... Your next big idea?
35 |
36 | ## Models, Data, Reports and Scripts
37 |
38 | Please post in the Issues tab if you need any help with:
39 | * Running inference
40 | * Exporting models to different formats
41 | * Training on data of varying resolutions (I.e. 640x640)
42 | * etc. etc.
43 |
44 | ### Pieces
45 |
46 | | Name | Description | Link |
47 | | :---: | :---: | :---: |
48 | | 480M_leyolo_pieces.onnx | LeYOLO ONNX model| https://drive.google.com/file/d/1-80xp_nly9i6s3o0mF0mU9OZGEzUAlGj/view?usp=sharing |
49 | | 480M_leyolo_pieces.pt | LeYOLO pt model | https://drive.google.com/file/d/1L6PZbSdT-peCmiJGNwmgHJN5MTpfAM-0/view?usp=sharing |
50 | | pieces.tar.gz | Train/test data in YOLOv5 format | https://drive.google.com/file/d/1CrrINu11Wy8Cv1H4Q9DbcGqir3GPPO29/view?usp=sharing |
51 | | Report | Weights & Biases report from the LeYOLO training run | https://api.wandb.ai/links/pbatch/g2rcvycv |
52 |
53 | ### Xcorners
54 |
55 | | Name | Description | Link |
56 | | :---: | :---: | :---: |
57 | | 480L_leyolo_xcorners.onnx | LeYOLO ONNX model | https://drive.google.com/file/d/1-2wodbiXag9UQ44e2AYAmoRN6jVpxy83/view?usp=sharing |
58 | | 480L_leyolo_xcorners.pt | LeYOLO pt model | https://drive.google.com/file/d/173orSe8eaytN8nin_HOvd2sEfP_wtOUW/view?usp=sharing |
59 | | xcorners.tar.gz | Train/test data in YOLOv5 format | https://drive.google.com/file/d/15Liy-vMcujSZak4YRPeC2TpVjIA3AwVM/view?usp=sharing |
60 | | Report | Weights & Biases report from the LeYOLO training run | https://api.wandb.ai/links/pbatch/ziwur3gr |
61 |
62 | ### Google Colab scripts
63 |
64 | * LeYOLO Training + ONNX export - https://gist.github.com/Pbatch/dccc680ac2f852d4f258e4b6f1997a7b
65 | * TFJS export - https://gist.github.com/Pbatch/46d958df7e0363e42561bda50163a57a
66 |
67 | ## Contributors ✨
68 |
69 | Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
70 |
71 |
72 |
73 |
74 |
15 | },
16 | {
17 | title: "Is there a mobile app?",
18 | content:
19 |
20 | If you have an Android, you can download the free ChessCam app
21 | here.
22 | If you have an IPhone, you can add ChessCam to your home screen from the browser.
23 | See here for more detail.
24 |
25 | },
26 | {
27 | title: "How do I setup my camera?",
28 | content:
29 |
30 |
31 |
32 | Place your camera on the stand to the side of the board.
33 |
34 |
35 | Make sure that the stand is stable and that the camera can see all 4 corners.
36 |
37 |
38 | If you are using your devices native camera app and have 0.5x zoom available, use it.
39 |
40 |
41 | Make sure that the tallest piece (the king or queen) is still in shot when placed on the furthest square from the camera.
42 |
43 |
44 |
45 |
46 | My setup with 0.5x zoom
47 |
48 |
49 |
50 |
51 |
52 | My setup with 1x zoom
53 |
54 |
55 |
56 |
57 | },
58 | {
59 | title: "Will the app work if the board or the camera move mid-way through?",
60 | content:
61 |
62 | If the camera moves so that the squares are not aligned then the app will break.
63 | When the corners algorithm is fast and consistent enough the app may support a moving board/camera.
64 | See https://www.youtube.com/watch?v=XV8EKqScaKs for a brief demo.
65 |
66 | },
67 | {
68 | title: "How powerful does my device have to be?",
69 | content:
70 |
71 | The app works best if you can achieve at least 4 FPS.
72 |
73 | },
74 | {
75 | title: "How do I record?",
76 | content:
77 |
78 |
83 | Setup your device (see "How do I set up my camera?")
84 |
85 |
86 | Click Find Corners to align the 4 corners with your board.
87 | If they are not correct, then adjust them manually.
88 | Clockwise the corners go "h1", "a1", "a8", "h8", starting from the bottom-right corner (relative to White).
89 |
90 |
91 | Click the Play button to start recording your game.
92 |
93 | ,
94 | },
95 | {
96 | title: "How do I upload a game?",
97 | content:
98 |
99 |
100 |
101 | Click the Upload button from the Home page.
102 | Alternatively, go straight to https://www.chesscam.net/upload.
103 |
104 |
105 | Setup your device (see "How do I set up my camera?")
106 |
107 |
108 | Click Find Corners to align the 4 corners with your board.
109 | If they are not correct, then adjust them manually.
110 | Clockwise the corners go "h1", "a1", "a8", "h8", starting from the bottom-right corner (relative to White).
111 |
112 |
113 | Click the Play button to start recording your game.
114 |
115 |
116 |
117 | You can adjust the speed to 1x, 2x or 4x, but you must pause the game first.
118 | It is recommended that you keep the speed at 1x.
119 |
120 |
121 | You can reset the video by clicking the back button.
122 |
123 |
124 | },
125 | {
126 | title: "How do I save my game?",
127 | content:
128 |
129 | After you have finished uploading or recording your game,
130 | copy it to the clipboard by clicking Copy PGN.
131 |
132 | },
133 | {
134 | title: "How do I export my game to Lichess?",
135 | content:
136 |
137 | This guide assumes that you have already recorded or uploaded a game successfully.
138 |
139 |
140 | If you haven't done so already, click Login from the home screen.
141 | After giving ChessCam permissions to the Lichess API you will be redirected back to the Home screen.
142 |
143 |
144 | Click Export from the home screen.
145 |
146 |
147 | Choose a study that you would like to export your game to. If none are listed then go and create one on the Lichess website.
148 |
149 |
150 | Click Export Game to save your game to your study. It will be saved as the current timestamp.
151 |
152 |
153 |
154 | },
155 | {
156 | title: "Does the app work offline?",
157 | content:
158 |
159 | If you have used the app once with an internet connection, then it will work offline in the future.
160 | In offline mode, you cannot export your game to Lichess, but you can still copy the PGN.
161 |
This Privacy Policy describes Our policies and procedures on the collection, use and disclosure of Your information when You use the Service and tells You about Your privacy rights and how the law protects You.
15 |
We use Your Personal data to provide and improve the Service. By using the Service, You agree to the collection and use of information in accordance with this Privacy Policy.
16 |
Interpretation and Definitions
17 |
Interpretation
18 |
The words of which the initial letter is capitalized have meanings defined under the following conditions. The following definitions shall have the same meaning regardless of whether they appear in singular or in plural.
19 |
Definitions
20 |
For the purposes of this Privacy Policy:
21 |
22 |
23 |
Account means a unique account created for You to access our Service or parts of our Service.
24 |
25 |
26 |
Affiliate means an entity that controls, is controlled by or is under common control with a party, where "control" means ownership of 50% or more of the shares, equity interest or other securities entitled to vote for election of directors or other managing authority.
27 |
28 |
29 |
Application refers to ChessCam, the software program provided by the Company.
30 |
31 |
32 |
Company (referred to as either "the Company", "We", "Us" or "Our" in this Agreement) refers to ChessCam.
33 |
34 |
35 |
Country refers to: United Kingdom
36 |
37 |
38 |
Device means any device that can access the Service such as a computer, a cellphone or a digital tablet.
39 |
40 |
41 |
Personal Data is any information that relates to an identified or identifiable individual.
42 |
43 |
44 |
Service refers to the Application.
45 |
46 |
47 |
Service Provider means any natural or legal person who processes the data on behalf of the Company. It refers to third-party companies or individuals employed by the Company to facilitate the Service, to provide the Service on behalf of the Company, to perform services related to the Service or to assist the Company in analyzing how the Service is used.
48 |
49 |
50 |
Usage Data refers to data collected automatically, either generated by the use of the Service or from the Service infrastructure itself (for example, the duration of a page visit).
51 |
52 |
53 |
You means the individual accessing or using the Service, or the company, or other legal entity on behalf of which such individual is accessing or using the Service, as applicable.
54 |
55 |
56 |
Collecting and Using Your Personal Data
57 |
Types of Data Collected
58 |
Personal Data
59 |
While using Our Service, We may ask You to provide Us with certain personally identifiable information that can be used to contact or identify You. Personally identifiable information may include, but is not limited to:
60 |
61 |
Usage Data
62 |
63 |
Usage Data
64 |
Usage Data is collected automatically when using the Service.
65 |
Usage Data may include information such as Your Device's Internet Protocol address (e.g. IP address), browser type, browser version, the pages of our Service that You visit, the time and date of Your visit, the time spent on those pages, unique device identifiers and other diagnostic data.
66 |
When You access the Service by or through a mobile device, We may collect certain information automatically, including, but not limited to, the type of mobile device You use, Your mobile device unique ID, the IP address of Your mobile device, Your mobile operating system, the type of mobile Internet browser You use, unique device identifiers and other diagnostic data.
67 |
We may also collect information that Your browser sends whenever You visit our Service or when You access the Service by or through a mobile device.
68 |
Use of Your Personal Data
69 |
The Company may use Personal Data for the following purposes:
70 |
71 |
72 |
To provide and maintain our Service, including to monitor the usage of our Service.
73 |
74 |
75 |
To manage Your Account: to manage Your registration as a user of the Service. The Personal Data You provide can give You access to different functionalities of the Service that are available to You as a registered user.
76 |
77 |
78 |
For the performance of a contract: the development, compliance and undertaking of the purchase contract for the products, items or services You have purchased or of any other contract with Us through the Service.
79 |
80 |
81 |
To contact You: To contact You by email, telephone calls, SMS, or other equivalent forms of electronic communication, such as a mobile application's push notifications regarding updates or informative communications related to the functionalities, products or contracted services, including the security updates, when necessary or reasonable for their implementation.
82 |
83 |
84 |
To provide You with news, special offers and general information about other goods, services and events which we offer that are similar to those that you have already purchased or enquired about unless You have opted not to receive such information.
85 |
86 |
87 |
To manage Your requests: To attend and manage Your requests to Us.
88 |
89 |
90 |
For business transfers: We may use Your information to evaluate or conduct a merger, divestiture, restructuring, reorganization, dissolution, or other sale or transfer of some or all of Our assets, whether as a going concern or as part of bankruptcy, liquidation, or similar proceeding, in which Personal Data held by Us about our Service users is among the assets transferred.
91 |
92 |
93 |
For other purposes: We may use Your information for other purposes, such as data analysis, identifying usage trends, determining the effectiveness of our promotional campaigns and to evaluate and improve our Service, products, services, marketing and your experience.
94 |
95 |
96 |
We may share Your personal information in the following situations:
97 |
98 |
With Service Providers: We may share Your personal information with Service Providers to monitor and analyze the use of our Service, to contact You.
99 |
For business transfers: We may share or transfer Your personal information in connection with, or during negotiations of, any merger, sale of Company assets, financing, or acquisition of all or a portion of Our business to another company.
100 |
With Affiliates: We may share Your information with Our affiliates, in which case we will require those affiliates to honor this Privacy Policy. Affiliates include Our parent company and any other subsidiaries, joint venture partners or other companies that We control or that are under common control with Us.
101 |
With business partners: We may share Your information with Our business partners to offer You certain products, services or promotions.
102 |
With other users: when You share personal information or otherwise interact in the public areas with other users, such information may be viewed by all users and may be publicly distributed outside.
103 |
With Your consent: We may disclose Your personal information for any other purpose with Your consent.
104 |
105 |
Retention of Your Personal Data
106 |
The Company will retain Your Personal Data only for as long as is necessary for the purposes set out in this Privacy Policy. We will retain and use Your Personal Data to the extent necessary to comply with our legal obligations (for example, if we are required to retain your data to comply with applicable laws), resolve disputes, and enforce our legal agreements and policies.
107 |
The Company will also retain Usage Data for internal analysis purposes. Usage Data is generally retained for a shorter period of time, except when this data is used to strengthen the security or to improve the functionality of Our Service, or We are legally obligated to retain this data for longer time periods.
108 |
Transfer of Your Personal Data
109 |
Your information, including Personal Data, is processed at the Company's operating offices and in any other places where the parties involved in the processing are located. It means that this information may be transferred to — and maintained on — computers located outside of Your state, province, country or other governmental jurisdiction where the data protection laws may differ than those from Your jurisdiction.
110 |
Your consent to this Privacy Policy followed by Your submission of such information represents Your agreement to that transfer.
111 |
The Company will take all steps reasonably necessary to ensure that Your data is treated securely and in accordance with this Privacy Policy and no transfer of Your Personal Data will take place to an organization or a country unless there are adequate controls in place including the security of Your data and other personal information.
112 |
Delete Your Personal Data
113 |
You have the right to delete or request that We assist in deleting the Personal Data that We have collected about You.
114 |
Our Service may give You the ability to delete certain information about You from within the Service.
115 |
You may update, amend, or delete Your information at any time by signing in to Your Account, if you have one, and visiting the account settings section that allows you to manage Your personal information. You may also contact Us to request access to, correct, or delete any personal information that You have provided to Us.
116 |
Please note, however, that We may need to retain certain information when we have a legal obligation or lawful basis to do so.
117 |
Disclosure of Your Personal Data
118 |
Business Transactions
119 |
If the Company is involved in a merger, acquisition or asset sale, Your Personal Data may be transferred. We will provide notice before Your Personal Data is transferred and becomes subject to a different Privacy Policy.
120 |
Law enforcement
121 |
Under certain circumstances, the Company may be required to disclose Your Personal Data if required to do so by law or in response to valid requests by public authorities (e.g. a court or a government agency).
122 |
Other legal requirements
123 |
The Company may disclose Your Personal Data in the good faith belief that such action is necessary to:
124 |
125 |
Comply with a legal obligation
126 |
Protect and defend the rights or property of the Company
127 |
Prevent or investigate possible wrongdoing in connection with the Service
128 |
Protect the personal safety of Users of the Service or the public
129 |
Protect against legal liability
130 |
131 |
Security of Your Personal Data
132 |
The security of Your Personal Data is important to Us, but remember that no method of transmission over the Internet, or method of electronic storage is 100% secure. While We strive to use commercially acceptable means to protect Your Personal Data, We cannot guarantee its absolute security.
133 |
Children's Privacy
134 |
Our Service does not address anyone under the age of 13. We do not knowingly collect personally identifiable information from anyone under the age of 13. If You are a parent or guardian and You are aware that Your child has provided Us with Personal Data, please contact Us. If We become aware that We have collected Personal Data from anyone under the age of 13 without verification of parental consent, We take steps to remove that information from Our servers.
135 |
If We need to rely on consent as a legal basis for processing Your information and Your country requires consent from a parent, We may require Your parent's consent before We collect and use that information.
136 |
Links to Other Websites
137 |
Our Service may contain links to other websites that are not operated by Us. If You click on a third party link, You will be directed to that third party's site. We strongly advise You to review the Privacy Policy of every site You visit.
138 |
We have no control over and assume no responsibility for the content, privacy policies or practices of any third party sites or services.
139 |
Changes to this Privacy Policy
140 |
We may update Our Privacy Policy from time to time. We will notify You of any changes by posting the new Privacy Policy on this page.
141 |
We will let You know via email and/or a prominent notice on Our Service, prior to the change becoming effective and update the "Last updated" date at the top of this Privacy Policy.
142 |
You are advised to review this Privacy Policy periodically for any changes. Changes to this Privacy Policy are effective when they are posted on this page.
143 |
Contact Us
144 |
If you have any questions about this Privacy Policy, You can contact us:
](https://youtu.be/AAs4EX372bc)
27 |
28 | ## Roadmap
29 |
30 | * Raise an alert when an illegal move is played (currently they're just ignored)
31 | * Add sounds for the opponents moves in "/play"
32 | * Add support for variants
33 | * Develop a testing framework for different board + piece sets
34 | * ... Your next big idea?
35 |
36 | ## Models, Data, Reports and Scripts
37 |
38 | Please post in the Issues tab if you need any help with:
39 | * Running inference
40 | * Exporting models to different formats
41 | * Training on data of varying resolutions (I.e. 640x640)
42 | * etc. etc.
43 |
44 | ### Pieces
45 |
46 | | Name | Description | Link |
47 | | :---: | :---: | :---: |
48 | | 480M_leyolo_pieces.onnx | LeYOLO ONNX model| https://drive.google.com/file/d/1-80xp_nly9i6s3o0mF0mU9OZGEzUAlGj/view?usp=sharing |
49 | | 480M_leyolo_pieces.pt | LeYOLO pt model | https://drive.google.com/file/d/1L6PZbSdT-peCmiJGNwmgHJN5MTpfAM-0/view?usp=sharing |
50 | | pieces.tar.gz | Train/test data in YOLOv5 format | https://drive.google.com/file/d/1CrrINu11Wy8Cv1H4Q9DbcGqir3GPPO29/view?usp=sharing |
51 | | Report | Weights & Biases report from the LeYOLO training run | https://api.wandb.ai/links/pbatch/g2rcvycv |
52 |
53 | ### Xcorners
54 |
55 | | Name | Description | Link |
56 | | :---: | :---: | :---: |
57 | | 480L_leyolo_xcorners.onnx | LeYOLO ONNX model | https://drive.google.com/file/d/1-2wodbiXag9UQ44e2AYAmoRN6jVpxy83/view?usp=sharing |
58 | | 480L_leyolo_xcorners.pt | LeYOLO pt model | https://drive.google.com/file/d/173orSe8eaytN8nin_HOvd2sEfP_wtOUW/view?usp=sharing |
59 | | xcorners.tar.gz | Train/test data in YOLOv5 format | https://drive.google.com/file/d/15Liy-vMcujSZak4YRPeC2TpVjIA3AwVM/view?usp=sharing |
60 | | Report | Weights & Biases report from the LeYOLO training run | https://api.wandb.ai/links/pbatch/ziwur3gr |
61 |
62 | ### Google Colab scripts
63 |
64 | * LeYOLO Training + ONNX export - https://gist.github.com/Pbatch/dccc680ac2f852d4f258e4b6f1997a7b
65 | * TFJS export - https://gist.github.com/Pbatch/46d958df7e0363e42561bda50163a57a
66 |
67 | ## Contributors ✨
68 |
69 | Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
70 |
71 |
72 |
73 |
74 | 
46 | 
52 | 
24 | <>
25 |