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.14

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.14
File Size Uploaded
royalesim-0.1.14.tar.gz 3.0 MB Details

Built distributions (wheels)

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

Total release size: 22.9 MB

Release files / royalesim-0.1.14.tar.gz

Download URL royalesim-0.1.14.tar.gz
Size 3.0 MB
Tags Source
SHA-256 checksum
How to use checksums
ff940d655bda3a87f54989d1f009aec64b1e4366e139c4a422f006fb0bc61d69
BLAKE2b-256 checksum
How to use checksums
1829cd3b9848d38eaa7e6e60283965f5c7abeabd1d123b0d2333e40667502946
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 5, 2026.

Transparency log

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

Download URL royalesim-0.1.14-cp310-abi3-win_amd64.whl
Size 3.9 MB
Tags CPython 3.10 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
bbfd83ef3a5e89e3ba5117961bd83ccf0b4719ba620e297eb032ac52f06c41c2
BLAKE2b-256 checksum
How to use checksums
f2d7dfe65606b35e67b14437f4258db8fb61485531819973aa0e16efd7861038
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 5, 2026.

Transparency log

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

Download URL royalesim-0.1.14-cp310-abi3-manylinux_2_28_x86_64.whl
Size 4.1 MB
Tags CPython 3.10 Linux glibc 2.28+ x86-64 abi3
SHA-256 checksum
How to use checksums
436c5bd1d02a9a40faec0f7af6d9265d3b491284715157e388a42e1cf3db77c5
BLAKE2b-256 checksum
How to use checksums
3416549b14950e74d670f7c4c4642317321d1b1a18cf43cbbd45a2c5b2823ee5
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 5, 2026.

Transparency log

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

Download URL royalesim-0.1.14-cp310-abi3-manylinux_2_28_aarch64.whl
Size 4.0 MB
Tags CPython 3.10 Linux glibc 2.28+ ARM64 abi3
SHA-256 checksum
How to use checksums
5bc5b92aa81d82c786f0c82c923a22ac52ac9472c99fede81089c115897b421c
BLAKE2b-256 checksum
How to use checksums
2c5942b312acd32a107a538808f90086b183022f585a0b16273759b80774096a
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 5, 2026.

Transparency log

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

Download URL royalesim-0.1.14-cp310-abi3-macosx_11_0_arm64.whl
Size 3.9 MB
Tags CPython 3.10 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
580a62988bd9a02e1bef8b7ad7dba9aea9784315f29a0063cbf2a3957a87edc7
BLAKE2b-256 checksum
How to use checksums
cbcde8922e302368e4b38a2f5c7b1416cf8db612aaa9b60bea0b8b38c43f60d4
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 5, 2026.

Transparency log

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

Download URL royalesim-0.1.14-cp310-abi3-macosx_10_12_x86_64.whl
Size 4.0 MB
Tags CPython 3.10 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
feef7a46e536291a7c6c84e20a1bf339ce4c4012f3e4542ae619568a69e4465f
BLAKE2b-256 checksum
How to use checksums
efcc05902b7ab4859ed66dc65621f6bc87b74f31abe14eeed7e9fad528f88ddb
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 5, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.1.14 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