RosettaStone
RosettaStone is Hearthstone simulator using C++ with some reinforcement learning. The code is built on C++17 and can be compiled with commonly available compilers such as g++, clang++, or Microsoft Visual Studio. RosettaStone currently supports macOS (10.14 or later), Ubuntu (18.04 or later), Windows (Visual Studio 2017 or later), and Windows Subsystem for Linux (WSL). Other untested platforms that support C++17 also should be able to build RosettaStone.
Related Repositories
Key Features
- C++17 based Hearthstone library
- Console and GUI simulator program
- C++ and Python API
To-do Features
- Upgrade "The Innkeeper" to smart
- Recommend top-tier decks
- Deck tracker
- Web simulator
Roadmap
2020
- Implement all standard cards
- Rise of Shadows
- Saviors of Uldum
- Descent of Dragons
- Implement programs for playing game
- Console-based
- GUI-based
- Web-based
- Prepare "Hearthstone pro gamer" vs AI match-up
- Implement "Hearthstone Battlegrounds"
- Support various deep-learning framework for RL environment
- Tensorflow
- PyTorch
- Fully support Python API
- Write a paper on Hearthstone's RL environment
- Make architecture documents for contributors
- Make tutorials for programs
2019
- Implement all original cards
- Implement console and GUI program
- Provide RL environment using PyTorch C++ API
- Support API for another language such as Python
2018
- Implement basic system (game and task)
- Implement basic console program
- Implement some original cards
- Support cross-platform build (Windows/Linux/MacOS)
- Provide API documentation using doxygen
Cards Implementation
Basic & Classic
- 100% Basic (133 of 133 Cards)
- 100% Classic (245 of 245 Cards)
- 54% Hall of Fame (13 of 24 Cards)
Adventures
- 0% Galakrond's Awakening (0 of 35 cards)
- 0% One Night in Karazhan (0 of 45 Cards)
- 0% The League of Explorers (0 of 45 Cards)
- 0% Blackrock Mountain (0 of 31 Cards)
- 0% Curse of Naxxramas (0 of 30 Cards)
Expansions
- 0% Descent of Dragons (0 of 140 cards)
- 0% Saviors of Uldum (0 of 135 cards)
- 0% Rise of Shadows (0 of 135 cards)
- 0% Rastakhan's Rumble (0 of 135 Cards)
- 0% The Boomsday Project (0 of 135 Cards)
- 0% The Witchwood (0 of 135 Cards)
- 0% Kobolds & Catacombs (0 of 135 Cards)
- 0% Knights of the Frozen Throne (0 of 135 Cards)
- 0% Journey to Un'Goro (0 of 135 Cards)
- 0% Mean Streets of Gadgetzan (0 of 132 Cards)
- 0% Whispers of the Old Gods (0 of 134 Cards)
- 0% The Grand Tournament (0 of 132 Cards)
- 0% Goblins vs Gnomes (0 of 123 Cards)
Implementation List
Quick Start
You will need CMake to build the code. If you're using Windows, you need Visual Studio 2017 in addition to CMake.
First, clone the code:
git clone https://github.com/utilForever/RosettaStone.git --recursive
cd RosettaStone
Python API
Build and install the packagae by running
pip install -U .
NOTE: We are making Python API and related examples.
C++ API
For macOS or Linux or Windows Subsystem for Linux (WSL):
mkdir build
cd build
cmake ..
make
For Windows:
mkdir build
cd build
cmake .. -G"Visual Studio 15 2017 Win64"
MSBuild RosettaStone.sln /p:Configuration=Release
Now run console simulator:
bin/RosettaConsole
NOTE: To run GUI simulator, please check out RosettaStone GUI.
Docker
docker pull utilforever/rosettastone:latest
Now run console simulator:
docker run -it utilforever/rosettastone
[inside docker container]
/app/build/bin/RosettaConsole
More Instructions of Building the Code
To learn how to build, test, and install the SDK, please check out Install.md.
Documentation
All the documentations for the framework can be found from the project website incluing the API reference.
Presentations
Videos
Sprints
Articles
- NDC 2019
How To Contribute
Contributions are always welcome, either reporting issues/bugs or forking the repository and then issuing pull requests when you have completed some additional coding that you feel will be beneficial to the main project. If you are interested in contributing in a more dedicated capacity, then please check out Contributing.md.
Contact
You can contact me via e-mail (utilForever at gmail.com). I am always happy to answer questions or help with any issues you might have, and please be sure to share any additional work or your creations with me, I love seeing what other people are making.
Sponsors
License
The class is licensed under the Affero GPLv3 License:
RosettaStone is based on part of Sabberstone's code
Copyright (c) 2017-2019 SabberStone Team, darkfriend77 & rnilva
RosettaStone is based on part of hearthstone-ai's code
Copyright (c) 2017 Peter Shih, peter1591
RosettaStone, Hearthstone simulator using C++ with some reinforcement learning
Copyright (c) 2017-2019 RosettaStone Team
- Chris Ohk
- Youngjoong Kim
- Seunghyun Jeon
- Hyeongchan Kim
- Yoohan Park
- Hyeonsu Kim
- Junyeong Park
- Sunghwan Kim
- Kyounguk Chae
- Junryung Ju
RealStone, "Real" Hearthstone hardware using Arduino
Copyright (c) 2018-2019 RealStone Team
- Taehyeon Song
- Doun Lee
- Yeonsu Jung
- Suha Cho
RosettaStone is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License. RosettaStone is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
Hearthstone is an interactive game of Blizzard Entertainment, Inc and all rights reserved. Hearthstone is a registered trademark of Blizzard Entertainment, Inc. in the U.S. and/or other countries. This project is not affiliated with Blizzard Entertainment.