Skip to content

Commit e0dcfb3

Browse files
authored
Fix readme and pyproject.toml (#1)
* Fix readme and pyproject.toml * xd
1 parent b55e03f commit e0dcfb3

File tree

2 files changed

+11
-10
lines changed

2 files changed

+11
-10
lines changed

README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,6 @@ pip install scripts-of-tribute
2626
```
2727

2828
## Getting Started
29-
### Generating Grpc Files
30-
The library uses gRPC for communication with the C# .NET engine. The `.proto` files are located in the `ScriptsOfTribute/Protos` folder. To generate the necessary Python files, run:
31-
```bash
32-
python -m grpc_tools.protoc -IProtos --python_out=./Protos/ --grpc_python_out=Protos/. Protos/enums.proto Protos/basics.proto Protos/main.proto
33-
```
34-
This will generate the required gRPC Python files in the `Protos` folder.
35-
3629
### Creating your bot
3730
To create your own bot, you need to inherit from the `ScriptsOfTribute.base_ai.BaseAI` class and implement the required methods:
3831
```python
@@ -141,6 +134,14 @@ if __name__ == "__main__":
141134
```
142135
This code is available in the `examples` directory, as well with the example bots.
143136

137+
## Contributing
138+
if you would like to work with the code locally you might need to (re)generate `protobuf` files.
139+
The library uses gRPC for communication with the C# .NET engine. The `.proto` files are located in the `ScriptsOfTribute/Protos` folder. To generate the necessary Python files, run:
140+
```bash
141+
python -m grpc_tools.protoc -IProtos --python_out=./Protos/ --grpc_python_out=Protos/. Protos/enums.proto Protos/basics.proto Protos/main.proto
142+
```
143+
This will generate the required gRPC Python files in the `Protos` folder.
144+
144145
## License
145146
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
146147

pyproject.toml

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@ requires = ["setuptools>=42", "wheel"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "ScriptsOfTribute"
6+
name = "scripts-of-tribute"
77
version = "1.0.0"
88
authors = [
9-
{ name="Dominik Budzki", email="[email protected]" },
9+
{ name="Ematerasu", email="[email protected]" },
1010
]
1111
description = "Library wrapper to create bots for Scripts of Tribute AI programming game. It runs gRPC client-servers instances and connect with main engine made in C#"
1212
readme = "README.md"
13-
requires-python = ">=3.7"
13+
requires-python = ">=3.10"
1414
license = { file="LICENSE" }
1515
classifiers = [
1616
"Programming Language :: Python :: 3",

0 commit comments

Comments
 (0)