Welcome to Argumentum, a captivating card game that celebrates the intricate art of argumentation. This project not only involves the creation and distribution of the end product but also aims to facilitate content updating with ease.
Argumentum is a dual-deck card game, with gameplay revolving around drawing a small card, followed by players competing to play and identify fallacy large cards from their hand or a common pot.
Discover more about the game (currently in French) on the project's website.
The repository is organized as follows:
-
Generation: Contains two tools that form the core of the generation workflow:
- CardPen: This is a tailored version of M.C DeMarco's cardpen. It's designed to generate a set of templated cards by injecting CSV data into a mustache/handlebars + CSS HTML template system. For generating a physical playing card, you'll require two cardpen JSON files (one for face, one for back).
- Converters: This is a pipeline processing command-line utility. It employs a large json configuration file to detail how to process and assemble Cardpen scenarios to create the send-to-print document.
-
Cards: This directory houses cardpen configurations to construct the decks that constitute Argumentum. It includes folders for each card type, along with assets and archives.
-
DNNPlatform: This is home to the web application for the Argumentum website. It's a DNN ASP.Net application employing two community extensions: 2Sxc (for most content) and Open-store (as the selling point).
The generation tool is a .Net 7.0 console/terminal application. It employs multiple browsers to draw images from a hosted Cardpen website, utilizes Magick.Net library for individual image file processing, and QuestPDF library for printable PDF creation.
Here's how to get started:
- Download the generation tool's prerelease executable from the this directory.
- Install the .NET 7.0 runtime.
- Run the program either by executing the "Argumentum.AssetConverter.exe" file (Windows) or "Argumentum.AssetConverter" (Mac) or by running the following command from a terminal:
dotnet ./Argumentum.AssetConverter.dll.
Note: In MacOS, after unzipping the App directory, you can set a terminal to the target directory with a right-click from Finder.
On MacOS or Linux systems, you may encounter certain security measures that necessitate additional steps for proper execution.
- Should you wish to directly run the executable, it may be necessary to provide the appropriate permissions. This can be achieved with the following command: "chmod +x ./Argumentum.AssetConverter".
- If you are executing the command through terminal, elevated permissions may be required for an automated browser to run. If this is the case, prepend your command with "sudo": "sudo dotnet ./Argumentum.AssetConverter.dll".
- In the event that you receive an error message indicating rejection of certain application libraries, navigate to "System Preferences -> Privacy & Security" and choose to unblock the problematic library. Please note that this may need to be repeated until all the necessary libraries are unblocked.
- For optimal functionality, ensure that in the same "Privacy & Security" settings section, download execution permissions are set to "AppStore & identified developers".
The application operates based on a pipeline that is entirely orchestrated by an extensive configuration file, "AssetConverterConfig.json". This file is produced during the application's initial run.
The top-level configuration is composed of several key sections:
- DataSets: These CSV files house the text content for the various decks of cards, including Fallacies, Scenarii, and Rules.
- CardSets: These JSON files contain templates for the faces and backs of all cardsets. The datasets are injected into these templates at runtime, with some templates using the same base JSON file, but injecting variations at runtime. Translations are also performed from French templates via conversions.
- CardSetDocuments: These are configurations to generate PDFs from the images, suitable for professional printing, home-based print-and-play, or large posters.
- MindMapDocuments: These are configurations for generating Freemind/Freeplane mindmap documents, and for customizing SVG files after exporting from one of those free tools.
- LocalizationConfig: This segment is responsible for localizing fields and strings for cards and mindmaps.
{
"Mode": "WebBasedImageGeneration",
"WebBasedGeneratorConfig": {
"EnableSVGPrompt": true,
"ShowInfoLogs": false,
"HeadLessBrowser": false,
"OverwriteExistingDocs": false,
"MaxDegreeOfParallelismCardpen": 3,
"MaxDegreeOfParallelismCardpenTranslations": 2,
"MaxDegreeOfParallelismImages": 3,
"MaxDegreeOfParallelismImageTranslations": 2,
"MaxDegreeOfParallelismDocuments": 4,
"MaxDegreeOfParallelismMindMaps": 6,
"ForceDebugParams": false,
"ForceReleaseParams": false,
"BaseTargetDirectoryName": "Target\\",
"HarvestDirectoryName": "Harvest\\",
"ImagesDirectoryName": "Images\\",
"DocumentsDirectoryName": "Documents\\",
"ReleaseCardpenUrl": "https://argumentumgames.github.io/Argumentum/Generation/CardPen/index.html",
"DebugCardpenUrl": "http://cardpen.dnndev.me/Generation/CardPen/index.html",
"DataSets": [
(...)
],
"CardSets": [
(...)
],
"CardSetDocuments": [
(...)
],
"MindMapDocuments": [
(...)
],
"LocalizationConfig": {
(...)
}
},
"BatchImageConverterConfig": { },
"Dnn2sxcConfig": { },
"MindMapCreatorConfig": { }
}The application's objective at each phase is to generate new files. If it encounters existing files, it skips the generation process, which means the application can quickly resume from where it was interrupted. Consequently, once all files have been generated, making targeted modifications is simplified. This can be done by deleting the corresponding generated documents, and the application will only regenerate the missing files.
Customization of the card data and design is made possible through modification of datasets and templates. By default, the program uses files stored in this repository, but you can download them locally, make your changes, and update the path in the configuration to your local files. Files for customization are primarily located in the Cards directory.
If you'd like to customize the app's behavior, clone this repository, build the app, and run it in Debug mode.
- Visual Studio Community (Windows)/ Visual Studio for Mac (with .NET desktop workload)
- Visual Studio Code (with "C#" and "vscode-solution" extensions)
- JetBrains Rider
Just load the "Argumentum Converters.sln" solution, build and run the included C# console csproj, and you should be started.
The entry point has other tools available in command line, but default configuration runs the WebBasedGenerator, which is the multi-stage generation tool.
That class makes use of the following components:
- HarvestManager takes in charge the automated browsing of cardpen, submitting customized json templates and download generated images
- ImageFil eGenerator manages MagickNet image processing to create individual image files
- PdfManager is responsible for creating pdf documents using QuestPdf
- MindMapDocumentConfig hols the logic to manipulate Freemind, SVG and Html mindmaps
We are open to contributions of many kinds. You don't have to clone this repository or be a developper to give a hand.
If you're interested in helping with the data at the heart of this project, consider contributing to these Google spreadsheets:
The content is regularly exported to CSV files in this repository to the following files:
- Argumentum Fallacies - Taxonomy.csv
- Argumentum Scenarii - Cards.csv
- Argumentum Rules - Cards.csv
- Argumentum Virtues - Taxonomy.csv
Direct Pull requests are welcom too.
We aim to distribute our material to the widest possible audience. If you are fluent in a language not available yet, please let us know. We'd love to add more translations.
As for existing translations, some of them were made with automated tools, so we more than welcome corrections and improvements.
If you're an expert in a field addressed by our material, we welcome suggestions for improvements, particularly regarding our extended taxonomy of fallacies.
The DNN website's data and decryption key are not included in the current commit. If you're interested in running a copy of Argumentum.games, please contact us.
The project is licensed under the LGPL-3.0 license. See the LICENSE file for more details.
You can contact the project maintainers via the issues page.
The project is based on the work of the following people:
- M.C DeMarco's cardpen is an excellent online card designer.