Skip to main content

The RoyaleSim logo: a red crown shield with a white gear on it, outlined in gold

RoyaleSim

CI License Python Docs Discord Last commit

Engine: Rust, whole numbers only Tick: 50 ms, 20 per second Coordinates: 18,000 units to one tile

The Clash Royale battle engine your bot plays in. It runs the whole match on your own machine. Most people use it through RoyaleGym and never call it directly.

An engine battle in the RoyaleViser viewer, 18 units on the board

Install

pip install "royalegym[all]"

That installs this engine and everything else. Use Python 3.12. Install has more.

Try it

import json, royalesim

b = royalesim.Battle(card_names=None, slot_of_k=[[0, 1, 2], [0, 1, 2]])
ids = {row[0]: i for i, row in enumerate(json.loads(b.catalogue_json()))}
deck = [ids[n] for n in ["Knight", "Archer", "Goblins", "Giant", "Musketeer", "Fireball", "Arrows", "Skeletons"]]
b.reset(seed=0, decks=[deck, deck], shuffle=1, start_tick=0, elixir_milli=[5000, 5000], tower_hp=None, spawns=[])
b.step([], 100)                                          # nobody can play in the opening seconds
r = b.step([(0, 0, 9000 * 18, 10000 * 18)], 20)         # blue plays its first card, then 20 ticks pass
print(json.loads(b.state_json())["tick"], royalesim.DEPLOY_REASONS[r[0][1]])   # 120 OK

Next

  • The engine's Python API: API
  • How it works inside, how fast and how accurate it is, building from source: Engine
  • Questions: Discord

MIT License.

Metadata

Release files for royalesim 0.1.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for royalesim 0.1.18
File Size Uploaded
royalesim-0.1.18.tar.gz 3.1 MB Details

Built distributions (wheels)

Table of built distributions (wheels) for royalesim 0.1.18
File
royalesim-0.1.18-cp310-abi3-win_amd64.whl CPython 3.10 abi3 Windows x86-64 Details
royalesim-0.1.18-cp310-abi3-manylinux_2_28_x86_64.whl CPython 3.10 abi3 Linux glibc 2.28+ x86-64 Details
royalesim-0.1.18-cp310-abi3-manylinux_2_28_aarch64.whl CPython 3.10 abi3 Linux glibc 2.28+ ARM64 Details
royalesim-0.1.18-cp310-abi3-macosx_11_0_arm64.whl CPython 3.10 abi3 macOS 11.0+ ARM64 Details
royalesim-0.1.18-cp310-abi3-macosx_10_12_x86_64.whl CPython 3.10 abi3 macOS 10.12+ x86-64 Details

Total release size: 23.4 MB

Release files / royalesim-0.1.18.tar.gz

Download URL royalesim-0.1.18.tar.gz
Size 3.1 MB
Tags Source
SHA-256 checksum
How to use checksums
b8a4acc7064a345e9a61e34b0b5fa2c3ea9c9a40b56900d16b20f069c187ba9e
BLAKE2b-256 checksum
How to use checksums
6db329db7b9837a7be04ce3576e459b0209202e8f845ba30c874faaf3a8c33d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

Release files / royalesim-0.1.18-cp310-abi3-win_amd64.whl

Download URL royalesim-0.1.18-cp310-abi3-win_amd64.whl
Size 4.0 MB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
349a5dd3a15b1585f7aeb1ec77966e1c4fdcea3eb76dc21515bed2f038f60b3b
BLAKE2b-256 checksum
How to use checksums
83865719285f2cf2c94182d43a3a85d599f8a292b0aab968b40b980a8ab2de9d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

Release files / royalesim-0.1.18-cp310-abi3-manylinux_2_28_x86_64.whl

Download URL royalesim-0.1.18-cp310-abi3-manylinux_2_28_x86_64.whl
Size 4.2 MB
Tags CPython 3.10 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
6d70a7f0ad0915f96c29db5e8131e1a1088ede1da8bf58253dd1b34e40ccffd5
BLAKE2b-256 checksum
How to use checksums
940835847e163e851031e30a648d1dd8bfde85fdba6a6c239c2c6d4bf5a434ae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

Release files / royalesim-0.1.18-cp310-abi3-manylinux_2_28_aarch64.whl

Download URL royalesim-0.1.18-cp310-abi3-manylinux_2_28_aarch64.whl
Size 4.1 MB
Tags CPython 3.10 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
6f43c4ab572c3ad5691fc70b5e3c7cb1f9a70e20ba568015eb61276e19213a56
BLAKE2b-256 checksum
How to use checksums
9658fe01a21b1e844b5bd86663fd180cec07a41d2f43697bea5101946ffdebbd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

Release files / royalesim-0.1.18-cp310-abi3-macosx_11_0_arm64.whl

Download URL royalesim-0.1.18-cp310-abi3-macosx_11_0_arm64.whl
Size 4.0 MB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
c620fe3c23802e76d120f42c8b8a34351ab5fb00a87a2bffb1e02207526a79ce
BLAKE2b-256 checksum
How to use checksums
a3d5286d2a92a83f91dad8b809b34ba9fbe7a7c8d53030011a58342f15dbb9c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

Release files / royalesim-0.1.18-cp310-abi3-macosx_10_12_x86_64.whl

Download URL royalesim-0.1.18-cp310-abi3-macosx_10_12_x86_64.whl
Size 4.1 MB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
9708d1dfde9b58a8ebc3840b2b4cc2638e88186b52412fa8e2f972b51a20c0ed
BLAKE2b-256 checksum
How to use checksums
ff90a3dfe03477942c52571331ce4681b0802c26999b77ddd13c1c62af0a227b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 7, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.18 This release

6 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page