cuju-arena 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (213) hide show
  1. cuju_arena-0.1.0/CHANGELOG.md +125 -0
  2. cuju_arena-0.1.0/CODE_OF_CONDUCT.md +120 -0
  3. cuju_arena-0.1.0/CONTRIBUTING.md +27 -0
  4. cuju_arena-0.1.0/LICENSE +204 -0
  5. cuju_arena-0.1.0/NOTICE +12 -0
  6. cuju_arena-0.1.0/PKG-INFO +68 -0
  7. cuju_arena-0.1.0/README.md +37 -0
  8. cuju_arena-0.1.0/SECURITY.md +10 -0
  9. cuju_arena-0.1.0/ci/sdist.py +15 -0
  10. cuju_arena-0.1.0/docs/README.md +24 -0
  11. cuju_arena-0.1.0/docs/annotations.md +173 -0
  12. cuju_arena-0.1.0/docs/cli.md +1486 -0
  13. cuju_arena-0.1.0/docs/configuration.md +344 -0
  14. cuju_arena-0.1.0/docs/evaluate-benchmark.md +284 -0
  15. cuju_arena-0.1.0/docs/evaluate-ratings.md +601 -0
  16. cuju_arena-0.1.0/docs/evaluate-tournaments.md +1167 -0
  17. cuju_arena-0.1.0/docs/evaluation.md +336 -0
  18. cuju_arena-0.1.0/docs/formats/arena/format.py +186 -0
  19. cuju_arena-0.1.0/docs/formats/arena/format.toml +80 -0
  20. cuju_arena-0.1.0/docs/formats/arena/inner.py +27 -0
  21. cuju_arena-0.1.0/docs/formats/bot/format.py +59 -0
  22. cuju_arena-0.1.0/docs/formats/bot/format.toml +13 -0
  23. cuju_arena-0.1.0/docs/formats/policy/format.py +143 -0
  24. cuju_arena-0.1.0/docs/formats/policy/format.toml +24 -0
  25. cuju_arena-0.1.0/docs/formats/samples/arena/agent.py +33 -0
  26. cuju_arena-0.1.0/docs/formats/samples/arena/manifest.yml +5 -0
  27. cuju_arena-0.1.0/docs/formats/samples/bot/bot.py +17 -0
  28. cuju_arena-0.1.0/docs/formats/samples/policy/make_model.py +23 -0
  29. cuju_arena-0.1.0/docs/formats/samples/policy/policy-gpu.toml +7 -0
  30. cuju_arena-0.1.0/docs/formats/samples/policy/policy.toml +5 -0
  31. cuju_arena-0.1.0/docs/formats/samples/squad/make_policies.py +36 -0
  32. cuju_arena-0.1.0/docs/formats/samples/squad/squad.toml +7 -0
  33. cuju_arena-0.1.0/docs/formats/squad/format.py +95 -0
  34. cuju_arena-0.1.0/docs/formats/squad/format.toml +13 -0
  35. cuju_arena-0.1.0/docs/formats.md +1498 -0
  36. cuju_arena-0.1.0/docs/getting-started.md +77 -0
  37. cuju_arena-0.1.0/docs/importing.md +266 -0
  38. cuju_arena-0.1.0/docs/index.md +37 -0
  39. cuju_arena-0.1.0/docs/matches.md +255 -0
  40. cuju_arena-0.1.0/docs/moments-and-search.md +181 -0
  41. cuju_arena-0.1.0/docs/plugins/goal-rating/plugin.py +31 -0
  42. cuju_arena-0.1.0/docs/plugins/goal-rating/plugin.toml +7 -0
  43. cuju_arena-0.1.0/docs/plugins/league-final/plugin.py +62 -0
  44. cuju_arena-0.1.0/docs/plugins/league-final/plugin.toml +8 -0
  45. cuju_arena-0.1.0/docs/plugins.md +870 -0
  46. cuju_arena-0.1.0/docs/policy-search.md +172 -0
  47. cuju_arena-0.1.0/docs/recording-format.md +590 -0
  48. cuju_arena-0.1.0/docs/recording.md +455 -0
  49. cuju_arena-0.1.0/docs/reference.md +123 -0
  50. cuju_arena-0.1.0/docs/team-files.md +320 -0
  51. cuju_arena-0.1.0/docs/teams.md +191 -0
  52. cuju_arena-0.1.0/docs/troubleshooting.md +23 -0
  53. cuju_arena-0.1.0/pyproject.toml +83 -0
  54. cuju_arena-0.1.0/src/cuju/arena/__init__.py +246 -0
  55. cuju_arena-0.1.0/src/cuju/arena/__main__.py +647 -0
  56. cuju_arena-0.1.0/src/cuju/arena/_analysis.py +38 -0
  57. cuju_arena-0.1.0/src/cuju/arena/_builtin_plugins.py +62 -0
  58. cuju_arena-0.1.0/src/cuju/arena/_cli/__init__.py +73 -0
  59. cuju_arena-0.1.0/src/cuju/arena/_cli/_arena.py +514 -0
  60. cuju_arena-0.1.0/src/cuju/arena/_cli/_engine.py +21 -0
  61. cuju_arena-0.1.0/src/cuju/arena/_cli/_references.py +125 -0
  62. cuju_arena-0.1.0/src/cuju/arena/_cli/_words.py +62 -0
  63. cuju_arena-0.1.0/src/cuju/arena/_cli/benchmark.py +200 -0
  64. cuju_arena-0.1.0/src/cuju/arena/_cli/check.py +331 -0
  65. cuju_arena-0.1.0/src/cuju/arena/_cli/config.py +51 -0
  66. cuju_arena-0.1.0/src/cuju/arena/_cli/contract.py +397 -0
  67. cuju_arena-0.1.0/src/cuju/arena/_cli/evaluate.py +212 -0
  68. cuju_arena-0.1.0/src/cuju/arena/_cli/format.py +144 -0
  69. cuju_arena-0.1.0/src/cuju/arena/_cli/plugin.py +129 -0
  70. cuju_arena-0.1.0/src/cuju/arena/_cli/rate.py +281 -0
  71. cuju_arena-0.1.0/src/cuju/arena/_config/__init__.py +3 -0
  72. cuju_arena-0.1.0/src/cuju/arena/_config/files.py +149 -0
  73. cuju_arena-0.1.0/src/cuju/arena/_config/layers.py +599 -0
  74. cuju_arena-0.1.0/src/cuju/arena/_config/schema.py +364 -0
  75. cuju_arena-0.1.0/src/cuju/arena/_evaluate/__init__.py +18 -0
  76. cuju_arena-0.1.0/src/cuju/arena/_evaluate/academy.py +644 -0
  77. cuju_arena-0.1.0/src/cuju/arena/_evaluate/benchmark.py +994 -0
  78. cuju_arena-0.1.0/src/cuju/arena/_evaluate/evaluate.py +1867 -0
  79. cuju_arena-0.1.0/src/cuju/arena/_evaluate/ratings.py +2878 -0
  80. cuju_arena-0.1.0/src/cuju/arena/_evaluate/replay.py +563 -0
  81. cuju_arena-0.1.0/src/cuju/arena/_evaluate/runner.py +742 -0
  82. cuju_arena-0.1.0/src/cuju/arena/_evaluate/schedule.py +767 -0
  83. cuju_arena-0.1.0/src/cuju/arena/_format/__init__.py +11 -0
  84. cuju_arena-0.1.0/src/cuju/arena/_format/actions.py +54 -0
  85. cuju_arena-0.1.0/src/cuju/arena/_format/annotations.py +265 -0
  86. cuju_arena-0.1.0/src/cuju/arena/_format/attachments.py +869 -0
  87. cuju_arena-0.1.0/src/cuju/arena/_format/codec.py +385 -0
  88. cuju_arena-0.1.0/src/cuju/arena/_format/frames.py +323 -0
  89. cuju_arena-0.1.0/src/cuju/arena/_format/keep.py +253 -0
  90. cuju_arena-0.1.0/src/cuju/arena/_format/overlays.py +320 -0
  91. cuju_arena-0.1.0/src/cuju/arena/_format/players.py +237 -0
  92. cuju_arena-0.1.0/src/cuju/arena/_format/recording.py +1535 -0
  93. cuju_arena-0.1.0/src/cuju/arena/_format/tracks.py +131 -0
  94. cuju_arena-0.1.0/src/cuju/arena/_format/writer.py +54 -0
  95. cuju_arena-0.1.0/src/cuju/arena/_formats/__init__.py +3 -0
  96. cuju_arena-0.1.0/src/cuju/arena/_formats/audit.py +112 -0
  97. cuju_arena-0.1.0/src/cuju/arena/_formats/blame.py +62 -0
  98. cuju_arena-0.1.0/src/cuju/arena/_formats/cache.py +88 -0
  99. cuju_arena-0.1.0/src/cuju/arena/_formats/ceilings.py +336 -0
  100. cuju_arena-0.1.0/src/cuju/arena/_formats/check_trees.py +178 -0
  101. cuju_arena-0.1.0/src/cuju/arena/_formats/checks.py +402 -0
  102. cuju_arena-0.1.0/src/cuju/arena/_formats/context.py +208 -0
  103. cuju_arena-0.1.0/src/cuju/arena/_formats/contract.py +544 -0
  104. cuju_arena-0.1.0/src/cuju/arena/_formats/cpusets.py +181 -0
  105. cuju_arena-0.1.0/src/cuju/arena/_formats/frames.py +375 -0
  106. cuju_arena-0.1.0/src/cuju/arena/_formats/gpu.py +173 -0
  107. cuju_arena-0.1.0/src/cuju/arena/_formats/host.py +794 -0
  108. cuju_arena-0.1.0/src/cuju/arena/_formats/identity.py +170 -0
  109. cuju_arena-0.1.0/src/cuju/arena/_formats/launch.py +356 -0
  110. cuju_arena-0.1.0/src/cuju/arena/_formats/migrate.py +97 -0
  111. cuju_arena-0.1.0/src/cuju/arena/_formats/pool.py +178 -0
  112. cuju_arena-0.1.0/src/cuju/arena/_formats/registry.py +412 -0
  113. cuju_arena-0.1.0/src/cuju/arena/_formats/side.py +384 -0
  114. cuju_arena-0.1.0/src/cuju/arena/_formats/terminals.py +816 -0
  115. cuju_arena-0.1.0/src/cuju/arena/_formats/threads.py +149 -0
  116. cuju_arena-0.1.0/src/cuju/arena/_formats/tree.py +810 -0
  117. cuju_arena-0.1.0/src/cuju/arena/_formats/verdicts.py +824 -0
  118. cuju_arena-0.1.0/src/cuju/arena/_formats/worker.py +315 -0
  119. cuju_arena-0.1.0/src/cuju/arena/_import/__init__.py +1 -0
  120. cuju_arena-0.1.0/src/cuju/arena/_import/core.py +554 -0
  121. cuju_arena-0.1.0/src/cuju/arena/_import/grf.py +436 -0
  122. cuju_arena-0.1.0/src/cuju/arena/_import/kaggle.py +180 -0
  123. cuju_arena-0.1.0/src/cuju/arena/_import/pickles.py +306 -0
  124. cuju_arena-0.1.0/src/cuju/arena/_import/positions.py +247 -0
  125. cuju_arena-0.1.0/src/cuju/arena/_import/replay.py +439 -0
  126. cuju_arena-0.1.0/src/cuju/arena/_moments/__init__.py +3 -0
  127. cuju_arena-0.1.0/src/cuju/arena/_moments/captions.json +46 -0
  128. cuju_arena-0.1.0/src/cuju/arena/_moments/captions.py +294 -0
  129. cuju_arena-0.1.0/src/cuju/arena/_moments/detectors.py +104 -0
  130. cuju_arena-0.1.0/src/cuju/arena/_moments/events.py +1123 -0
  131. cuju_arena-0.1.0/src/cuju/arena/_moments/listing.py +130 -0
  132. cuju_arena-0.1.0/src/cuju/arena/_moments/search.py +1618 -0
  133. cuju_arena-0.1.0/src/cuju/arena/_playing/__init__.py +3 -0
  134. cuju_arena-0.1.0/src/cuju/arena/_playing/draw.py +230 -0
  135. cuju_arena-0.1.0/src/cuju/arena/_playing/errors.py +20 -0
  136. cuju_arena-0.1.0/src/cuju/arena/_playing/play.py +1505 -0
  137. cuju_arena-0.1.0/src/cuju/arena/_plugin_standards.py +36 -0
  138. cuju_arena-0.1.0/src/cuju/arena/_registry/__init__.py +3 -0
  139. cuju_arena-0.1.0/src/cuju/arena/_registry/checkpoints.py +703 -0
  140. cuju_arena-0.1.0/src/cuju/arena/_registry/looks.py +39 -0
  141. cuju_arena-0.1.0/src/cuju/arena/_registry/manifest.py +445 -0
  142. cuju_arena-0.1.0/src/cuju/arena/_registry/teams.py +2091 -0
  143. cuju_arena-0.1.0/src/cuju/arena/_store/__init__.py +3 -0
  144. cuju_arena-0.1.0/src/cuju/arena/_store/dates.py +17 -0
  145. cuju_arena-0.1.0/src/cuju/arena/_store/home.py +227 -0
  146. cuju_arena-0.1.0/src/cuju/arena/_store/library.py +938 -0
  147. cuju_arena-0.1.0/src/cuju/arena/_store/queue.py +147 -0
  148. cuju_arena-0.1.0/src/cuju/arena/_store/ratings.py +832 -0
  149. cuju_arena-0.1.0/src/cuju/arena/_store/references.py +47 -0
  150. cuju_arena-0.1.0/src/cuju/arena/_store/runs.py +525 -0
  151. cuju_arena-0.1.0/src/cuju/arena/_store/samples.py +208 -0
  152. cuju_arena-0.1.0/src/cuju/arena/_store/stats.py +513 -0
  153. cuju_arena-0.1.0/src/cuju/arena/_text/__init__.py +3 -0
  154. cuju_arena-0.1.0/src/cuju/arena/_text/messages.py +1418 -0
  155. cuju_arena-0.1.0/src/cuju/arena/_tournaments/__init__.py +3 -0
  156. cuju_arena-0.1.0/src/cuju/arena/_tournaments/format_check.py +134 -0
  157. cuju_arena-0.1.0/src/cuju/arena/_tournaments/results.py +547 -0
  158. cuju_arena-0.1.0/src/cuju/arena/_tournaments/tournament.py +3882 -0
  159. cuju_arena-0.1.0/src/cuju/arena/_tournaments/tournament_cli.py +725 -0
  160. cuju_arena-0.1.0/src/cuju/arena/_tournaments/tournament_runner.py +2774 -0
  161. cuju_arena-0.1.0/src/cuju/arena/_version.py +7 -0
  162. cuju_arena-0.1.0/src/cuju/arena/_watch/__init__.py +3 -0
  163. cuju_arena-0.1.0/src/cuju/arena/_watch/annotate.py +769 -0
  164. cuju_arena-0.1.0/src/cuju/arena/_watch/batches.py +63 -0
  165. cuju_arena-0.1.0/src/cuju/arena/_watch/recorder.py +960 -0
  166. cuju_arena-0.1.0/src/cuju/arena/defaults/annotations.toml +39 -0
  167. cuju_arena-0.1.0/src/cuju/arena/defaults/benchmark.toml +26 -0
  168. cuju_arena-0.1.0/src/cuju/arena/defaults/evaluate.toml +155 -0
  169. cuju_arena-0.1.0/src/cuju/arena/defaults/formats.toml +19 -0
  170. cuju_arena-0.1.0/src/cuju/arena/defaults/import.toml +35 -0
  171. cuju_arena-0.1.0/src/cuju/arena/defaults/library.toml +8 -0
  172. cuju_arena-0.1.0/src/cuju/arena/defaults/play.toml +12 -0
  173. cuju_arena-0.1.0/src/cuju/arena/defaults/plugins.toml +10 -0
  174. cuju_arena-0.1.0/src/cuju/arena/defaults/ratings.toml +95 -0
  175. cuju_arena-0.1.0/src/cuju/arena/defaults/recorder.toml +25 -0
  176. cuju_arena-0.1.0/src/cuju/arena/defaults/search.toml +18 -0
  177. cuju_arena-0.1.0/src/cuju/arena/defaults/teams.toml +11 -0
  178. cuju_arena-0.1.0/src/cuju/arena/defaults/terminals.toml +15 -0
  179. cuju_arena-0.1.0/src/cuju/arena/defaults/tournament.toml +12 -0
  180. cuju_arena-0.1.0/src/cuju/arena/formats/__init__.py +30 -0
  181. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/__init__.py +9 -0
  182. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/kaggle/__init__.py +4 -0
  183. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/kaggle/answers.py +45 -0
  184. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/kaggle/format.py +115 -0
  185. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/kaggle/format.toml +55 -0
  186. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/kaggle/inner.py +25 -0
  187. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/strict/__init__.py +1139 -0
  188. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/strict/format.py +68 -0
  189. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/strict/format.toml +98 -0
  190. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/strict/limits.py +340 -0
  191. cuju_arena-0.1.0/src/cuju/arena/formats/builtin/strict/policy_worker.py +261 -0
  192. cuju_arena-0.1.0/src/cuju/arena/formats/v1/__init__.py +113 -0
  193. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_actions.py +70 -0
  194. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_child.py +239 -0
  195. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_children.py +191 -0
  196. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_context.py +65 -0
  197. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_folders.py +308 -0
  198. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_objects.py +239 -0
  199. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_observer.py +127 -0
  200. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_testing.py +98 -0
  201. cuju_arena-0.1.0/src/cuju/arena/formats/v1/_verdicts.py +241 -0
  202. cuju_arena-0.1.0/src/cuju/arena/plugins.py +826 -0
  203. cuju_arena-0.1.0/src/cuju/arena/samples/compare/sample-5v5-a.cjr +0 -0
  204. cuju_arena-0.1.0/src/cuju/arena/samples/compare/sample-5v5-b.cjr +0 -0
  205. cuju_arena-0.1.0/src/cuju/arena/samples/sample-11v11.cjr +0 -0
  206. cuju_arena-0.1.0/src/cuju/arena/samples/sample-5v5.cjr +0 -0
  207. cuju_arena-0.1.0/src/cuju/arena/samples/teams/starter/main.py +33 -0
  208. cuju_arena-0.1.0/src/cuju/arena/scenarios/benchmark_full_game_11_vs_11_easy.py +46 -0
  209. cuju_arena-0.1.0/src/cuju/arena/scenarios/benchmark_full_game_11_vs_11_hard.py +46 -0
  210. cuju_arena-0.1.0/src/cuju/arena/scenarios/benchmark_full_game_11_vs_11_medium.py +46 -0
  211. cuju_arena-0.1.0/src/cuju/arena/scenarios/benchmark_full_game_5_vs_5_easy.py +34 -0
  212. cuju_arena-0.1.0/src/cuju/arena/scenarios/benchmark_full_game_5_vs_5_hard.py +34 -0
  213. cuju_arena-0.1.0/src/cuju/arena/scenarios/benchmark_full_game_5_vs_5_medium.py +34 -0
