Skip to content

Commit aa4830f

Browse files
author
splurf
committed
updated docs
1 parent 6f4b38c commit aa4830f

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,37 @@
11
# blazed-demo
22

3-
A client-server 3D renderer featuring real-time player movement and view synchronization within a dynamic 128-tick rate system. Built with [Rust](https://www.rust-lang.org/) using [OpenGL](https://crates.io/crates/glow) and [SDL2](https://crates.io/crates/sdl2).
3+
A client-server 3D renderer featuring real-time player movement and view synchronization within a dynamic 128-tick rate system. Built with [Rust](https://www.rust-lang.org/) using [OpenGL](https://crates.io/crates/glow) and [SDL2](https://crates.io/crates/sdl2).
4+
5+
## Build
6+
Retrieve the repository:
7+
```bash
8+
git clone https://github.com/splurf/blazed-demo
9+
```
10+
11+
## Running the Client
12+
```bash
13+
cd client
14+
cargo r --release
15+
```
16+
17+
## Additional configuration
18+
**Client**
19+
```bash
20+
Usage: client server --remote-tcp-addr <REMOTE_TCP_ADDR> --local-udp-addr <LOCAL_UDP_ADDR> --remote-udp-addr <REMOTE_UDP_ADDR>
21+
22+
Options:
23+
--remote-tcp-addr <REMOTE_TCP_ADDR> Remote TCP IP address
24+
--local-udp-addr <LOCAL_UDP_ADDR> Local IP address
25+
--remote-udp-addr <REMOTE_UDP_ADDR> Remote IP address
26+
-h, --help Print help
27+
```
28+
29+
**Server**
30+
```bash
31+
Usage: server --tcp-addr <TCP_ADDR> --udp-addr <UDP_ADDR>
32+
33+
Options:
34+
-t, --tcp-addr <TCP_ADDR> TCP IP address
35+
-u, --udp-addr <UDP_ADDR> UDP IP address
36+
-h, --help Print help
37+
```

0 commit comments

Comments
 (0)