Skip to content

Fix readme and pyproject.toml #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 9, 2025
Merged

Fix readme and pyproject.toml #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
11375c0
Fix readme and pyproject.toml
Ematerasu Mar 9, 2025
9a3a835
xd
Ematerasu Mar 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,6 @@ pip install scripts-of-tribute
```

## Getting Started
### Generating Grpc Files
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:
```bash
python -m grpc_tools.protoc -IProtos --python_out=./Protos/ --grpc_python_out=Protos/. Protos/enums.proto Protos/basics.proto Protos/main.proto
```
This will generate the required gRPC Python files in the `Protos` folder.

### Creating your bot
To create your own bot, you need to inherit from the `ScriptsOfTribute.base_ai.BaseAI` class and implement the required methods:
```python
Expand Down Expand Up @@ -141,6 +134,14 @@ if __name__ == "__main__":
```
This code is available in the `examples` directory, as well with the example bots.

## Contributing
if you would like to work with the code locally you might need to (re)generate `protobuf` files.
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:
```bash
python -m grpc_tools.protoc -IProtos --python_out=./Protos/ --grpc_python_out=Protos/. Protos/enums.proto Protos/basics.proto Protos/main.proto
```
This will generate the required gRPC Python files in the `Protos` folder.

## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

Expand Down
6 changes: 3 additions & 3 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "ScriptsOfTribute"
name = "scripts-of-tribute"
version = "1.0.0"
authors = [
{ name="Dominik Budzki", email="tot.thesis.project@gmail.com" },
{ name="Ematerasu", email="tot.thesis.project@gmail.com" },
]
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#"
readme = "README.md"
requires-python = ">=3.7"
requires-python = ">=3.10"
license = { file="LICENSE" }
classifiers = [
"Programming Language :: Python :: 3",
Expand Down