score-back/README.md

49 lines
1.1 KiB
Markdown

# Cloud Point RPC
Communication JSON RPC protocol and implementation with Unity Scene.
## API Documentation
See [API.md](API.md) for detailed request/response formats.
## Development
The project uses **Meson** build system and **C++20**.
### Dependencies
- Meson, Ninja
- GCC/Clang (C++20 support)
- Git (for subprojects)
### Build & Run
```bash
meson setup build
meson compile -C build
./build/src/cloud_point_rpc_server config.yaml
```
### Testing
```bash
meson test -C build -v
```
## Docker
You can build and run the cli using Docker.
### 1. Build Image
```bash
docker build -t cloud-point-rpc .
```
### 2. Run Container
The cli will try to connect to a **running server** on ip and port defined in config.yml file. (defined in `config.yaml` inside the image).
For simplicity, it's better to use a host network, so you will not have any headache with accessability.
> *Server is not configured to run through container, if you need, contact me*
You also can mount your own `config.yaml` to override the default settings:
```bash
docker run --network=host -it -v $(pwd)/my_config.yaml:/app/config.yaml cloud-point-rpc
```