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 | |
| parent | 5e332bfac3dfe2075dde30568498bc6c42ca27ce (diff) | |
| download | manavis-2e344a01bc83e27135d4bc665822ae54a8a267f8.tar.gz manavis-2e344a01bc83e27135d4bc665822ae54a8a267f8.tar.bz2 manavis-2e344a01bc83e27135d4bc665822ae54a8a267f8.tar.xz manavis-2e344a01bc83e27135d4bc665822ae54a8a267f8.zip | |
Update documentation
| -rw-r--r-- | README.md | 13 | ||||
| -rw-r--r-- | public/css/style.css | 2 | ||||
| -rw-r--r-- | public/index.html | 14 |
3 files changed, 24 insertions, 5 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. diff --git a/public/css/style.css b/public/css/style.css index 2690b1f..aa66979 100644 --- a/public/css/style.css +++ b/public/css/style.css @@ -67,7 +67,7 @@ h3 { left: 0px; right: 0px; width: 647px; - height: 400px; + height: 520px; border: 1px grey solid; margin: auto; background-color: #fff; diff --git a/public/index.html b/public/index.html index baebbb2..97acd4b 100644 --- a/public/index.html +++ b/public/index.html @@ -55,9 +55,19 @@ <div id="mask"><noscript><h1>Javascript is required for this website.</h1></noscript> <div id="loadinfo" class="fader"> <h1>Manavis</h1> + <p>Manavis shows experience gain from combat logs generated by The Mana World's server, tmwAthena.<p> + <p>Manavis can operate in two modes, offline and online, depending on the selection of the checkbox below.</p> + <p>While offline, you can still analyse everything yourself as you would normally.</p> + <p> + In online mode, active filters are made public, similar to multiplayer notepad or etherpad. This can help others understand manavis and the logs, and could be used to improve manavis and the game. + </p> + <p> + Currently, all changes are applied from everyone in online mode.<br/> + This can be inconvenient, and should be changed in the near future. + </p> <input id="connect-option" name="connect" type="checkbox" checked></input> - <label for="connect">Connect to server</label> - <h3>Select records to load and display</h3> + <label for="connect">Online mode</label> + <h2>Select records to load and display</h2> <p>You can load any number of files at once.</p> <input type="file" id="input" name="records[]" multiple /> <output id="list"></output> |