diff options
| author | Freeyorp <TheFreeYorp@NOSPAM.G.m.a.i.l.replace> | 2013-05-13 00:38:39 +1200 |
|---|---|---|
| committer | Freeyorp <TheFreeYorp@NOSPAM.G.m.a.i.l.replace> | 2013-05-13 00:41:08 +1200 |
| commit | 2e344a01bc83e27135d4bc665822ae54a8a267f8 (patch) | |
| tree | fec54877976f2f15be492e43d601454d884c7d2b /README.md | |
| parent | 5e332bfac3dfe2075dde30568498bc6c42ca27ce (diff) | |
| download | manavis-2e344a01bc83e27135d4bc665822ae54a8a267f8.tar.gz manavis-2e344a01bc83e27135d4bc665822ae54a8a267f8.tar.bz2 manavis-2e344a01bc83e27135d4bc665822ae54a8a267f8.tar.xz manavis-2e344a01bc83e27135d4bc665822ae54a8a267f8.zip | |
Update documentation
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 11 insertions, 2 deletions
@@ -1,8 +1,17 @@ manavis ======= -This program is designed to parse and visualise combat logs generated by the tmwAthena server. +Manavis parses and visualises combat logs generated by the tmwAthena server. -To run, place this project in a location served by a web server, or run python -m SimpleHTTPServer from the project root and connect to localhost:8000. +Manavis can operate in two modes, offline and online. + +To run in offline mode, place the public/ folder in a location served by a web server, or run python -m SimpleHTTPServer from it, and connect to localhost:8000. +While offline, you can still analyse everything as you would normally. + +To run in online mode, run node index.js from the project root, and connect to localhost:3000. +In online mode, active filters are broadcast to other users, similar to multiplayer notepad or etherpad. +Currently, all changes are applied from everyone in online mode. +This can be inconvenient, and should be changed in the near future. +You can still operate offline by unselecting the checkbox at the loading screen. Significant amounts of processing in javascript are required. It is recommended you use recent versions of a browser such as chromium. |