Spaces:
Build error
Build error
Add documentation to execute the rs wordle player to the readme
Browse files
README.md
CHANGED
|
@@ -68,6 +68,28 @@ For word suggestion, run:
|
|
| 68 |
* a 2 if the letter was in the word and in the correct position
|
| 69 |
* --model_name [MODEL_NAME] --> Name of the pretrained model file which will play the game
|
| 70 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 71 |
## Branches
|
| 72 |
There are three different working branches on the project, each one with a different representation of the state of the game
|
| 73 |
|
|
|
|
| 68 |
* a 2 if the letter was in the word and in the correct position
|
| 69 |
* --model_name [MODEL_NAME] --> Name of the pretrained model file which will play the game
|
| 70 |
|
| 71 |
+
## Make the model play RS-Wordle alone!
|
| 72 |
+
It is possible to make the model play the Rootstrap version of Wordle. To do that, you need to:
|
| 73 |
+
|
| 74 |
+
* Have a Rootstrap mail account
|
| 75 |
+
* Get access to the Firebase database of the RS-Wordle instance and a private key obtained from the Service accounts Project Setting. This is for authentication and has to be stored as a JSON file.
|
| 76 |
+
* Use a pre-trained model that will play the game.
|
| 77 |
+
|
| 78 |
+
Then, you need to create a .env file in the project root with the following properties:
|
| 79 |
+
|
| 80 |
+
```
|
| 81 |
+
RS_FIREBASE_CREDENTIALS_PATH=path/to/private_key.json
|
| 82 |
+
RS_WORDLE_USER=rootstrap_mail_user
|
| 83 |
+
RS_WORDLE_URL=rs_wordle_instance_url
|
| 84 |
+
RS_WORDLE_MODEL_NAME=pretrained_model_path
|
| 85 |
+
RS_WORDLE_PASSWORD=rootstrap_mail_password
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
Using [Selenium](https://www.selenium.dev/), the program simulates user interaction with the browser and makes the model play the game, retrieving the result of each attempt from the Firebase database.
|
| 89 |
+
To start the fun, navigate to the project root in your terminal and execute:
|
| 90 |
+
|
| 91 |
+
`python -m rs_wordle_player.rs_wordle_player`
|
| 92 |
+
|
| 93 |
## Branches
|
| 94 |
There are three different working branches on the project, each one with a different representation of the state of the game
|
| 95 |
|