Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation of variant configuration options #30

Closed
ianfab opened this issue Aug 31, 2019 · 4 comments
Closed

Documentation of variant configuration options #30

ianfab opened this issue Aug 31, 2019 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@ianfab
Copy link
Member

ianfab commented Aug 31, 2019

Documentation of the variant configuration options should be available in variants.ini and variant.h. Additional examples could be collected in wiki.

@ianfab ianfab added the enhancement New feature or request label Aug 31, 2019
@gbtami
Copy link
Member

gbtami commented Sep 3, 2019

Added Grand-house to wiki.

@ianfab
Copy link
Member Author

ianfab commented Sep 3, 2019

Thx. Now there is quite some flexibility to share variants, I am just not sure where to draw the line, but a reasonable rule of thumb (there is of course no need for a hard rule) where to put a variant could maybe be:

  • in variant.cpp: popular variants and variants explicitly supported by GUIs, e.g., crazyhouse, since those variants should be "written in stone" (and covered by perft tests).
  • in default variants.ini: well-known variants, but not very popular, e.g., indian great chess, since they might be considered useful by many
  • in wiki: user-invented or relatively unknown variants

3check-crazyhouse and anti-losalamos to me rather belong to the third category, I just put them into the variants.ini because I was lacking instructive examples.

@ianfab ianfab added the good first issue Good for newcomers label Sep 20, 2019
@ianfab
Copy link
Member Author

ianfab commented Sep 20, 2019

I added the list of all available options to the INI in ad9eec8#diff-c2603b10ee775cac85b483d9317f4d76 and started to describe some of them. If anyone wants to help with extending the documentation on the options, that would be very welcome.

ianfab added a commit that referenced this issue Oct 11, 2019
@ianfab ianfab added this to the v10.3 milestone Oct 16, 2019
@ianfab ianfab closed this as completed in b6a17b8 Oct 18, 2019
@ianfab
Copy link
Member Author

ianfab commented Oct 18, 2019

Now that some basic documentation on all variant configuration options is available, I think it would be a good timing to do the first release that includes the variant configuration feature in the next days. If there is some feedback on the documentation (or otherwise) that should be addressed beforehand, please let me know.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants