PageRenderTime 53ms CodeModel.GetById 23ms RepoModel.GetById 0ms app.codeStats 1ms

/doc/index.html

https://github.com/robdgreat/TW-1606
HTML | 191 lines | 187 code | 0 blank | 4 comment | 0 complexity | 60808d6ee1857d7d7aba03be1e78332b MD5 | raw file
    

  1. <html>
    2. 

  2. <head>
    3. 

  3.     <title>Kokua - Trade Wars Assistant</title>
    4. 

  4. </head>
    5. 

  5. <body>
    6. 

  6.     <center>
    7. 

  7.         <h2>Kokua - Trade Wars Assistant</h2>
    8. 

  8.         <a href="#features">Features</a> |
    9. 

  9.         <a href="#status">Status</a> |
    10. 

  10.         <a href="#usage">Usage</a> |
    11. 

  11.         Download <!--- <a href="kokua.jnlp">WebStart</a>, -->
    12. 

  12.         <a href="http://sourceforge.net/project/showfiles.php?group_id=30183&package_id=124987">SF</a> |
    13. 

  13.         <a href="api/index.html">JavaDocs</a> |
    14. 

  14.         <a href="http://sf.net/projects/twdata">Project Site</a> |
    15. 

  15.         <!--<a href="../kokua-bot">Kokua Bot</a> |-->
    16. 

  16.         <a href="mailto:mrdon@twdata.org">Feedback</a>
    17. 

  17.     </center>
    18. 

  18.     <a name="overview" />
    19. 

  19.     <br />
    20. 

  20.     <center>
    21. 

  21.         <a href="screenshots/kokua-all.png"><img alt="Screenshot" src="screenshots/kokua-all.png" width="300"/></a>
    22. 

  22.         <br />
    23. 

  23.         <a href="screenshots.html">More Screenshots</a>
    24. 

  24.     </center>
    25. 

  25.     <h3>Overview</h3>
    26. 

  26.         <p>
    27. 

  27.         Kokua is a <a href="http://www.eisonline.com">Trade Wars 2002</a> assistant with the goal of being very easy for the user to customize for their use.  Every screen is defined in user-modifiable <a href="http://www.swixml.org">XML user interface</a> files similiar to HTML.  All actions are written in JavaScript, the scripting language of web pages, eliminating the difference between scripts and normal application behaviors.  The initial emphasis of the project is to explore visualization and data mining.
    28. 

  28.         </p>
    29. 

  29.         <p>
    30. 

  30.         Kokua was born out of a desire for an open source, Linux-compatible TW2002 helper, and a frustration working with the <a href="http://sf.net/projects/jtwat">J-TWAT</a> source code.  J-TWAT was/is a great helper, but in an effort to build the ultimate helper, code organization was sacrificed to make way for development speed making it difficult to build upon.  While Kokua borrowed many of the ideas of J-TWAT (like stream lexing triggers), Kokua is a complete rewrite.  To encourage development, pains have been taken to cleanly separate functionality and push as much code into external scripts as possible.  While JavaScript is used by default, many other scripting languages can be used.  Furthermore, all Trade Wars-related code has been separated from the main application to support other text-based games or applications.
    31. 

  31.         </p>
    32. 

  32.         <p>
    33. 

  33.         Kokua is <strong>NOT</strong> an attempt to create the ultimate TW2002 helper or scripting platform.  In fact, it has been built to work
    34. 

  34.         explictly with <a href="http://www.twxproxy.com">TWXProxy</a> (latest version at <a href="http://code.google.com/p/twxproxy-ep">Google Code</a>.
    35. 

  35.         Other helpers, like SWATH, have way more features than Kokua will probably ever have.  In particular, Kokua does not focus on scripting, leaving that to the faster
    36. 

  36.         and more capable TWXProxy.  Not that I'm against the idea of a fully-featured TW helper, I just don't have time or motivation.  
    37. 

  37.         </p>
    38. 

  38.     <a name="features" />
    39. 

  39.     <h3>Features</h3>
    40. 

  40.         <ul>
    41. 

  41.           <li>One click pair trading and SSM execution</li>
    42. 

  42.           <li>Easy to fully customize every screen</li>
    43. 

  43.           <li>Every application action modifyable, eliminating the difference between script and application action</li>
    44. 

  44.           <li>Browsable, customizable sector visualization</li>
    45. 

  45.           <li>Quick query of information using an <a href="http://jakarta.apache.org/commons/jxpath/index.html">XPath-like engine</a></li>
    46. 

  46.           <li>Statistics display to highlight game metrics</li> 
    47. 

  47.           <li>Easy macro record and playback ability</li>
    48. 

  48.           <li>Customizable reports, including port pairs</li>
    49. 

  49.           <li>Scripts can create and control complex gui forms</li>
    50. 

  50.           <li>TWXProxy support</li>
    51. 

  51.         </ul>  
    52. 

  52.      <a name="status" />
    53. 

  53.      <h3>Status</h3>
    54. 

  54.         <p>
    55. 

  55.         <span style="color:red">This code is still in the early stages of development and is not meant for actual use.  Use at your own risk</span>
    56. 

  56.         </p>
    57. 

  57.         <p>In the meantime, the following capabilies are either completed, in progress, or planned:
    58. 

  58.         </p>
    59. 

  59.         <table border="1">
    60. 

  60.           <tr>
    61. 

  61.             <th>Feature</th>
    62. 

  62.             <th>Status</th>
    63. 

  63.           </tr>
    64. 

  64.           <tr>
    65. 

  65.             <td>Terminal emulation</td>
    66. 

  66.             <td>Since 0.1</td>
    67. 

  67.           </tr>
    68. 

  68.           <tr>
    69. 

  69.             <td>Multi-session support</td>
    70. 

  70.             <td>Since 0.3</td>
    71. 

  71.           </tr>
    72. 

  72.           <tr>
    73. 

  73.             <td>Macros</td>
    74. 

  74.             <td>Since 0.1.  Can record, stop, and replay</td>
    75. 

  75.           </tr>
    76. 

  76.           <tr>
    77. 

  77.             <td>Scripting support</td>
    78. 

  78.             <td>In progress.  Currently, scripts can be written in JavaScript and display XUL forms.  Use TWXProxy for real scripts.</td>
    79. 

  79.           </tr>
    80. 

  80.           <tr>
    81. 

  81.             <td>Status display</td>
    82. 

  82.             <td>Since 0.1</td>
    83. 

  83.           </tr>
    84. 

  84.           <tr>
    85. 

  85.             <td>Text parsing</td>
    86. 

  86.             <td>In progress.  Most obvious information is gathered, but much more needs to be scraped</td>
    87. 

  87.           </tr>
    88. 

  88.           <tr>
    89. 

  89.             <td>Sector visualization</td>
    90. 

  90.             <td>Since 0.2  Sectors can be customized by embedding attributes in the sector notes and using popup menu.  Needs a lot more work to be
    91. 

  91.             really usable.</td>
    92. 

  92.           </tr>
    93. 

  93.           <tr>
    94. 

  94.             <td>In-game chat</td>
    95. 

  95.             <td>Since 0.4.  Fedspace and subspace work fine, still working on private messages.</td>
    96. 

  96.           </tr>
    97. 

  97.           <tr>
    98. 

  98.             <td>TWXProxy integration</td>
    99. 

  99.             <td>Tested as of 0.4.  Buttons on the toolbar script common TWXProxy script executions, and TWXProxy 2.0.4 comes with the Kokua
    100. 

  100.             distribution.  Yes, TWXProxy can run in Linux with Wine.
    101. 

  101.             </td>
    102. 

  102.           </tr>
    103. 

  103.           <tr>
    104. 

  104.             <td>Data storage</td>
    105. 

  105.             <td>Since 0.1.  Data is stored as serialized objects, but backed up as xml.  When a new build is discovered, the data is loaded from the xml backups.</td>
    106. 

  106.           </tr>
    107. 

  107.           <tr>
    108. 

  108.             <td>In Game Help</td>
    109. 

  109.             <td>Since 0.5.  Currently only game guides, but will add Kokua usage help if ever a need.
    110. 

  110.           </tr>
    111. 

  111.         </table>  
    112. 

  112.         <p>
    113. 

  113.             <b>Version 0.7 - June 16, 2007</b>
    114. 

  114.             <ul>
    115. 

  115.               <li>Added terminal sector linking</li>
    116. 

  116.               <li>Added radial menus to sector linking</li>
    117. 

  117.             </ul>
    118. 

  118.             <b>Version 0.6.2 - June 11, 2007</b>
    119. 

  119.             <ul>
    120. 

  120.               <li>Added scroll wheel support for terminal</li>
    121. 

  121.               <li>Improved map to better store and display newly modified data</li>
    122. 

  122.               <li>Fixed sector map to properly support background and
    123. 

  123.               foreground colors</li>
    124. 

  124.             </ul>
    125. 

  125.             <b>Version 0.6.1 - June 10, 2007</b>
    126. 

  126.             <ul>
    127. 

  127.               <li>Fixed broken backup system that wasn't extracting resources to the Kokua directory on startup</li>
    128. 

  128.             </ul>
    129. 

  129.             <b>Version 0.6 - June 9, 2007</b>
    130. 

  130.             <ul>
    131. 

  131.               <li>Added one click Pair Trading and Steal-Steal-Move (SSM) execution (scripts TWXProxy)</li>
    132. 

  132.               <li>Fixed quite a few stability issues with the lexing and data storage</li>
    133. 

  133.               <li>Added capture of bust information</li>
    134. 

  134.               <li>Contains TWXProxy</li>
    135. 

  135.               <li>Fixed sector map to be more stable and accurate</li>
    136. 

  136.             </ul>
    137. 

  137.             <b>Version 0.5 - August 14, 2004</b>
    138. 

  138.             <ul>
    139. 

  139.               <li>Sector map editable and nagivatable by popup menu</li>
    140. 

  140.               <li>Added in-game help system containing game playing guides (thanks eleqtrizit for the content)</li>
    141. 

  141.               <li>Added xxb port cluster report</li>
    142. 

  142.               <li>Added sector graph to provide distance data, Added related scripting methods</li>
    143. 

  143.               <li>Added improved report table including column sorting</li>
    144. 

  144.               <li>Other fixes and small improvements</li>
    145. 

  145.             </ul>
    146. 

  146.             <b>Version 0.4 - August 8, 2004</b>
    147. 

  147.             <ul>
    148. 

  148.               <li>Added chat functionality for fedcom and subspace</li>
    149. 

  149.               <li>Improved data gathering</li>
    150. 

  150.               <li>Added display of sector notes</li>
    151. 

  151.               <li>Added ability to customize sector map by embedding hints in sector notes</li>
    152. 

  152.               <li>Added port pair reports</li>
    153. 

  153.               <li>Added ability to completely delete sessions</li>
    154. 

  154.               <li>Improved scripting support</li>
    155. 

  155.               <li>Fixed a number of stability issues and bugs</li>
    156. 

  156.             </ul>
    157. 

  157.             <b>Version 0.3 - August 1, 2004</b>
    158. 

  158.             <ul>
    159. 

  159.               <li>Added multi-session support.</li>
    160. 

  160.               <li>Increased stability</li>
    161. 

  161.               <li>Minor GUI and internal improvements</li>
    162. 

  162.             </ul>
    163. 

  163.             <b>Version 0.2 - July 31, 2004</b>
    164. 

  164.             <ul>
    165. 

  165.               <li>Added quick query bar - support for XPath and JavaScript expressions</li>
    166. 

  166.               <li>Fixed bug with planets added multiple times</li>
    167. 

  167.               <li>Added sector detail panel in sector map</li>
    168. 

  168.               <li>Changed sector map layout to static tree layout</li>
    169. 

  169.               <li>Started work on chat interface - not completed</li>
    170. 

  170.               <li>Added statistics panel which computes a couple of interesting metrics</li>
    171. 

  171.               <li>Improved look and feel of app</li>
    172. 

  172.               <li>Many internal changes</li>
    173. 

  173.             </ul>
    174. 

  174.             <b>Version 0.1 - July 25, 2004</b>
    175. 

  175.             <ul>
    176. 

  176.                 <li>Initial development release</li>
    177. 

  177.             </ul>    
    178. 

  178.         </p>
    179. 

  179.       <a name="usage">
    180. 

  180.       <h3>Usage</h3>
    181. 

  181.         <p>
    182. 

  182.             Kokua requires Java 5 or greater to be installed.  <!--The easiest way to run Kokua is to use <a
    183. 

  183.             href="http://java.sun.com/products/javawebstart/">Java WebStart</a>, which should be automatically installed in your web browser by the Java
    184. 

  184.             installation process.  Just click on the <a href="kokua.jnlp">Kokua WebStart link</a> and the program should automatically download and
    185. 

  185.             install itself.-->
    186. 

  186.         </p>
    187. 

  187.         <p>
    188. 

  188.             Kokua comes as a completely self-contained jar file.  For Windows users that have Java 5 installed, you should be able to just double-click on the file to run it.  You can also execute the jar by running "java -jar kokua-VERSION-standalone.jar" at a command prompt where VERSION is the version you downloaded.
    189. 

  189.         </p>
    190. 

  190.        </body>
    191. 

  191.        </html>
    192. 

  192.