Skip to content

kaonis/CryptoCross

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

287 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cryptocross

Build and Test

A Java implementation of a word game where a user forms words from letters on a board and is scored based on the words sum of the individual letters values

Requirements

  • Java 17 or higher (OpenJDK recommended)

Building and Running

cd CryptoCross
ant clean jar
java -jar dist/CryptoCross.jar

Testing

cd CryptoCross
# Cross-platform way using Ant
ant run-junit5-tests

# Or manually (use ; instead of : on Windows)
ant compile-test
java -jar lib/junit-platform-console-standalone-1.10.1.jar --class-path build/classes:build/test/classes --scan-class-path

Strict-mode focused checks can be run from the repository root with:

./scripts/run_strict_mode_checks.sh

Daily roadmap merge summaries (defaults to today) can be generated with:

./scripts/summarize_daily_merges.sh [YYYY-MM-DD]

Roadmap/index/changelog consistency can be checked with:

./scripts/check_roadmap_links.sh

Roadmap changelog entry formatting can be checked with:

./scripts/check_roadmap_changelog_format.sh

Workflow trigger policy (manual-only workflow_dispatch) can be checked with:

./scripts/check_manual_workflow_triggers.sh

PR body required sections can be linted with:

./scripts/check_pr_body_sections.sh /path/to/pr_body.md
# or from GitHub directly:
gh pr view <number> --json body --jq .body | ./scripts/check_pr_body_sections.sh

PR title format can be linted with:

./scripts/check_pr_title_format.sh /path/to/pr_title.txt
# or from GitHub directly:
gh pr view <number> --json title --jq .title | ./scripts/check_pr_title_format.sh

Operations index doc references can be checked with:

./scripts/check_operations_index_links.sh

Run all pre-merge guard checks with one command:

./scripts/run_pre_merge_guard_checks.sh

Open issue status for the active roadmap can be listed with:

./scripts/roadmap_open_issue_status.sh

Suggest the next roadmap version number from the current index with:

./scripts/suggest_next_roadmap_version.sh

Gameplay settings/defaults snapshot:

  • docs/gameplay_settings_snapshot.md

Operations/runbook documentation index:

  • docs/operations_index.md

Continuous Integration

This project uses GitHub Actions for building and testing with manual triggering only (workflow_dispatch) to control Actions usage. Run the workflow from the Actions tab when needed. It performs:

  • Compilation with Java 17
  • Execution of all unit tests
  • JAR artifact generation

Manual-only workflow and Actions budget guidance:

  • docs/manual_workflow_runbook.md

About

A crosswords game with GUI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors