Skip to content

docs: improve README #1388

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.

Sign up for GitHub

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

Open
webbrain-one wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve README #1388

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# TCG ONE Engine Contrib

This is TCG ONE's engine contribution repository.
Expand All @@ -7,7 +9,7 @@ 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.
- 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 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](https://dev.tcgone.net/) 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](https://dev.tcgone.net).
Expand Down