c14936c63c
* PictureLoader: Replace downloadedPics cache with QNetworkCache Currently when the "Download card pictures on the fly" option is enabled, Cockatrice stores downloaded pictures into a downloadedPics sub-folder, keyed on set and card name. If a picture is found in that folder, we never try to download a picture for that card ever again (until it is reprinted in a more recent set, I guess). This has the unfortunate consequence that if you change the URLs for downloading card images, the changes are not applied to cards that already have their picture downloaded. In particular, if you use localized card pictures (through !sflang!), you get a mix of cards in different languages depending on the currently configured language at the time each card was downloaded. This patch removes that mechanism in favor of setting a QNetworkDiskCache on the QNetworkAccessManager used by the PictureLoader to download pictures. The QNetworkDiskCache caches the picture keyed on their URL: if the URL changes, a new request will be made. In particular, if you use picture URLs with !sflang! and change the language, pictures for the current language will be downloaded even for cards that already have a picture. The QNetworkDiskCache is configured with a maximum size of 4GB, which should be enough to hold one high-quality JPEG for each M:TG card in existence. Note that this does not affect the existing mechanism for defining custom card art, either through the CUSTOM directory or the set-based one. Cockatrice will still read existing cards in the downloadedPics directory as before, it will just no longer write into that directory (since pictures are cached by the QNetworkDiskCache instead). To fully switch to the new cache, users should use the "Delete Downloaded Images" button in the settings: it will clear the QNetworkDiskCache but also remove the downloadedPics directory. * Do not use system cache dir for portable installs * Add settings for network cache size * Delete corrupted cache entries * Use old-style connect() syntax (Qt5 build failure) * Add setNetworkCacheSizeInMB to test mocks * setTransferTimeout was added in Qt 5.15 * Improve logging messages We now have the following messages - "Trying to download picture from url: URL" before loading a picture when picture download is enabled - "Trying to load picture from cache: URL" before loading a picture when picture download is disabled (i.e. cache-only offline mode) - "Removing corrupted cache file for url URL and retrying (ERR)" when when we fail to load a picture from the cache. Usually, this should be due to the timeout, in which case ERR will be "Operation Canceled". - "Download failed for url URL (ERR)" when there was an error downloading a picture from the network (ERR is the error message) - "Following redirect to URL" and "Following cached redirect to URL" when following a redirect (from network/from cache) - "Image successfully downloaded from URL" and "Image successfully loaded from cached url at URL" on success - "Possible cached/downloaded picture at URL could not be loaded" on ImageReader error * Clarify that network cache is on disk Also migrate "Delete Downloaded Image" to a "Clear" button right next to the network cache size. * Remove qPrintable * Move pixmap cache settings to card sources * qDebug().nospace() * some formatting on debug messages * format * inverted condition --------- Co-authored-by: ebbit1q <ebbit1q@gmail.com> |
||
|---|---|---|
| .ci | ||
| .github | ||
| .husky | ||
| .tx | ||
| cmake | ||
| cockatrice | ||
| common | ||
| dbconverter | ||
| doc | ||
| oracle | ||
| servatrice | ||
| tests | ||
| vcpkg@c30de8e136 | ||
| webclient | ||
| .clang-format | ||
| .cmake-format.json | ||
| .codacy.yml | ||
| .dockerignore | ||
| .gitignore | ||
| .gitmodules | ||
| CMakeLists.txt | ||
| docker-compose.yml | ||
| docker-compose.yml.windows | ||
| Dockerfile | ||
| format.sh | ||
| LICENSE | ||
| README.md | ||
| vcpkg.json | ||
Cockatrice | Download | Get Involved | Community | Translations | Build | Run | License
To get started, ⇢ view our webpage
To get support or suggest changes ⇢ file an issue (How?) To help with development, see how to get involved
Cockatrice
Cockatrice is an open-source, multiplatform program for playing tabletop card games over a network. The program's server design prevents users from manipulating the game for unfair advantage. The client also provides a single-player mode, which allows users to brew while offline. This project uses C++ and the Qt5 libraries.
Download 
Downloads are available for full releases and the current beta version in development. There is no strict release schedule for either of them.
-
Latest
stablerelease:
- Stable versions are checkpoints featuring major feature and UI enhancements.
- Recommended for most users!
-
Latest
betarelease:
- Beta versions include the most recently added features and bugfixes, but can be unstable.
- To be a Cockatrice Beta Tester, use this version. Find more information here!
Get Involved 
Join our Discord community to connect with the project or fellow users of the app. The Cockatrice developers are also available on Gitter. Come here to talk about the application, features, or just to hang out.
For support regarding specific servers, please contact that server's admin or forum for support rather than asking here.
To contribute code to the project, please review the guidelines. We maintain two tags for contributors to find issues to work on:
- Good first issue: issues tagged in this way provide a simple way to get started. They don't require much experience to be worked on.
- Help wanted: This tag is used for issues that we are looking for a contributor to work on. Often this is for feature suggestions we are willing to accept, but don't have the time to work on ourselves.
For both tags, we're willing to provide help to contributors in showing them where and how they can make changes, as well as code review for changes they submit.
We try to be responsive to new issues. We'll provide advice on how best to implement a feature; alternately, we can show you where the codebase is doing something similar before you get too far along.
Cockatrice uses the Google Developer Documentation Style Guide to ensure consistent documentation. We encourage you to improve the documentation by suggesting edits based on this guide.
Community Resources
Translations 
Cockatrice uses Transifex for translations. You can help us bring Cockatrice and Oracle to your language or just edit single wordings right from within your browser by visiting our Transifex project page.
| Cockatrice | Oracle |
|---|---|
Check out our Translator FAQ for more information about contributing!
Build 
Detailed compiling instructions can be found on the Cockatrice wiki under Compiling Cockatrice
Dependencies: (for minimum requirements search our CMake file)
Oracle can optionally use zlib and xz to load compressed files:
To compile:
mkdir build
cd build
cmake ..
make
You can then run
make install
to get a cockatrice installation inside the release folder, or:
make package
to create a system-specific installation package.
The following flags can be passed to cmake:
-DWITH_SERVER=1Whether to build the server (default 0 = no).-DWITH_CLIENT=0Whether to build the client (default 1 = yes).-DWITH_ORACLE=0Whether to build oracle (default 1 = yes).-DCMAKE_BUILD_TYPE=DebugCompile in debug mode. Enables extra logging output, debug symbols, and much more verbose compiler warnings (defaultRelease).-DWARNING_AS_ERROR=0Whether to treat compilation warnings as errors in debug mode (default 1 = yes).-DUPDATE_TRANSLATIONS=1Configuremaketo update the translation .ts files for new strings in the source code. Note: Runningmake cleanwill remove the .ts files (default 0 = no).-DTEST=1Enable regression tests (default 0 = no). Note: needs googletest, will be downloaded on the fly if unavailable. To run tests:make test.-DFORCE_USE_QT5=1Skip looking for Qt6 before trying to find Qt5-DOPEN_SSL_PATH=C:/Path/To/Tools/OpenSSL/Win_x64/bin"Designate the OpenSSL Path if you're using non-standard directives
Run
Cockatrice is the game client
Oracle fetches card data
Servatrice is the server
Servatrice Docker container
You can run an instance of Servatrice (the Cockatrice server) using Docker and the Cockatrice Dockerfile.
First, create an image from the Dockerfile
cd /path/to/Cockatrice-Repo/
docker build -t servatrice .
And then run it
docker run -i -p 4747:4747/tcp -t servatrice:latest
Note: Running this command exposes the TCP port 4747 of the docker container
to permit connections to the server.
Find more information on how to use Servatrice with Docker in our wiki.
Docker compose
There is also a docker-compose file available which will configure and run both a MySQL server and Servatrice. The docker-compose setup scripts can be found in the servatrice/docker folder and vary only slightly from the default sql and server .ini files. The setup scripts can either be modified in place, or docker-compose can mount alternative files into the images, as you prefer.
To run Servatrice via docker-compose, first install docker-compose following the install instructions. Once installed, run the following from the root of the repository:
docker-compose build # Build the Servatrice image using the same Dockerfile as above.
docker-compose up # Setup and run both the MySQL server and Servatrice.
Note: Similar to the above Docker setup, this will expose TCP ports 4747 and 4748.
Note: The first time running the docker-compose setup, the MySQL server will take a little time to run the initial setup scripts. Due to this, the Servatrice instance may fail the first few attempts to connect to the database. Servatrice is set to
restart: alwaysin the docker-compose.yml, which will allow it to continue attempting to start up. Once the MySQL scripts have completed, Servatrice should then connect automatically on the next attempt.
Docker compose in Windows A out of box working docker-compose file has been added to help setup in Windows.
Docker in Windows requires additional steps in form of using Docker Desktop to allow resource sharing from the drive the volumes are mapped from, as well as potential workarounds needed to get file sharing working in Windows. This StackOverflow discussion sheds some light on it
License 
Cockatrice is free software, licensed under the GPLv2.