FLO is a Warcraft III toolkit written in Rust:
- Warcraft III server implementation with reconnect, artificial delay, live streaming, and many other features
- Containerized-micro services for easy-to-use server-side API and rapid nodes deployment
- Cross-platform client-side application to run internet games through LAN emulation
- Libraries, for example, W3GS protocol parsing, map file parsing, replay parsing/generating, and LAN game creation
NOTE: Full Ubuntu Installation guide is available in INSTALL.md
- C++ Compiler
- CMake
- Latest Stable Rust
git submodule update --init --recursive
BONJOUR_SDK_HOME = <path_to_flo>/deps/bonjour-sdk-windows
PQ_LIB_DIR = <path_to_PostgreSQL>/lib
RUST_LOG=debug
DATABASE_URL=postgres://postgres:postgres@localhost/flo
FLO_CONTROLLER_SECRET='1111'
FLO_NODE_SECRET='1111'
JWT_SECRET_BASE64=MTExMQ==
Optional: If you would like to collect traces and metrics, set the these env-vars and point them to your OTEL-compatible collectors:
OTEL_EXPORTER_OTLP_TRACES_ENDPOINT: http://jaeger:4317
OTEL_EXPORTER_OTLP_METRICS_ENDPOINT: http://otel-collector:4318
OTEL_SERVICE_NAME: flo-controller-local
OTEL_DEPLOYMENT_ENVIRONMENT: local
diesel migration run
Insert a row into api_client
table with secret_key = 1111
(Corresponds to the FLO_NODE_SECRET value in above .env file)
psql -d flo -U postgres
flo=# insert into api_client (name, secret_key) values ('testclient', '1111');
Insert 2 rows into player
table with source
= 0
, source_id
= unique values (e.g 1, 2), and api_client_id
equal to the id of the row you created in api_client
.
flo=# insert into player (name, source, source_id, api_client_id) values ('player1', '0', '1', '1');
flo=# insert into player (name, source, source_id, api_client_id) values ('player2', '0', '2', '1');
Insert a row into node
with secret
= 1111
(Corresponds to the FLO_NODE_SECRET value in above .env file).
Note: If you are in an environment (like docker) where the visible IP (the client connects to) is not routable for the controller, then insert the client-routable IP as ip_addr
while setting the internal address in the internal_address
field. Note that internal_address
might also be a DNS address, while ip_addr
has to be an IPv4 address.
flo=# insert into node (name, location, ip_addr, secret, internal_address) values ('node1', 'Germany', '192.168.0.5', '1111', null);
cargo run -p flo-node-service
cargo run -p flo-controller-service
For player 1
cargo run -p flo-cli -- client 1 connect
For player 2
cargo run -p flo-cli -- client 2 connect
cargo run -p flo-cli -- server run-game 1 2
You will see 2 games correspond to the 2 players
Open 2 Warcraft III to join both games and the game will start.
- @nielsAD -- GoWarcraft3
- Fingon -- Help in game mechanics and algorithms
- @Josko -- Aura Bot
- Varlock -- the author of the GHost++ bot
- @Miezhiko -- initial Linux support
- JSamir/tofik-mamisho -- wc3-replay-parser
- PBug90 -- w3gjs