installation.html



<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>Downloading and installing the toolkit &mdash; chattool 5 documentation</title>
  

  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>

    
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Programming the chattool" href="programming.html" />
    <link rel="prev" title="Overview" href="overview.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >
          

            <a href="index.html" class="icon icon-home"> chattool
          

          </a>

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
              <p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Downloading and installing the toolkit</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#starting-the-server-in-netbeans">Starting the server in Netbeans</a></li>
<li class="toctree-l2"><a class="reference internal" href="#starting-the-server-on-the-command-line">Starting the server on the command-line</a></li>
<li class="toctree-l2"><a class="reference internal" href="#starting-the-server-clients-and-automatically-logging-the-clients-in">Starting the server, clients, and automatically logging the clients in</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="programming.html">Programming the chattool</a></li>
<li class="toctree-l1"><a class="reference internal" href="datacollected.html">Data collected by the chattool</a></li>
<li class="toctree-l1"><a class="reference internal" href="tipstricks.html">Tips &amp; tricks</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
</ul>

            
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="index.html">chattool</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          
<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="index.html">Docs</a> &raquo;</li>
        
      <li>Downloading and installing the toolkit</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/installation.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="downloading-and-installing-the-toolkit">
<h1>Downloading and installing the toolkit<a class="headerlink" href="#downloading-and-installing-the-toolkit" title="Permalink to this headline">¶</a></h1>
<p>The toolkit is currently hosted on github at <a class="reference external" href="https://github.com/dialoguetoolkit/chattool">https://github.com/dialoguetoolkit/chattool</a></p>
<p>The toolkit is stored as a netbeans project (<a class="reference external" href="http://netbeans.org">http://netbeans.org</a>). You can of course use your own IDE, or run it from the command-line. However, it is easiest to run and script using netbeans. If you use netbeans, it should work “out-of-the-box” - there should be no need to play around with linking libraries and directory paths.</p>
<div class="section" id="starting-the-server-in-netbeans">
<h2>Starting the server in Netbeans<a class="headerlink" href="#starting-the-server-in-netbeans" title="Permalink to this headline">¶</a></h2>
<p>To start the server, in netbeans select “Run”</p>
</div>
<div class="section" id="starting-the-server-on-the-command-line">
<h2>Starting the server on the command-line<a class="headerlink" href="#starting-the-server-on-the-command-line" title="Permalink to this headline">¶</a></h2>
<p>To start the server, use <code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-jar</span> <span class="pre">&quot;chattool.jar</span> <span class="pre">SERVER</span></code></p>
<p>The server will listen for incoming connections on port 20000</p>
<p>To chage the port number, use <code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-jar</span> <span class="pre">&quot;chattool.jar</span> <span class="pre">SERVER</span> <span class="pre">%PORTNUMBER%</span></code></p>
<p>where <code class="docutils literal notranslate"><span class="pre">%PORTNUMBER%</span></code> is the portnumber</p>
</div>
<div class="section" id="starting-the-server-clients-and-automatically-logging-the-clients-in">
<h2>Starting the server, clients, and automatically logging the clients in<a class="headerlink" href="#starting-the-server-clients-and-automatically-logging-the-clients-in" title="Permalink to this headline">¶</a></h2>
<p>This becomes essential once you start programming interventions. Using these command-line arguments you can start the server, specify how many clients you want to start, and automatically log the clients in. This means you can test any interventions you program with a single click. Use the following syntax:</p>
<p><code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-jar</span> <span class="pre">&quot;chatool.jar&quot;</span> <span class="pre">nogui_ccname_autologin</span> <span class="pre">CONVERSATIONCONTROLLERNAME</span></code></p>
<p>For example:</p>
<p><code class="docutils literal notranslate"><span class="pre">java</span> <span class="pre">-jar</span> <span class="pre">&quot;chatool.jar&quot;</span> <span class="pre">nogui_ccname_autologin</span> <span class="pre">DyadicTurnByTurnInterface</span></code></p>
<p>his will automatically start the chattool, load the ConversationController object, initialize the clients and log them in.</p>
<p>The default number of clients to start is 2 (which is specified in <code class="docutils literal notranslate"><span class="pre">diet.Configuration.defaultGroupSize</span></code></p>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="programming.html" class="btn btn-neutral float-right" title="Programming the chattool" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
        <a href="overview.html" class="btn btn-neutral float-left" title="Overview" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2020, GJMILLS

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
</body>
</html>