WC3V

Warcraft 3™ Replay Viewer.

Goal is to simulate enough of wc3 to get a 'birds eye view' of the match from a given replay.

Examples:

Usage

Running the reference `wc3v` client viewer

(NOTE: in order to show WC3 icons, you must follow the instructions on war3observer and put the resulting icons in the client/assets/wc3icons folder).

navigate to the client directory

run npm install -g http-server to install http-server

run http-server and follow the printed directions to see the locally hosted site

Also see the client README.md for more information

Running the `wc3v` map parser

note: currently built as a node project for ease of development, will eventually
be ported to web.

run node wc3v.js --replay=[REPLAY NAME]

where REPLAY NAME is the replay file path in the replays folder without any extension

example:

node wc3v.js --replay=happy-vs-grubby

Testing mode

to run wc3v in testing mode against a set of known test maps, run:

node wc3v.js --test

Latest test output:

$ node wc3v.js --test
user args:  [ '--test' ]
parse: 404.044ms
TEST PASSED:  ./replays/test-ch-movement.w3g
parse: 286.320ms
TEST PASSED:  ./replays/test-ei-movement.w3g
parse: 4746.978ms
TEST PASSED:  ./replays/bnet-ud-vs-orc-2.w3g
parse: 4265.524ms
TEST PASSED:  ./replays/happy-vs-grubby.w3g
parse: 8102.156ms
TEST PASSED:  ./replays/grubby-vs-thorzain.w3g
parse: 11543.821ms
TEST PASSED:  ./replays/happy-vs-lucifer.w3g
parse: 7434.809ms
TEST PASSED:  ./replays/cash-vs-foggy.w3g
parse: 2646.344ms
TEST PASSED:  ./replays/foggy-vs-cash-2.w3g
parse: 6350.330ms
TEST PASSED:  ./replays/crow-vs-john.w3g
parse: 8031.555ms
TEST PASSED:  ./replays/chae-vs-hawk.w3g
parse: 6523.733ms
TEST PASSED:  ./replays/soin-vs-chae.w3g
parse: 8551.837ms
TEST PASSED:  ./replays/joker-vs-lil.w3g
parse: 5771.456ms
TEST PASSED:  ./replays/terenas-stand-lv_sonik-vs-tgw.w3g
parse: 10894.642ms
TEST PASSED:  ./replays/2v2-synergy.w3g

Example output

see the happy-vs-grubby.w3g.wc3v file for a pretty-printed JSON dump of the current output for a Happy vs Grubby show match.

How It Works

See the DESIGN.md file

Implemented

unit selection / deselection
unit spawning
skill training, levels
skill usage - point, object target, summon
Right Click path tracking
Hotkey Groups
Items (partially - registrtion of shop items / giving or dropping)
Shop tracking
Game Time simulation
- unit movement is simulated (turn rates and basic pathing around known buildings and terrian WIP)
- building construction and upgrading is simulated
Rendering 'birds eye view' of game play
Player starting position detection
Mirror matches

Not implemented

Neutral Creep tracking
Item unit spawns
Gold + Wood resource tracking
Food / Upkeep tracking

Credits

Replay parsing using:

https://github.com/PBug90/w3gjs

Replay documentation from:

https://github.com/scopatz/w3g/blob/master/w3g_format.txt

Icon extraction from:

https://github.com/warlockbrawl/war3observer

All code, assets, names, and concepts are used for educational purposes only and have no commerical or retail usage. All copyright and trademark are respective to their original owners.

All software learned from public sources and from rightfully owned copies of the game.

For Educational use only.

yujintong/wc3v