Commit e9f911de authored by Joseph Walton-Rivers's avatar Joseph Walton-Rivers 🐦

link guide to website

parent 653822f6
Pipeline #2142 passed with stages
in 36 seconds
......@@ -23,11 +23,12 @@
<div class="collapse navbar-collapse" id="navbarContent">
<ul class="navbar-nav mr-auto">
<li class="nav-item"><a class="nav-link" href="domain.html">Domain Description</a></li>
<li class="nav-item"><a class="nav-link" href="description.html">Competition</a></li>
<li class="nav-item"><a class="nav-link" href="rankings.html">Rankings</a></li>
<li class="nav-item"><a class="nav-link" href="research.html">Research</a></li>
<li class="nav-item"><a class="nav-link" href="builder.html">Builder</a></li>
<li class="nav-item"><a class="nav-link" href="/domain.html">Domain Description</a></li>
<li class="nav-item"><a class="nav-link" href="/description.html">Competition</a></li>
<li class="nav-item"><a class="nav-link" href="/rankings.html">Rankings</a></li>
<li class="nav-item"><a class="nav-link" href="/research.html">Research</a></li>
<li class="nav-item"><a class="nav-link" href="/guide/">Guide</a></li>
<li class="nav-item"><a class="nav-link" href="/builder.html">Builder</a></li>
<li class="nav-item"><a class="nav-link" href="https://comp.fossgalaxy.com" target="_blank">Submit now</a></li>
</ul>
</div>
......
......@@ -32,6 +32,8 @@
<li>Although 3<sup>rd</sup> party dependencies are allowed, please ensure that you do not use native libaries (if possible) as these will not work.</li>
</ul>
<p><a href="/guide/">View the guide</a></p>
<h3>Maven Dependency</h3>
<pre><code>
&lt;dependency&gt;
......
{% extends "guide/_base.html" %}
{% block page_content2 %}
<h2>Go to the submission website</h2>
<p>A submissions are handled though <a href="https://comp.fossgalaxy.com">Comet</a>. Click on the <a href="https://comp.fossgalaxy.com/accounts/signup/">Sign Up</a> link on the Comet homepage.</p>
<p>You can register using your <a href="https://comp.fossgalaxy.com/accounts/github/login/?process=login">Github account</a>, or use the registration form</p>
<img src="img/comet_signup.png" />
{% set active_page = 'write' %}
<h2>Click on Competitions</h2>
<p>Click on the competitions link on the top of the page.</p>
<img src="img/comet_comp.png" />
{% block page_content %}
<h2>The Interface</h2>
<p class="lead">This page will describe the process by which agents are prompted by the game engine to make moves.</p>
<h2>Select the track</h2>
<p>Click on the enter button for the track you are intrested in</p>
<img src="img/comet_enter.png" />
<h3>The Constructor</h3>
<p>Your agent should have a no-arg constructor which is public. This will be used by the game engine to create your agent. You should not use any static state as part of your agent.</p>
<h2>Enter your agent details</h2>
<p>Enter a name for your agent, this must match the name of the agent you submit.</p>
<img src="img/comet_create.png" />
<p class="alert alert-info">
For the Mirror and Mixed tracks you can assume that the agent will be re-created for each game played. This is not the case for the learning track however, for this track see the <a href="#advanced">Advanced Methods</a> section below.
</p>
<p>You are now registered to take part in the competition, you can either register for more tracks or proceed to downloading the sample submission</p>
{% endblock %}
<h3>The doMove Method</h3>
<p>The primary way in which your agent interacts with the game is though the doMove method. This is called every time your agent needs to make a decision. You are passed two arguments, your playerID and a copy of the current game state from your perspective.</p>
<p>Your agent should return a valid move action from this method. If you return an illegal move, the game will end and the result will be recorded as a disqualification.</p>
<pre><code> public Action doMove(int playerID, GameState state)</code></pre>
<div class="alert alert-warning">
<h3>Honour System</h3>
<p>Although we do our best to prevent cheating, the system is not foolproof. If you are caught cheating your account will be banned. If you have come up with a statergy and you are not sure if it is permitted, contact the competition organisers who will be happy to assist you.</p>
</div>
<hr />
{% block next_step %}
<div class="d-flex justify-content-between">
<p class="text-right">Now you're written your agent, you're ready to submit.</p>
<a class="btn btn-primary" href="/guide/submit.html">Submitting your agent</a>
</div>
<h3 id="advanced">Advanced Methods</h3>
<p class="lead">The agent interface includes some 'advanced' methods that can be used by your agent.</p>
<h4>The receiveID method</h4>
<p>This method is called when the game starts. For most tracks, this will only ever be called once per agent.</p>
<pre><code> public void receiveID(int playerID)</code></pre>
<hr />
{% block next_step %}
<div class="d-flex justify-content-between">
<p class="text-right">Now you're written your agent, you're ready to submit.</p>
<a class="btn btn-primary" href="/guide/submit.html">Submitting your agent</a>
</div>
{% endblock %}
{% endblock %}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment