-
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
15 changed files
with
1,707 additions
and
551 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 |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| /tools/en-croissant_*_x64_en-US.msi | ||
| /*.nupkg | ||
| /en-croissant-*.zip |
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 |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
|
|
||
| ## En Croissant - The Ultimate Chess Toolkit | ||
|
|
||
| En-Croissant is an open-source, cross-platform chess GUI that aims to be powerful, customizable and easy to use. | ||
|
|
||
|  | ||
|
|
||
| ### Features | ||
|
|
||
| - Play Chess offline | ||
| - Play against an Engine or a friend locally | ||
| - Configure a custom time control, or take your time with an Unlimited clock | ||
| - Use the same or differing time settings for both players | ||
| - Prepare a Repertoire and train with spaced repetition | ||
| - Train your chess skills with Puzzles | ||
| - Native support for [Lichess Puzzles](https://lichess.org/training) | ||
| - Store games | ||
| - Create games from either Portable Game Notation (PGN) or Forsyth-Edwards Notation (FEN) | ||
| - Import from a PGN file | ||
| - Download previously played games from [Lichess](https://lichess.org/) and [Chess.com](https://www.chess.com/) | ||
| - Save games as PGN files | ||
| - Engine integration and management | ||
| - Native support for some popular local engines (e.g. [Stockfish](https://stockfishchess.org/), [Leela Chess Zero](https://lczero.org/), [Komodo](https://komodochess.com/)) | ||
| - Query select cloud-based engines (i.e. [ChessDB](https://www.chessdb.cn/), [Lichess Cloud](https://lichess.org/)) | ||
| - Supports all Universal Chess Interface (UCI) engines | ||
| - Database analysis and management | ||
| - Native support for some popular databases | ||
| - [Ajedrez Data's Over the Board (OTB)](https://ajedrezdata.com/databases/otb/) | ||
| - [Ajedrez Data's Correspondence (CORR)](https://ajedrezdata.com/databases/corr/) | ||
| - [Caissabase](https://caissabase.co.uk/) | ||
| - [MillionBase](https://rebel13.nl/rebel13/rebel%2013.html) | ||
| - Create a database from a [Lichess](https://lichess.org/) or [Chess.com](https://www.chess.com/) account's game history | ||
| - Track player wins/draws/losses, Elo, [International Chess Federation (FIDE) statistics](https://ratings.fide.com/), and openings | ||
| - Track tournament games and leaderboards | ||
| - Merge player records | ||
| - Prune empty or duplicate games | ||
| - Analyze games | ||
| - Set up and play a past game from a given position | ||
| - Run multiple Engines to find the optimal move | ||
| - Search a reference database for exact or similar games, and forecast the current game's results with a given move | ||
| - Annotate moves |
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,133 +1,49 @@ | ||
| ## Summary | ||
| How do I create packages? See https://docs.chocolatey.org/en-us/create/create-packages | ||
|
|
||
| If you are submitting packages to the community feed (https://community.chocolatey.org) | ||
| always try to ensure you have read, understood and adhere to the create | ||
| packages wiki link above. | ||
|
|
||
| ## Automatic Packaging Updates? | ||
| Consider making this package an automatic package, for the best | ||
| maintainability over time. Read up at https://docs.chocolatey.org/en-us/create/automatic-packages | ||
|
|
||
| ## Shim Generation | ||
| Any executables you include in the package or download (but don't call | ||
| install against using the built-in functions) will be automatically shimmed. | ||
|
|
||
| This means those executables will automatically be included on the path. | ||
| Shim generation runs whether the package is self-contained or uses automation | ||
| scripts. | ||
|
|
||
| By default, these are considered console applications. | ||
|
|
||
| If the application is a GUI, you should create an empty file next to the exe | ||
| named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'. | ||
| See https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-set-up-shims-for-applications-that-have-a-gui | ||
|
|
||
| If you want to ignore the executable, create an empty file next to the exe | ||
| named 'name.exe.ignore' e.g. 'bob.exe' would need a file named | ||
| 'bob.exe.ignore'. | ||
| See https://docs.chocolatey.org/en-us/create/create-packages#how-do-i-exclude-executables-from-getting-shims | ||
|
|
||
| ## Self-Contained? | ||
| If you have a self-contained package, you can remove the automation scripts | ||
| entirely and just include the executables, they will automatically get shimmed, | ||
| which puts them on the path. Ensure you have the legal right to distribute | ||
| the application though. See https://docs.chocolatey.org/en-us/information/legal. | ||
|
|
||
| You should read up on the Shim Generation section to familiarize yourself | ||
| on what to do with GUI applications and/or ignoring shims. | ||
|
|
||
| ## Automation Scripts | ||
| You have a powerful use of Chocolatey, as you are using PowerShell. So you | ||
| can do just about anything you need. Choco has some very handy built-in | ||
| functions that you can use, these are sometimes called the helpers. | ||
|
|
||
| ### Built-In Functions | ||
| https://docs.chocolatey.org/en-us/create/functions | ||
|
|
||
| A note about a couple: | ||
| * Get-ToolsLocation - used to get you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder - see https://docs.chocolatey.org/en-us/create/functions/get-toolslocation | ||
| * Install-BinFile - used for non-exe files - executables are automatically shimmed... - see https://docs.chocolatey.org/en-us/create/functions/install-binfile | ||
| * Uninstall-BinFile - used for non-exe files - executables are automatically shimmed - see https://docs.chocolatey.org/en-us/create/functions/uninstall-binfile | ||
|
|
||
| ### Getting package specific information | ||
| Use the package parameters pattern - see https://docs.chocolatey.org/en-us/guides/create/parse-packageparameters-argument | ||
|
|
||
| ### Need to mount an ISO? | ||
| https://docs.chocolatey.org/en-us/guides/create/mount-an-iso-in-chocolatey-package | ||
|
|
||
| ### Environment Variables | ||
| Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow): | ||
|
|
||
| * TEMP/TMP - Overridden to the CacheLocation, but may be the same as the original TEMP folder | ||
| * ChocolateyInstall - Top level folder where Chocolatey is installed | ||
| * ChocolateyPackageName - The name of the package, equivalent to the `<id />` field in the nuspec | ||
| * ChocolateyPackageTitle - The title of the package, equivalent to the `<title />` field in the nuspec | ||
| * ChocolateyPackageVersion - The normalized version of the package, equivalent to a normalized edition of the `<version />` field in the nuspec | ||
| * ChocolateyPackageFolder - The top level location of the package folder - the folder where Chocolatey has downloaded and extracted the NuGet package, typically `C:\ProgramData\chocolatey\lib\packageName`. | ||
|
|
||
| #### Advanced Environment Variables | ||
| The following are more advanced settings: | ||
|
|
||
| * ChocolateyPackageParameters - Parameters to use with packaging, not the same as install arguments (which are passed directly to the native installer). Based on `--package-parameters`. | ||
| * CHOCOLATEY_VERSION - The version of Choco you normally see. Use if you are 'lighting' things up based on choco version. Otherwise take a dependency on the specific version you need. | ||
| * ChocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. Automatically handled in built in Choco functions. | ||
| * OS_PLATFORM - Like Windows, macOS, Linux. | ||
| * OS_VERSION - The version of OS, like 10.0 something something for Windows. | ||
| * OS_NAME - The reported name of the OS. | ||
| * USER_NAME = The user name | ||
| * USER_DOMAIN = The user domain name (could also be local computer name) | ||
| * IS_PROCESSELEVATED = Is the process elevated? | ||
| * IS_SYSTEM = Is the user the system account? | ||
| * IS_REMOTEDESKTOP = Is the user in a terminal services session? | ||
| * ChocolateyToolsLocation - formerly 'ChocolateyBinRoot' ('ChocolateyBinRoot' will be removed with Chocolatey v2.0.0), this is where tools being installed outside of Chocolatey packaging will go. | ||
|
|
||
| #### Set By Options and Configuration | ||
| Some environment variables are set based on options that are passed, configuration and/or features that are turned on: | ||
|
|
||
| * ChocolateyEnvironmentDebug - Was `--debug` passed? If using the built-in PowerShell host, this is always true (but only logs debug messages to console if `--debug` was passed) | ||
| * ChocolateyEnvironmentVerbose - Was `--verbose` passed? If using the built-in PowerShell host, this is always true (but only logs verbose messages to console if `--verbose` was passed). | ||
| * ChocolateyExitOnRebootDetected - Are we exiting on a detected reboot? Set by ` --exit-when-reboot-detected` or the feature `exitOnRebootDetected` | ||
| * ChocolateyForce - Was `--force` passed? | ||
| * ChocolateyForceX86 - Was `-x86` passed? | ||
| * ChocolateyRequestTimeout - How long before a web request will time out. Set by config `webRequestTimeoutSeconds` | ||
| * ChocolateyResponseTimeout - How long to wait for a download to complete? Set by config `commandExecutionTimeoutSeconds` | ||
| * ChocolateyPowerShellHost - Are we using the built-in PowerShell host? Set by `--use-system-powershell` or the feature `powershellHost` | ||
|
|
||
| #### Business Edition Variables | ||
|
|
||
| * ChocolateyInstallArgumentsSensitive - Encrypted arguments passed from command line `--install-arguments-sensitive` that are not logged anywhere. | ||
| * ChocolateyPackageParametersSensitive - Package parameters passed from command line `--package-parameters-sensitive` that are not logged anywhere. | ||
| * ChocolateyLicensedVersion - What version is the licensed edition on? | ||
| * ChocolateyLicenseType - What edition / type of the licensed edition is installed? | ||
| * USER_CONTEXT - The original user context - different when self-service is used (Licensed) | ||
|
|
||
| #### Experimental Environment Variables | ||
| The following are experimental or use not recommended: | ||
|
|
||
| * OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under | ||
| * CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different - based on git describe | ||
| * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. | ||
| * IS_REMOTE = Is the user in a remote session? | ||
|
|
||
| #### Not Useful Or Anti-Pattern If Used | ||
|
|
||
| * ChocolateyInstallOverride = Not for use in package automation scripts. Based on `--override-arguments` being passed. | ||
| * ChocolateyInstallArguments = The installer arguments meant for the native installer. You should use chocolateyPackageParameters instead. Based on `--install-arguments` being passed. | ||
| * ChocolateyIgnoreChecksums - Was `--ignore-checksums` passed or the feature `checksumFiles` turned off? | ||
| * ChocolateyAllowEmptyChecksums - Was `--allow-empty-checksums` passed or the feature `allowEmptyChecksums` turned on? | ||
| * ChocolateyAllowEmptyChecksumsSecure - Was `--allow-empty-checksums-secure` passed or the feature `allowEmptyChecksumsSecure` turned on? | ||
| * ChocolateyChecksum32 - Was `--download-checksum` passed? | ||
| * ChocolateyChecksumType32 - Was `--download-checksum-type` passed? | ||
| * ChocolateyChecksum64 - Was `--download-checksum-x64` passed? | ||
| * ChocolateyChecksumType64 - Was `--download-checksum-type-x64` passed? | ||
| * ChocolateyPackageExitCode - The exit code of the script that just ran - usually set by `Set-PowerShellExitCode` | ||
| * ChocolateyLastPathUpdate - Set by Chocolatey as part of install, but not used for anything in particular in packaging. | ||
| * ChocolateyProxyLocation - The explicit proxy location as set in the configuration `proxy` | ||
| * ChocolateyDownloadCache - Use available download cache? Set by `--skip-download-cache`, `--use-download-cache`, or feature `downloadCache` | ||
| * ChocolateyProxyBypassList - Explicitly set locations to ignore in configuration `proxyBypassList` | ||
| * ChocolateyProxyBypassOnLocal - Should the proxy bypass on local connections? Set based on configuration `proxyBypassOnLocal` | ||
| * http_proxy - Set by original `http_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. | ||
| * https_proxy - Set by original `https_proxy` passthrough, or same as `ChocolateyProxyLocation` if explicitly set. | ||
| * no_proxy- Set by original `no_proxy` passthrough, or same as `ChocolateyProxyBypassList` if explicitly set. | ||
| # <img src="https://cdn.jsdelivr.net/gh/brogers5/chocolatey-package-en-croissant@997009f54daa82d14c05998c3f979e1418641b45/en-croissant.png" width="48" height="48"/> Chocolatey Package: [En Croissant - The Ultimate Chess Toolkit](https://community.chocolatey.org/packages/en-croissant) | ||
|
|
||
| [](https://community.chocolatey.org/packages/en-croissant) | ||
| [](https://community.chocolatey.org/packages/en-croissant) | ||
|
|
||
| ## Install | ||
|
|
||
| [Install Chocolatey](https://chocolatey.org/install), and run the following command to install the latest approved stable version from the Chocolatey Community Repository: | ||
|
|
||
| ```shell | ||
| choco install en-croissant --source="'https://community.chocolatey.org/api/v2'" | ||
| ``` | ||
|
|
||
| Alternatively, the packages as published on the Chocolatey Community Repository will also be mirrored on this repository's [Releases page](https://github.com/brogers5/chocolatey-package-en-croissant/releases). The `nupkg` can be installed from the current directory (with dependencies sourced from the Community Repository) as follows: | ||
|
|
||
| ```shell | ||
| choco install en-croissant --source="'.;https://community.chocolatey.org/api/v2/'" | ||
| ``` | ||
|
|
||
| ## Build | ||
|
|
||
| [Install Chocolatey](https://chocolatey.org/install), the [Chocolatey Automatic Package Updater Module](https://github.com/majkinetor/au), and the [PowerShellForGitHub PowerShell Module](https://github.com/microsoft/PowerShellForGitHub), then clone this repository. | ||
|
|
||
| Once cloned, simply run `build.ps1`. The MSI is intentionally untracked to avoid bloating the repository, so the script will download the En Croissant installer MSI from the official distribution point, then packs everything together. | ||
|
|
||
| A successful build will create `en-croissant.x.y.z.nupkg`, where `x.y.z` should be the Nuspec's normalized `version` value at build time. | ||
|
|
||
| >[!Note] | ||
| >Chocolatey package builds are non-deterministic. Consequently, an independently built package's checksum will not match that of the officially published package. | ||
| ## Update | ||
|
|
||
| This package should be automatically updated by the [Chocolatey Automatic Package Updater Module](https://github.com/majkinetor/au), with update queries implemented by the [PowerShellForGitHub PowerShell Module](https://github.com/microsoft/PowerShellForGitHub). If it is outdated by more than a few days, please [open an issue](https://github.com/brogers5/chocolatey-package-en-croissant/issues). | ||
|
|
||
| AU expects the parent directory that contains this repository to share a name with the Nuspec (`en-croissant`). Your local repository should therefore be cloned accordingly: | ||
|
|
||
| ```shell | ||
| git clone git@github.com:brogers5/chocolatey-package-en-croissant.git en-croissant | ||
| ``` | ||
|
|
||
| Alternatively, a junction point can be created that points to the local repository (preferably within a repository adopting the [AU packages template](https://github.com/majkinetor/au-packages-template)): | ||
|
|
||
| ```shell | ||
| mklink /J en-croissant ..\chocolatey-package-en-croissant | ||
| ``` | ||
|
|
||
| Once created, simply run `update.ps1` from within the created directory/junction point. Assuming all goes well, all relevant files should change to reflect the latest version available. This will also build a new package version using the modified files. | ||
|
|
||
| Before submitting a pull request, please [test the package](https://docs.chocolatey.org/en-us/community-repository/moderation/package-verifier#steps-for-each-package) using the latest [Chocolatey Testing Environment](https://github.com/chocolatey-community/chocolatey-test-environment) first. |
Oops, something went wrong.