@@ -0,0 +1,125 @@
1
+ # Changelog
2
+
3
+ ## [0.1.0] 2026-11-22
4
+
5
+ Cuju Arena is the headless match and competition package for Cuju. It runs beside
6
+ cuju-engine 0.3 and keeps its own settings and match library. Cuju Render can open the
7
+ same recordings for viewing.
8
+
9
+ ### Added
10
+
11
+ - Set the episode count with `evaluation run --episodes`.
12
+ - Keep each side's checkpoint identifier, label and step in saved match results.
13
+
14
+ - Resolve team and checkpoint references by name, step or unique identifier prefix, and open
15
+ the newest recording, evaluation or tournament with `last`.
16
+ - Read play defaults from settings and include checkpoint identity in match JSON.
17
+ - Filter recordings by day and search moments by the final score of their recording.
18
+ - Name an evaluation series directly and identify the run in its progress.
19
+
20
+ - Publish the arena as a separate package with its own Python API, command line, settings and
21
+ built-in plugins.
22
+ - Register teams and keep checkpoints. Validate submissions with the built-in Kaggle and
23
+ Strict formats, or install a format or plugin from a trusted source.
24
+ - Play and record seeded matches. Import, search and caption recordings, and export bundles
25
+ that carry a match and its attachments.
26
+ - Schedule and run tournaments, benchmark teams on academy tasks, and gather evidence through
27
+ evaluations and rating runs. Replay kept match actions to check earlier results.
28
+ - Preserve the match draw seed stream across the move.
29
+ - Record the package versions for all new rating results, including the renderer when installed.
30
+ - Show the summary of one library recording in text or JSON.
31
+
32
+ ### Changed
33
+
34
+ - Count playable benchmark cells and report when no task fits.
35
+ - Show shell polling for tournaments and compact JSON lines for scripts.
36
+ - Explain the credited team in moment search and which academy tasks fit the Squad example.
37
+
38
+ - Give rating runs separate list and show commands. Print the recording path when a rating
39
+ match is drawn.
40
+ - Separate listing columns with two spaces, and give empty listings a next command.
41
+ - Show the final score on standard error after playing a match.
42
+ - Show tournament progress on one line and report user cancellation as success.
43
+ - Offer shipped scenario, team, format and plugin choices in static shell completion.
44
+ - Keep tournament instructions on standard error. Put a short match and a tournament in the first guide.
45
+ - Report the seed drawn by tournament creation on standard error.
46
+ - Mark shipped samples that are ready to add and give the command to add one.
47
+ - Count the recordings with matching moments in search.
48
+ - Explain when the render server plays newly created tournaments.
49
+
50
+ ### Fixed
51
+
52
+ - Retry updates to live terminals when a Windows reader holds a file open.
53
+ - Save completed benchmark results before reporting that the run is done.
54
+ - Verify that Windows jobs end their child processes through native process status queries.
55
+ - Keep full checks and answer pipes working in Windows virtual environments.
56
+ - Run each check match environment on its calling thread.
57
+ - Read Windows platform details from the host for guarded formats.
58
+ - Exercise blocked match load and answer forfeits in isolated Windows match processes.
59
+ - Coordinate reads and writes of rating run progress during seeding and cancellation.
60
+ - Exit quietly when Windows closes the version command's output pipe.
61
+ - Use the original file bytes in checkpoint reuse tests on every system.
62
+ - Verify host sampling for nested check matches even when a match ends quickly.
63
+ - End pooled matches on Windows and close a format's answer pipe when its process exits.
64
+ - Complete the built-in difficulty values used in the guides.
65
+ - Reserve built-in identifiers when registering or renaming a team.
66
+
67
+ - Report a damaged engine installation with a recovery command in text and JSON.
68
+ - Resolve team references for the credited side in moment searches.
69
+ - Offer installed plugin identifiers in static shell completion for `plugin show`.
70
+ - Complete the tournament difficulty keywords in static shell scripts.
71
+ - Complete the `last` reference for recordings, evaluations and tournaments.
72
+ - Explain the team argument in checkpoint listings and report a misplaced selector as a usage error.
73
+ - Report ambiguous checkpoint labels and missing checkpoint selectors as usage errors.
74
+ - Include checkpoint identifier prefixes when checking whether a label is ambiguous.
75
+ - Report an exact team name that also selects a checkpoint as ambiguous.
76
+ - Reject new team names containing `@`, the separator for checkpoint references.
77
+ - Report an unmatched checkpoint step as missing even for a long decimal selector.
78
+ - Read evaluation series names as text when they look like numbers or other TOML values.
79
+ - Quote known evaluation series names in a single line when a series filter finds nothing.
80
+ - Report a full-match scenario that conflicts with a team's size as a play usage error.
81
+ - Spell the match count correctly in tournament rating rows.
82
+ - Use singular match counts in rating and evaluation text when one match was played.
83
+ - Resolve recording and tournament references in moment searches and reject impossible dates.
84
+ - Report invalid search numbers as usage errors.
85
+ - Require finite match clock times in search filters.
86
+ - Describe checkpoint fields, shell quoting and the full check requirement in command help.
87
+ - Show shell syntax for negated queries and multiword filter values in search help and the guide.
88
+ - Show the captions output path as printed in the command example.
89
+ - Save a tournament as stopped after Ctrl+C and describe where the status and ability appear.
90
+ - Accept earlier checkpoints in tournament scenario checks and distinguish their benchmark groups.
91
+ - Give isolated format checks separate terminals when benchmark tasks run concurrently.
92
+ - Serialize format status updates across benchmark workers to preserve failure reasons.
93
+ - Apply an explicit team size when registering a folder with a saved identity.
94
+ - Describe the Kaggle load check coverage in its verdict and explain command defaults and inputs.
95
+ - Verify Kaggle overage charges against measured round trips on each process sampler.
96
+
97
+ - Keep different checkpoints of one team separate in a rating run and in the evidence.
98
+ - Report a repeated rating model as a usage error.
99
+ - Keep checkpoint labels and training steps in ratings after tournament matches.
100
+ - List each rated checkpoint separately in the tournament ratings command.
101
+ - Report an invalid training step as a usage error.
102
+ - Defer numerical imports until the arena needs them to read or play frames.
103
+ - Read saved statistics when showing a completed evaluation.
104
+ - Summarize active and older evaluations without importing NumPy.
105
+ - Read saved rating runs and fit built-in rating tables without importing NumPy.
106
+ - Document the process tree boundary for guarded submissions in mixed matches.
107
+
108
+ - Print the command that finds valid names after a mistaken team, format, plugin or run identifier.
109
+ - Distinguish bad arguments from refusals and environment failures in headless checks.
110
+ - Let one caller adopt the earlier home when two callers start together.
111
+ - Keep the engine version under the cuju key in evaluation manifests.
112
+ - Keep home adoption notices quiet on request. Show submission diagnostics on standard error with
113
+ the verbose flag. Report a missing preflight dependency as an environment problem.
114
+ - Keep checkout ignore files out of the source distribution.
115
+ - Put the Torch stand-in first on the import path in the thread limit test.
116
+ - Read the current source of folder plugin modules after edits within the same second.
117
+ - Name the arena in the message for a refused process start.
118
+ - Measure the process trees of nested check matches from the host.
119
+ - Give a completed benchmark attempt time to release its format worker and CPU allocation.
120
+ - Point submission checks given a registered team identifier to its folder.
121
+ - Describe the team sizes that academy matches accept.
122
+ - Name the field that keeps match difficulty.
123
+ - Explain how GRF counts steps at the time limit.
124
+ - List the default Kaggle actions and explain what the full load check covers.
125
+ - Point a cancel of a finished tournament to the removal command.
@@ -0,0 +1,120 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a
6
+ harassment-free experience for everyone, regardless of age, body size, visible or invisible
7
+ disability, ethnicity, sex characteristics, gender identity and expression, level of experience,
8
+ education, socio-economic status, nationality, personal appearance, race, caste, color, religion,
9
+ or sexual identity and orientation.
10
+
11
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive,
12
+ and healthy community.
13
+
14
+ ## Our Standards
15
+
16
+ Examples of behavior that contributes to a positive environment for our community include:
17
+
18
+ - Demonstrating empathy and kindness toward other people
19
+ - Being respectful of differing opinions, viewpoints, and experiences
20
+ - Giving and gracefully accepting constructive feedback
21
+ - Accepting responsibility and apologizing to those affected by our mistakes, and learning from
22
+ the experience
23
+ - Focusing on what is best not just for us as individuals, but for the overall community
24
+
25
+ Examples of unacceptable behavior include:
26
+
27
+ - The use of sexualized language or imagery, and sexual attention or advances of any kind
28
+ - Trolling, insulting or derogatory comments, and personal or political attacks
29
+ - Public or private harassment
30
+ - Publishing others' private information, such as a physical or email address, without their
31
+ explicit permission
32
+ - Other conduct which could reasonably be considered inappropriate in a professional setting
33
+
34
+ ## Enforcement Responsibilities
35
+
36
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable
37
+ behavior and will take appropriate and fair corrective action in response to any behavior that
38
+ they deem inappropriate, threatening, offensive, or harmful.
39
+
40
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits,
41
+ code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and
42
+ will communicate reasons for moderation decisions when appropriate.
43
+
44
+ ## Scope
45
+
46
+ This Code of Conduct applies within all Cuju Arena community spaces, and also applies when an
47
+ individual is officially representing the community in public spaces. Examples of representing our community
48
+ include using an official e-mail address, posting via an official social media account, or acting
49
+ as an appointed representative at an online or offline event.
50
+
51
+ ## Enforcement
52
+
53
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the
54
+ community leaders responsible for enforcement, the maintainers of [Cuju Arena][arena], through
55
+ the contact on the maintainer's GitHub profile, [github.com/AndreKoraleski](https://github.com/AndreKoraleski). All
56
+ complaints will be reviewed and investigated promptly and fairly.
57
+
58
+ All community leaders are obligated to respect the privacy and security of the reporter of any
59
+ incident.
60
+
61
+ ## Enforcement Guidelines
62
+
63
+ Community leaders will follow these Community Impact Guidelines in determining the consequences
64
+ for any action they deem in violation of this Code of Conduct:
65
+
66
+ ### 1. Correction
67
+
68
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or
69
+ unwelcome in the community.
70
+
71
+ **Consequence**: A private, written warning from community leaders, providing clarity around the
72
+ nature of the violation and an explanation of why the behavior was inappropriate. A public apology
73
+ may be requested.
74
+
75
+ ### 2. Warning
76
+
77
+ **Community Impact**: A violation through a single incident or series of actions.
78
+
79
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the
80
+ people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a
81
+ specified period of time. This includes avoiding interactions in community spaces as well as
82
+ external channels like social media. Violating these terms may lead to a temporary or permanent
83
+ ban.
84
+
85
+ ### 3. Temporary Ban
86
+
87
+ **Community Impact**: A serious violation of community standards, including sustained
88
+ inappropriate behavior.
89
+
90
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the
91
+ community for a specified period of time. No public or private interaction with the people
92
+ involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed
93
+ during this period. Violating these terms may lead to a permanent ban.
94
+
95
+ ### 4. Permanent Ban
96
+
97
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including
98
+ sustained inappropriate behavior, harassment of an individual, or aggression toward or
99
+ disparagement of classes of individuals.
100
+
101
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
102
+
103
+ ## Attribution
104
+
105
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available
106
+ at [https://www.contributor-covenant.org/version/2/1/code_of_conduct/][v2.1].
107
+
108
+ Community Impact Guidelines were inspired by
109
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
110
+
111
+ For answers to common questions about this code of conduct, see the FAQ at
112
+ [https://www.contributor-covenant.org/faq/][FAQ]. Translations are available at
113
+ [https://www.contributor-covenant.org/translations/][translations].
114
+
115
+ [homepage]: https://www.contributor-covenant.org
116
+ [arena]: https://github.com/cuju-football/arena
117
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct/
118
+ [Mozilla CoC]: https://github.com/mozilla/inclusion
119
+ [FAQ]: https://www.contributor-covenant.org/faq/
120
+ [translations]: https://www.contributor-covenant.org/translations/
@@ -0,0 +1,27 @@
1
+ # Contributing to Cuju Arena
2
+
3
+ Discuss changes and report public bugs in the [arena issue tracker][issues].
4
+
5
+ Run the Python suite with `python -m pytest -n 4`. The suite covers the arena API, the
6
+ family command line, recorded matches, submission formats and their workers. Build the wheel
7
+ and source distribution with `python -m build`. Check them with
8
+ `python ci/check_wheel.py dist/*.whl dist/*.tar.gz`.
9
+ The source distribution includes the package, guides and the files needed to build it.
10
+ Use the repository checkout to run the suite.
11
+
12
+ Run the full suite on native Windows for each arena gate. Copy the gated checkout to a Windows
13
+ folder and build the wheel there with the local build tools. Use PowerShell to install the local
14
+ wheel with `--no-index --no-deps` into the Windows Python 3.12 environment with CPU PyTorch,
15
+ cuju-engine 0.3.0, pytest and pytest-xdist already installed. Run
16
+ `python -m pytest -n 4 -o faulthandler_timeout=900` from the copy with that environment.
17
+ The job limit test observes live descendants and uses Windows process handles to verify that
18
+ the job ends them, independently of the console language.
19
+
20
+ Keep the arena usable beside cuju-engine alone. Public engine names form its engine interface.
21
+ The renderer uses a declared arena host interface, listed and checked in the renderer repository.
22
+ The [plugin guide](docs/plugins.md) describes the interfaces that third-party extensions use.
23
+
24
+ Record user-facing changes under `changes/`, update their guides and run the reference,
25
+ links, prose and fragments checks.
26
+
27
+ [issues]: https://github.com/cuju-football/arena/issues
@@ -0,0 +1,204 @@
1
+ Cuju Arena
2
+ https://github.com/cuju-football/arena
3
+
4
+ Apache License
5
+ Version 2.0, January 2004
6
+ http://www.apache.org/licenses/
7
+
8
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
9
+
10
+ 1. Definitions.
11
+
12
+ "License" shall mean the terms and conditions for use, reproduction,
13
+ and distribution as defined by Sections 1 through 9 of this document.
14
+
15
+ "Licensor" shall mean the copyright owner or entity authorized by
16
+ the copyright owner that is granting the License.
17
+
18
+ "Legal Entity" shall mean the union of the acting entity and all
19
+ other entities that control, are controlled by, or are under common
20
+ control with that entity. For the purposes of this definition,
21
+ "control" means (i) the power, direct or indirect, to cause the
22
+ direction or management of such entity, whether by contract or
23
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
24
+ outstanding shares, or (iii) beneficial ownership of such entity.
25
+
26
+ "You" (or "Your") shall mean an individual or Legal Entity
27
+ exercising permissions granted by this License.
28
+
29
+ "Source" form shall mean the preferred form for making modifications,
30
+ including but not limited to software source code, documentation
31
+ source, and configuration files.
32
+
33
+ "Object" form shall mean any form resulting from mechanical
34
+ transformation or translation of a Source form, including but
35
+ not limited to compiled object code, generated documentation,
36
+ and conversions to other media types.
37
+
38
+ "Work" shall mean the work of authorship, whether in Source or
39
+ Object form, made available under the License, as indicated by a
40
+ copyright notice that is included in or attached to the work
41
+ (an example is provided in the Appendix below).
42
+
43
+ "Derivative Works" shall mean any work, whether in Source or Object
44
+ form, that is based on (or derived from) the Work and for which the
45
+ editorial revisions, annotations, elaborations, or other modifications
46
+ represent, as a whole, an original work of authorship. For the purposes
47
+ of this License, Derivative Works shall not include works that remain
48
+ separable from, or merely link (or bind by name) to the interfaces of,
49
+ the Work and Derivative Works thereof.
50
+
51
+ "Contribution" shall mean any work of authorship, including
52
+ the original version of the Work and any modifications or additions
53
+ to that Work or Derivative Works thereof, that is intentionally
54
+ submitted to Licensor for inclusion in the Work by the copyright owner
55
+ or by an individual or Legal Entity authorized to submit on behalf of
56
+ the copyright owner. For the purposes of this definition, "submitted"
57
+ means any form of electronic, verbal, or written communication sent
58
+ to the Licensor or its representatives, including but not limited to
59
+ communication on electronic mailing lists, source code control systems,
60
+ and issue tracking systems that are managed by, or on behalf of, the
61
+ Licensor for the purpose of discussing and improving the Work, but
62
+ excluding communication that is conspicuously marked or otherwise
63
+ designated in writing by the copyright owner as "Not a Contribution."
64
+
65
+ "Contributor" shall mean Licensor and any individual or Legal Entity
66
+ on behalf of whom a Contribution has been received by Licensor and
67
+ subsequently incorporated within the Work.
68
+
69
+ 2. Grant of Copyright License. Subject to the terms and conditions of
70
+ this License, each Contributor hereby grants to You a perpetual,
71
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
72
+ copyright license to reproduce, prepare Derivative Works of,
73
+ publicly display, publicly perform, sublicense, and distribute the
74
+ Work and such Derivative Works in Source or Object form.
75
+
76
+ 3. Grant of Patent License. Subject to the terms and conditions of
77
+ this License, each Contributor hereby grants to You a perpetual,
78
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
79
+ (except as stated in this section) patent license to make, have made,
80
+ use, offer to sell, sell, import, and otherwise transfer the Work,
81
+ where such license applies only to those patent claims licensable
82
+ by such Contributor that are necessarily infringed by their
83
+ Contribution(s) alone or by combination of their Contribution(s)
84
+ with the Work to which such Contribution(s) was submitted. If You
85
+ institute patent litigation against any entity (including a
86
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
87
+ or a Contribution incorporated within the Work constitutes direct
88
+ or contributory patent infringement, then any patent licenses
89
+ granted to You under this License for that Work shall terminate
90
+ as of the date such litigation is filed.
91
+
92
+ 4. Redistribution. You may reproduce and distribute copies of the
93
+ Work or Derivative Works thereof in any medium, with or without
94
+ modifications, and in Source or Object form, provided that You
95
+ meet the following conditions:
96
+
97
+ (a) You must give any other recipients of the Work or
98
+ Derivative Works a copy of this License; and
99
+
100
+ (b) You must cause any modified files to carry prominent notices
101
+ stating that You changed the files; and
102
+
103
+ (c) You must retain, in the Source form of any Derivative Works
104
+ that You distribute, all copyright, patent, trademark, and
105
+ attribution notices from the Source form of the Work,
106
+ excluding those notices that do not pertain to any part of
107
+ the Derivative Works; and
108
+
109
+ (d) If the Work includes a "NOTICE" text file as part of its
110
+ distribution, then any Derivative Works that You distribute must
111
+ include a readable copy of the attribution notices contained
112
+ within such NOTICE file, excluding those notices that do not
113
+ pertain to any part of the Derivative Works, in at least one
114
+ of the following places: within a NOTICE text file distributed
115
+ as part of the Derivative Works; within the Source form or
116
+ documentation, if provided along with the Derivative Works; or,
117
+ within a display generated by the Derivative Works, if and
118
+ wherever such third-party notices normally appear. The contents
119
+ of the NOTICE file are for informational purposes only and
120
+ do not modify the License. You may add Your own attribution
121
+ notices within Derivative Works that You distribute, alongside
122
+ or as an addendum to the NOTICE text from the Work, provided
123
+ that such additional attribution notices cannot be construed
124
+ as modifying the License.
125
+
126
+ You may add Your own copyright statement to Your modifications and
127
+ may provide additional or different license terms and conditions
128
+ for use, reproduction, or distribution of Your modifications, or
129
+ for any such Derivative Works as a whole, provided Your use,
130
+ reproduction, and distribution of the Work otherwise complies with
131
+ the conditions stated in this License.
132
+
133
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
134
+ any Contribution intentionally submitted for inclusion in the Work
135
+ by You to the Licensor shall be under the terms and conditions of
136
+ this License, without any additional terms or conditions.
137
+ Notwithstanding the above, nothing herein shall supersede or modify
138
+ the terms of any separate license agreement you may have executed
139
+ with Licensor regarding such Contributions.
140
+
141
+ 6. Trademarks. This License does not grant permission to use the trade
142
+ names, trademarks, service marks, or product names of the Licensor,
143
+ except as required for reasonable and customary use in describing the
144
+ origin of the Work and reproducing the content of the NOTICE file.
145
+
146
+ 7. Disclaimer of Warranty. Unless required by applicable law or
147
+ agreed to in writing, Licensor provides the Work (and each
148
+ Contributor provides its Contributions) on an "AS IS" BASIS,
149
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
150
+ implied, including, without limitation, any warranties or conditions
151
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
152
+ PARTICULAR PURPOSE. You are solely responsible for determining the
153
+ appropriateness of using or redistributing the Work and assume any
154
+ risks associated with Your exercise of permissions under this License.
155
+
156
+ 8. Limitation of Liability. In no event and under no legal theory,
157
+ whether in tort (including negligence), contract, or otherwise,
158
+ unless required by applicable law (such as deliberate and grossly
159
+ negligent acts) or agreed to in writing, shall any Contributor be
160
+ liable to You for damages, including any direct, indirect, special,
161
+ incidental, or consequential damages of any character arising as a
162
+ result of this License or out of the use or inability to use the
163
+ Work (including but not limited to damages for loss of goodwill,
164
+ work stoppage, computer failure or malfunction, or any and all
165
+ other commercial damages or losses), even if such Contributor
166
+ has been advised of the possibility of such damages.
167
+
168
+ 9. Accepting Warranty or Additional Liability. While redistributing
169
+ the Work or Derivative Works thereof, You may choose to offer,
170
+ and charge a fee for, acceptance of support, warranty, indemnity,
171
+ or other liability obligations and/or rights consistent with this
172
+ License. However, in accepting such obligations, You may act only
173
+ on Your own behalf and on Your sole responsibility, not on behalf
174
+ of any other Contributor, and only if You agree to indemnify,
175
+ defend, and hold each Contributor harmless for any liability
176
+ incurred by, or claims asserted against, such Contributor by reason
177
+ of your accepting any such warranty or additional liability.
178
+
179
+ END OF TERMS AND CONDITIONS
180
+
181
+ APPENDIX: How to apply the Apache License to your work.
182
+
183
+ To apply the Apache License to your work, attach the following
184
+ boilerplate notice, with the fields enclosed by brackets "[]"
185
+ replaced with your own identifying information. (Don't include
186
+ the brackets!) The text should be enclosed in the appropriate
187
+ comment syntax for the file format. We also recommend that a
188
+ file or class name and description of purpose be included on the
189
+ same "printed page" as the copyright notice for easier
190
+ identification within third-party archives.
191
+
192
+ Copyright [yyyy] [name of copyright owner]
193
+
194
+ Licensed under the Apache License, Version 2.0 (the "License");
195
+ you may not use this file except in compliance with the License.
196
+ You may obtain a copy of the License at
197
+
198
+ http://www.apache.org/licenses/LICENSE-2.0
199
+
200
+ Unless required by applicable law or agreed to in writing, software
201
+ distributed under the License is distributed on an "AS IS" BASIS,
202
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
203
+ See the License for the specific language governing permissions and
204
+ limitations under the License.
@@ -0,0 +1,12 @@
1
+ cuju-arena
2
+ https://github.com/cuju-football/arena
3
+ Copyright 2026 The cuju Authors.
4
+
5
+ cuju-arena plays and records matches of cuju, which reimplements Google Research Football
6
+ (https://github.com/google-research/football), Copyright 2019 Google LLC, Apache License 2.0.
7
+
8
+ The six training scenarios in the arena are adapted from GRF_MARL by Light-MALib,
9
+ https://github.com/jidiai/GRF_MARL, under the Apache License Version 2.0. They are modified from
10
+ Google Research Football, Copyright 2019 Google LLC, also under the Apache License Version 2.0.
11
+
12
+ License text is in LICENSE.
@@ -0,0 +1,68 @@
1
+ Metadata-Version: 2.5
2
+ Name: cuju-arena
3
+ Version: 0.1.0
4
+ Summary: Play, judge, record and run tournaments for Cuju football
5
+ Project-URL: Homepage, https://github.com/cuju-football/arena
6
+ Project-URL: Documentation, https://github.com/cuju-football/arena/tree/main/docs
7
+ Project-URL: Source, https://github.com/cuju-football/arena
8
+ Project-URL: Issues, https://github.com/cuju-football/arena/issues
9
+ Project-URL: Changelog, https://github.com/cuju-football/arena/blob/main/CHANGELOG.md
10
+ Author: André Koraleski
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ License-File: NOTICE
14
+ Keywords: cuju,football,google-research-football,reinforcement-learning,tournaments
15
+ Classifier: Development Status :: 4 - Beta
16
+ Classifier: Environment :: Console
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Topic :: Games/Entertainment :: Simulation
23
+ Requires-Python: >=3.10
24
+ Requires-Dist: cuju-engine<0.4,>=0.3.0
25
+ Requires-Dist: pyyaml>=6
26
+ Requires-Dist: tomli>=2; python_version < '3.11'
27
+ Provides-Extra: test
28
+ Requires-Dist: pytest-xdist>=3; extra == 'test'
29
+ Requires-Dist: pytest>=8; extra == 'test'
30
+ Description-Content-Type: text/markdown
31
+
32
+ # cuju-arena
33
+
34
+ Cuju Arena plays, judges and records matches of [cuju](https://github.com/cuju-football/engine),
35
+ a batched reimplementation of Google Research Football. It keeps submission formats, teams and
36
+ checkpoints, a library of recordings, evaluations, ratings and tournaments.
37
+
38
+ Install the arena with `pip install cuju-arena`. The installation brings in cuju-engine. Run
39
+ `cuju arena --help` to see the commands, or call the same interface as `python -m cuju.arena`.
40
+ The arena stores its data in `~/.cuju/arena`. Set `CUJU_ARENA_HOME` to keep another library.
41
+
42
+ If an upgrade from cuju 0.2.1 leaves engine files missing, run `python -m cuju.arena config show`
43
+ for the recovery command. Arena reports the damaged installation with exit status 3 and shows how
44
+ to reinstall the installed engine version. The `--json` option also writes the error to standard
45
+ output as a JSON object with the recovery command in `hint`.
46
+
47
+ Start with the [guide][getting-started] to add a team, play a match and run a small
48
+ tournament. The [documentation index][documentation] links to the Python and command-line
49
+ references.
50
+
51
+ The [Squad format example][squad] uses fixed CB, CM and CF roles. With the
52
+ built-in goalkeeper, it fits the academy benchmark tasks `corner`,
53
+ `counterattack_easy`, `counterattack_hard` and `single_goal_versus_lazy`.
54
+
55
+ Install [cuju][family] with `pip install cuju` to get the whole family. Install
56
+ [Cuju Render][render] with `pip install cuju-render` to view recordings in a browser and
57
+ use its presentation and export tools.
58
+
59
+ Cuju Arena is distributed under the [Apache License 2.0][license]. [NOTICE][notice]
60
+ credits the upstream work.
61
+
62
+ [getting-started]: https://github.com/cuju-football/arena/blob/main/docs/getting-started.md
63
+ [documentation]: https://github.com/cuju-football/arena/tree/main/docs
64
+ [squad]: https://github.com/cuju-football/arena/blob/main/docs/formats.md#squad
65
+ [family]: https://pypi.org/project/cuju/
66
+ [render]: https://github.com/cuju-football/render
67
+ [license]: https://github.com/cuju-football/arena/blob/main/LICENSE
68
+ [notice]: https://github.com/cuju-football/arena/blob/main/NOTICE
@@ -0,0 +1,37 @@
1
+ # cuju-arena
2
+
3
+ Cuju Arena plays, judges and records matches of [cuju](https://github.com/cuju-football/engine),
4
+ a batched reimplementation of Google Research Football. It keeps submission formats, teams and
5
+ checkpoints, a library of recordings, evaluations, ratings and tournaments.
6
+
7
+ Install the arena with `pip install cuju-arena`. The installation brings in cuju-engine. Run
8
+ `cuju arena --help` to see the commands, or call the same interface as `python -m cuju.arena`.
9
+ The arena stores its data in `~/.cuju/arena`. Set `CUJU_ARENA_HOME` to keep another library.
10
+
11
+ If an upgrade from cuju 0.2.1 leaves engine files missing, run `python -m cuju.arena config show`
12
+ for the recovery command. Arena reports the damaged installation with exit status 3 and shows how
13
+ to reinstall the installed engine version. The `--json` option also writes the error to standard
14
+ output as a JSON object with the recovery command in `hint`.
15
+
16
+ Start with the [guide][getting-started] to add a team, play a match and run a small
17
+ tournament. The [documentation index][documentation] links to the Python and command-line
18
+ references.
19
+
20
+ The [Squad format example][squad] uses fixed CB, CM and CF roles. With the
21
+ built-in goalkeeper, it fits the academy benchmark tasks `corner`,
22
+ `counterattack_easy`, `counterattack_hard` and `single_goal_versus_lazy`.
23
+
24
+ Install [cuju][family] with `pip install cuju` to get the whole family. Install
25
+ [Cuju Render][render] with `pip install cuju-render` to view recordings in a browser and
26
+ use its presentation and export tools.
27
+
28
+ Cuju Arena is distributed under the [Apache License 2.0][license]. [NOTICE][notice]
29
+ credits the upstream work.
30
+
31
+ [getting-started]: https://github.com/cuju-football/arena/blob/main/docs/getting-started.md
32
+ [documentation]: https://github.com/cuju-football/arena/tree/main/docs
33
+ [squad]: https://github.com/cuju-football/arena/blob/main/docs/formats.md#squad
34
+ [family]: https://pypi.org/project/cuju/
35
+ [render]: https://github.com/cuju-football/render
36
+ [license]: https://github.com/cuju-football/arena/blob/main/LICENSE
37
+ [notice]: https://github.com/cuju-football/arena/blob/main/NOTICE
@@ -0,0 +1,10 @@
1
+ # Cuju Arena security policy
2
+
3
+ Send a private vulnerability report through the [Security tab](https://github.com/cuju-football/arena/security).
4
+ Include your arena and engine versions, the operating system, and a minimal example.
5
+ Keep private submissions and recordings out of reports unless you can share them.
6
+
7
+ Team submissions, formats and plugins can run Python code. Use trusted folders and
8
+ archives. The [submission format guide](docs/formats.md) describes the arena checks
9
+ and the worker controls that apply to each format. The [plugin guide](docs/plugins.md)
10
+ describes the code that an installed or home-folder plugin runs.
@@ -0,0 +1,15 @@
1
+ # Copyright 2026 The cuju Authors
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ """Keeps the source distribution within the package file selection."""
4
+
5
+ from hatchling.builders.hooks.plugin.interface import BuildHookInterface
6
+
7
+
8
+ class SourceArchive(BuildHookInterface):
9
+ """Uses the package selection for files that govern a checkout."""
10
+
11
+ def initialize(self, version, build_data):
12
+ forced = build_data['force_include']
13
+ for path, name in list(forced.items()):
14
+ if name in ('.gitignore', '.hgignore'):
15
+ del forced[path]
@@ -0,0 +1,24 @@
1
+ cuju-arena runs submissions under declared rules and rates them
2
+
3
+ Start with a submission you trust. A submission format defines how the arena loads the
4
+ submission, checks its entry point, runs it in a match and records a forfeit. Use the same
5
+ format and scenario when you compare teams. A stored verdict identifies the checkpoint and
6
+ format that it checked.
7
+
8
+ Register each submission as a team. Its identity file records its name, size, roster and
9
+ control settings. Add a checkpoint when you have new weights or files, so an earlier result
10
+ can still name the submission that played it. The renderer reads this identity and keeps the
11
+ team's appearance in its own files.
12
+
13
+ A requested match answers one match question. An evaluation plays a team or policy against
14
+ declared opponents, and the academy benchmark plays the same tasks on the same seeds. A
15
+ tournament groups matches under a schedule and tiebreaker rules. Rating runs collect evidence
16
+ for a scenario and show how much the order of the teams depends on the matches played so far.
17
+
18
+ The arena keeps recordings, verdicts, results and the evidence behind ratings in its home.
19
+ A recording can travel as a bundle with its annotations, overlays and appearance. The
20
+ renderer can open the same recording in the browser.
21
+
22
+ The arena commands use `cuju arena`. Start with the
23
+ [arena guide index](index.md) for a first match, or read the [command line](cli.md) and
24
+ [Python reference](reference.md) for the available operations.