VoiceAttack-profiles/RatAttack/index.html
2022-09-19 16:31:43 +00:00

294 lines
16 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="author" content="alterNERDtive" /><link rel="canonical" href="https://alterNERDtive.github.io/VoiceAttack-profiles/RatAttack/" />
<link rel="shortcut icon" href="../img/favicon.ico" />
<title>RatAttack - alterNERDtive VA profiles</title>
<link rel="stylesheet" href="../css/theme.css" />
<link rel="stylesheet" href="../css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "RatAttack";
var mkdocs_page_input_path = "RatAttack.md";
var mkdocs_page_url = "/VoiceAttack-profiles/RatAttack/";
</script>
<script src="../js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="../js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href=".." class="icon icon-home"> alterNERDtive VA profiles
</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" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="..">Home</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Install</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../requirements/">Requirements</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../installing/">Installing</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../upgrading/">Upgrading</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Configure</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../configuration/general/">General Configuration</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/RatAttack/">RatAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../configuration/StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Use</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../general/">General Commands</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../EliteAttack/">EliteAttack</a>
</li>
<li class="toctree-l1 current"><a class="reference internal current" href="./">RatAttack</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#going-onoff-duty">Going On/Off Duty</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#case-handling">Case Handling</a>
<ul>
<li class="toctree-l3"><a class="reference internal" href="#getting-case-information">Getting Case Information</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#opening-a-case">Opening a Case</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#making-calls">Making Calls</a>
</li>
<li class="toctree-l3"><a class="reference internal" href="#closing-a-case">Closing a Case</a>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#general-irc-interaction">General IRC Interaction</a>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../SpanshAttack/">SpanshAttack</a>
</li>
<li class="toctree-l1"><a class="reference internal" href="../StreamAttack/">StreamAttack</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Issues</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../troubleshooting/">Troubleshooting</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/blob/release/CHANGELOG.md">⎋ Changelog</a>
</li>
<li class="toctree-l1"><a class="" href="https://github.com/alterNERDtive/VoiceAttack-profiles/issues/">⎋ Report a Bug</a>
</li>
</ul>
<p class="caption"><span class="caption-text">Watch in Action</span></p>
<ul>
<li class="toctree-l1"><a class="" href="https://twitch.tv/alterNERDtive">⎋ Twitch</a>
</li>
<li class="toctree-l1"><a class="" href="https://www.youtube.com/channel/UC3XNZA7xWed1zM1AWOOdmog">⎋ Youtube</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="..">alterNERDtive VA profiles</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=".." class="icon icon-home" alt="Docs"></a> &raquo;</li>
<li>Use &raquo;</li>
<li>RatAttack</li>
<li class="wy-breadcrumbs-aside">
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles/edit/devel/docs/RatAttack.md"
class="icon icon-github"> Edit on GitHub</a>
</li>
</ul>
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Breadcrumb Navigation">
<a href="../EliteAttack/" class="btn btn-neutral float-left" title="EliteAttack"><span class="icon icon-circle-arrow-left" aria-hidden="true"></span> Previous</a>
<a href="../SpanshAttack/" class="btn btn-neutral float-right" title="SpanshAttack">Next <span class="icon icon-circle-arrow-right" aria-hidden="true"></span></a>
</div>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="ratattack">RatAttack<a class="headerlink" href="#ratattack" title="Permanent link">&para;</a></h1>
<p>This profile facilitates <a href="https://www.fuelrats.com">Fuel Ratting</a>. It aims to
eliminate as much of the required manual task and attention switching as
possible via automation and voice commands.</p>
<p>If you dont know what the Fuel Rats are, come hang out and ask :)</p>
<h2 id="going-onoff-duty">Going On/Off Duty<a class="headerlink" href="#going-onoff-duty" title="Permanent link">&para;</a></h2>
<p>When you are on duty, RatAttack will automatically announce cases coming in
through IRC. When off duty, it wont.</p>
<ul>
<li><code>[enable;disable] rat duty</code>: puts you on/off duty.</li>
<li><code>open [fuel rats;] dispatch board</code>: opens the web dispatch board.</li>
</ul>
<h2 id="case-handling">Case Handling<a class="headerlink" href="#case-handling" title="Permanent link">&para;</a></h2>
<p><a href="../configuration/RatAttack/#getting-case-data-from-irc">If you have your IRC client setup
properly</a>, VoiceAttack
will hold a list with all rat cases that have come in while you had it running.
It will save the case number, CMDR name, system, O₂ status and platform. There
are several commands you can run on this list, giving it a case number:</p>
<h3 id="getting-case-information">Getting Case Information<a class="headerlink" href="#getting-case-information" title="Permanent link">&para;</a></h3>
<ul>
<li><code>rat case number [0..30] details</code>: Will give you all stored info on a case.</li>
<li><code>[current;] rat case details</code>: Will give you all stored info on the currently
open case.</li>
<li><code>distance to current rat case</code>: Will give you the distance from your current
location to the currently opened rat case.</li>
<li><code>distance to rat case number [0..30]</code>: Will give you the distance from your
current system to a cases system.</li>
<li><code>latest rat case details</code>: Will give you the case data for the latest incoming
case.</li>
<li><code>nearest commander to rat case number [0..30]</code>: Will give you the nearest of
your CMDRs with their distance to a cases system. <a href="../configuration/RatAttack/#announcing-your-nearest-cmdr">Requires some
setup</a>.</li>
<li><code>nearest commander to [the;] rat case</code>: Will give you the nearest of your
CMDRs with their distance to the current cases system. <a href="../configuration/RatAttack/#announcing-your-nearest-cmdr">Requires some
setup</a>.</li>
</ul>
<h3 id="opening-a-case">Opening a Case<a class="headerlink" href="#opening-a-case" title="Permanent link">&para;</a></h3>
<ul>
<li><code>open rat case number [0..30]</code>: Opens rat case with the given number. If there
is no case data for that case (e.g. because you dont have your IRC client set
up properly), it will still open it, just not have any data on it.</li>
<li><code>open [latest;] rat case</code>: Opens the latest rat case that has come in through
IRC. Will only work if you actually have <a href="../configuration/RatAttack/#getting-case-data-from-irc">your IRC client setup to send case
announcements to
VoiceAttack</a>.</li>
</ul>
<p>Opening a case will automatically copy the clients system to the clipboard for
easy route plotting. This can be disabled.</p>
<h3 id="making-calls">Making Calls<a class="headerlink" href="#making-calls" title="Permanent link">&para;</a></h3>
<p>There are a bunch of calls you can make for a case, the most common are modelled
through VoiceAttack commands. The descriptive commands (e.g. “system confirmed”)
will be shortened to the usual IRC short hands (e.g. “sysconf”). If you need
something more unusual you can either still manually type it into your IRC
client or use the “General IRC Integration”, see below.</p>
<ul>
<li><code>call [1..20] jumps [and login;and takeoff;left;]</code>: Calls jumps for the
currently open case. You can optionally include that you will still have to
login to the game or have to take off from your current
station/port/outpost/planet.</li>
<li><code>call jumps [left;]</code>: Calls jumps for the currently open case based on a
neutron trip (requires SpanshAttack) or a plotted ingame route.</li>
<li><code>call friend [positive;negative] [in pg;in private group;in solo;in main menu;sysconf;system confirmed;]</code>:
Friend request confirmations, with all the
things you might want to / should call with it.</li>
<li><code>call [beacon;fuel;instance;pos;position;prep;sys;system;wing] [positive;negative]</code>:
All the stuff you usually need for ratting after you have received the friend request.</li>
<li><code>call wing pending</code>: Calls “wr pending” for when it takes 30s again to
actually show up.</li>
<li><code>call client in [exclusion zone;main menu;open;open sysconf;pg;private group;solo;super cruise]</code>:
Callouts for all the various things a client could get themselves into.</li>
<li><code>call [client destroyed;client offline;sysconf;system confirmed]</code>: This is the
command you dont want to use. Include sysconf in your “friend+” or “in open”
calls, and make sure you will never have to call “client destroyed”, would
you?</li>
</ul>
<p>By default, VoiceAttack will ask for confirmation before sending calls to the
<code>#fuelrats</code> channel.</p>
<h3 id="closing-a-case">Closing a Case<a class="headerlink" href="#closing-a-case" title="Permanent link">&para;</a></h3>
<ul>
<li><code>[close;clear] rat case</code>: Closes the currently open rat case.</li>
</ul>
<h2 id="general-irc-interaction">General IRC Interaction<a class="headerlink" href="#general-irc-interaction" title="Permanent link">&para;</a></h2>
<p>Using EDDI to read the games journal, you can send messages to IRC from Elites
ingame chat.</p>
<p><strong>Be aware that the chat message will still appear in the ingame chat channel
you send it to!</strong></p>
<p>I recommend using local chat and limiting the use to instances that will
probably not have other players in it (e.g. instanced in normal space with the
client or in SC in some remote system out in the black on a long range rescue).</p>
<ul>
<li>#fuelrats: Use <code>.fr &lt;message&gt;</code> to have VoiceAttack send
<code>#&lt;caseNumber&gt; &lt;message&gt;</code> to #fuelrats or yell at you when you
are not on a case.</li>
<li>#ratchat: Use <code>.rc &lt;message&gt;</code> to have VoiceAttack send <code>&lt;message&gt;</code> to
#ratchat.</li>
</ul>
<p>Make sure <a href="../configuration/RatAttack/#sending-text-to-fuelrats-irc">that your IRC client is setup
properly</a>.</p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="../EliteAttack/" class="btn btn-neutral float-left" title="EliteAttack"><span class="icon icon-circle-arrow-left"></span> Previous</a>
<a href="../SpanshAttack/" class="btn btn-neutral float-right" title="SpanshAttack">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span>
<a href="https://github.com/alterNERDtive/VoiceAttack-profiles" class="fa fa-github" style="color: #fcfcfc"> GitHub</a>
</span>
<span><a href="../EliteAttack/" style="color: #fcfcfc">&laquo; Previous</a></span>
<span><a href="../SpanshAttack/" style="color: #fcfcfc">Next &raquo;</a></span>
</span>
</div>
<script>var base_url = '..';</script>
<script src="../js/theme_extra.js" defer></script>
<script src="../js/theme.js" defer></script>
<script src="../search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>