TCG ONE Engine Contrib

This is TCG ONE's engine contribution repository. It is mainly used for storing open source card implementations. You are welcome to submit pull requests!

The path to become a TCG ONE Developer

Essentials

• TCG ONE is only partially open source; cards are implementated in Groovy language (a superset of Java) with our custom designed DSL and each expansion (i.e. CelestialStorm.groovy) has definitions of its cards. They are are in this repository and are open source.
• On the other hand, the TCG ONE Engine is closed source and cannot be locally run by a non-staff member.
• Therefore, in order to test the cards in that expansion you may use Developer UI which is a special UI that features a simplified sandbox environment to test all cards' game play.
• Developer UI gets rebuilt and updated after every push to master branch on this repository. They trigger our CI system which will automatically rebuild and redeploy https://dev.tcgone.net with the latest code on master. The progress status can be seen on Github commit which will display a status and a link that shows the build log, which can be checked for a possible error. A 'successful' build does not mean the new code will work in runtime though, so please test ALL cards by invoking ALL of their effects on dev.

The process

1. Please read and understand [card definitions] below.
2. Please fully read the wiki to understand about the Engine and its definitions.
3. Please check out existing implementations.
4. Decide on what you're going to contribute. You may help us figuring and thinning out the bug reports reported by our members, implement missing sets, check out ideas & suggestions, uservoice idea portal, trello board for some inspiration.
5. You may ping @developer in #dev to also ask any questions regarding implementations and contribution.
6. Please fork this repository, commit your changes to your fork, then submit a pull request to master, wait for it to get merged.
7. We will review your request and merge your changes to master. Please read and adhere to Repository Rules below or your request might be rejected.
8. After your changes are merged to master, go to https://dev.tcgone.net and test your changes, fix any bugs that you encounter with additional commits.

Card definitions

In TCG ONE, cards are defined in two places:

1. carddb

• Defines card model (model module),
• Holds static information about expansions (data module), i.e. name and abbreviation of collections and name, number, card type, color, hp, moves, abilities, etc of their cards in YAML form
• Features some tooling (tools module) that allow recognizing from other card sources on the internet in order to ease the processes of retrieving and preparing some YAML files TCG ONE carddb needs.
• Supplies the data on https://tcgone.net/cards.
• Important: We are currently in a transitioning period during which only the information coming from core engine is reflected in game but soon that will be replaced by information from carddb directly.

2. tcgone-engine-contrib holds implementation as actual Groovy source code in this directory.

• A new file needs to be generated for each expansion. Don't forget to define a corresponding value in Collection enum for each new expansion. Please give attention to the existing naming convention of file/type names.
• Some legacy sets are situated inside the (closed-source) TCG ONE Engine. You may understand which sets are open source by checking Collection.java and searching this repository for a class named as the value of enumClassName field.
• The process to implement new sets can be sped up by converting from a YAML file into implementation template (see --export-impl-tmpl flag of tools repo). This template makes the development process extremely quick, the developer only needs to implement the actual effect bodies of each card in that set, where the static attributes are automatically filled in.
• For a new set, the most logical process is to first generate its YAML template (possibly by using scraping tools provided in carddb), generate its impl-tmpl, implement effects in Groovy, submit PR for review, test it on Developer UI, and so on.

Putting it live

• In order for a new set to be live in production server https://play.tcgone.net, a member of the TCG ONE Developer Team needs to approve your contribution and agree to make it available to public by listing that set in at least one Game Format. After that the server must be rolled out to a new version.
• Once you believe a new set on Developer UI runs totally fine enough to be released, please announce your request by pinging @developer in our Discord's #dev room.

Repository Rules

• NO MERGE COMMITS! Please always run git pull --rebase --autostash to get changes from the server.
• Please DO NOT commit any other file than card implementation files like metadata files, IDE garbage, etc, your merge request will not be accepted.
• Please DO NOT let your IDE/editor to push any other whitespace/indentation ruling than what's defined in src/.editorconfig. ref
• Licensing: We are using Apache License 2.0 for the source code. You confirm you accept the terms the moment you send any contribution to the repository.

return-to-contribution-guide