Start Here¶
Getting Started
What RoyaleGym is, what you need, and where to begin.
Quick Start
Train your first Clash Royale bot with one file, then watch it play.
Configuration Objects
Change what your bot sees, the moves it can make, and what it's rewarded for.
API Reference
The main classes and functions of royalegym, royalelearn and royaleviser, from their docstrings.
Cheatsheets
Card names, game values, and reinforcement learning terms in plain words.
It Doesn't Work
Error messages and problems, and how to fix each one.
The five packages
You install one, royalegym[all], and it brings the other four along.
RoyaleGym
The battles your bot learns in.
RoyaleSim
The battle engine: elixir, cards, towers.
RoyaleLearn
The trainer that teaches your bot.
RoyaleViser
The viewer: watch training live, or a battle you saved.
RoyaleImitate
Start a new bot from one you trained.
See It Play¶
Your bot plays practice battles against an opponent, thousands of them, on your own computer. You decide what it gets rewarded for, and it works out the rest by trial and error. You don't need the game, a phone or an account, and you don't need to know machine learning: if you can copy a file and change a line of Python, you can train a bot.
Get started Train your first bot
Join in
Discord
Ask anything, show your bot, see what others are building. Beginner questions welcome.
GitHub
The code for all five packages. Issues and pull requests are open.
Ko-fi
RoyaleGym is free. If it's useful to you, you can buy the project a coffee.
RoyaleGym is a fan project. It is not affiliated with, endorsed or sponsored by Supercell.