the-great-game/docs/codox/index.html

<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>The-great-game 0.1.1-SNAPSHOT</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">The-great-game</span> <span class="project-version">0.1.1-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="Baking-the-world.html"><div class="inner"><span>Baking the world</span></div></a></li><li class="depth-1 "><a href="Populating-a-game-world.html"><div class="inner"><span>Populating a game world</span></div></a></li><li class="depth-1 "><a href="Settling-a-game-world.html"><div class="inner"><span>Settling a game world</span></div></a></li><li class="depth-1 "><a href="The-spread-of-knowledge-in-a-large-game-world.html"><div class="inner"><span>The spread of knowledge in a large game world</span></div></a></li><li class="depth-1 "><a href="Voice-acting-considered-harmful.html"><div class="inner"><span>Voice acting considered harmful</span></div></a></li><li class="depth-1 "><a href="economy.html"><div class="inner"><span>Game world economy</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to the-great-game</span></div></a></li><li class="depth-1 "><a href="modelling_trading_cost_and_risk.html"><div class="inner"><span>Modelling trading cost and risk</span></div></a></li><li class="depth-1 "><a href="naming-of-characters.html"><div class="inner"><span>Naming of Characters</span></div></a></li><li class="depth-1 "><a href="on-dying.html"><div class="inner"><span>On Dying</span></div></a></li><li class="depth-1 "><a href="orgnic-quests.html"><div class="inner"><span>Organic Quests</span></div></a></li><li class="depth-1 "><a href="sandbox.html"><div class="inner"><span>Sandbox</span></div></a></li><li class="depth-1 "><a href="sexual-dimorphism.html"><div class="inner"><span>Sexual dimorphism</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>the-great-game</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>agent</span></div></div></li><li class="depth-3"><a href="the-great-game.agent.agent.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>agent</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>gossip</span></div></div></li><li class="depth-3 branch"><a href="the-great-game.gossip.gossip.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gossip</span></div></a></li><li class="depth-3"><a href="the-great-game.gossip.news-items.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>news-items</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>merchants</span></div></div></li><li class="depth-3 branch"><a href="the-great-game.merchants.markets.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>markets</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.merchants.merchant-utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>merchant-utils</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.merchants.merchants.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>merchants</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.merchants.planning.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>planning</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>strategies</span></div></div></li><li class="depth-4"><a href="the-great-game.merchants.strategies.simple.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>simple</span></div></a></li><li class="depth-2 branch"><a href="the-great-game.time.html"><div class="inner"><span class="tree" style="top: -207px;"><span class="top" style="height: 216px;"></span><span class="bottom"></span></span><span>time</span></div></a></li><li class="depth-2 branch"><a href="the-great-game.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>world</span></div></div></li><li class="depth-3 branch"><a href="the-great-game.world.location.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>location</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.world.routes.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routes</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.world.run.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>run</span></div></a></li><li class="depth-3"><a href="the-great-game.world.world.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>world</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">The-great-game</span> <span class="project-version">0.1.1-SNAPSHOT</span></span></h1><h5 class="license">Released under the <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html">GNU General Public License,version 2.0 or (at your option) any later version</a></h5><div class="doc"><p>Prototype code towards the great game I've been writing about for ten years, and know I will never finish.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[the-great-game "0.1.1-SNAPSHOT"]</pre><h2>Topics</h2><ul class="topics"><li><a href="Baking-the-world.html">Baking the world</a></li><li><a href="Populating-a-game-world.html">Populating a game world</a></li><li><a href="Settling-a-game-world.html">Settling a game world</a></li><li><a href="The-spread-of-knowledge-in-a-large-game-world.html">The spread of knowledge in a large game world</a></li><li><a href="Voice-acting-considered-harmful.html">Voice acting considered harmful</a></li><li><a href="economy.html">Game world economy</a></li><li><a href="intro.html">Introduction to the-great-game</a></li><li><a href="modelling_trading_cost_and_risk.html">Modelling trading cost and risk</a></li><li><a href="naming-of-characters.html">Naming of Characters</a></li><li><a href="on-dying.html">On Dying</a></li><li><a href="orgnic-quests.html">Organic Quests</a></li><li><a href="sandbox.html">Sandbox</a></li><li><a href="sexual-dimorphism.html">Sexual dimorphism</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="the-great-game.agent.agent.html">the-great-game.agent.agent</a></h3><div class="doc"><div class="markdown"><p>Anything in the game world with agency</p></div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="the-great-game.gossip.gossip.html">the-great-game.gossip.gossip</a></h3><div class="doc"><div class="markdown"><p>Interchange of news events between gossip agents</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.gossip.gossip.html#var-dialogue">dialogue</a> </li><li> <a href="the-great-game.gossip.gossip.html#var-gather-news">gather-news</a> </li><li> <a href="the-great-game.gossip.gossip.html#var-move-gossip">move-gossip</a> </li><li> <a href="the-great-game.gossip.gossip.html#var-run">run</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.gossip.news-items.html">the-great-game.gossip.news-items</a></h3><div class="doc"><div class="markdown"><p>Categories of news events interesting to gossip agents</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.gossip.news-items.html#var-degrade-character">degrade-character</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-degrade-location">degrade-location</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-infer">infer</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interest-in-character">interest-in-character</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interest-in-location">interest-in-location</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-character.3F">interesting-character?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-item.3F">interesting-item?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-location.3F">interesting-location?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-object.3F">interesting-object?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-topic.3F">interesting-topic?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-learn-news-item">learn-news-item</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-make-all-inferences">make-all-inferences</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-news-topics">news-topics</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.markets.html">the-great-game.merchants.markets</a></h3><div class="doc"><div class="markdown"><p>Adjusting quantities and prices in markets.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.markets.html#var-adjust-quantity-and-price">adjust-quantity-and-price</a> </li><li> <a href="the-great-game.merchants.markets.html#var-new-price">new-price</a> </li><li> <a href="the-great-game.merchants.markets.html#var-run">run</a> </li><li> <a href="the-great-game.merchants.markets.html#var-update-markets">update-markets</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.merchant-utils.html">the-great-game.merchants.merchant-utils</a></h3><div class="doc"><div class="markdown"><p>Useful functions for doing low-level things with merchants.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.merchant-utils.html#var-add-known-prices">add-known-prices</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-add-stock">add-stock</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-burden">burden</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-can-afford">can-afford</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-can-carry">can-carry</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-expected-price">expected-price</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.merchants.html">the-great-game.merchants.merchants</a></h3><div class="doc"><div class="markdown"><p>Trade planning for merchants, primarily.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.merchants.html#var-run">run</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.planning.html">the-great-game.merchants.planning</a></h3><div class="doc"><div class="markdown"><p>Trade planning for merchants, primarily. This follows a simple-minded generate-and-test strategy and currently generates plans for all possible routes from the current location. This may not scale. Also, routes do not currently have cost or risk associated with them.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.planning.html#var-augment-plan">augment-plan</a> </li><li> <a href="the-great-game.merchants.planning.html#var-generate-trade-plans">generate-trade-plans</a> </li><li> <a href="the-great-game.merchants.planning.html#var-nearest-with-targets">nearest-with-targets</a> </li><li> <a href="the-great-game.merchants.planning.html#var-plan-trade">plan-trade</a> </li><li> <a href="the-great-game.merchants.planning.html#var-select-cargo">select-cargo</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.strategies.simple.html">the-great-game.merchants.strategies.simple</a></h3><div class="doc"><div class="markdown"><p>Default trading strategy for merchants.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.strategies.simple.html#var-move-merchant">move-merchant</a> </li><li> <a href="the-great-game.merchants.strategies.simple.html#var-plan-and-buy">plan-and-buy</a> </li><li> <a href="the-great-game.merchants.strategies.simple.html#var-re-plan">re-plan</a> </li><li> <a href="the-great-game.merchants.strategies.simple.html#var-sell-and-buy">sell-and-buy</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.time.html">the-great-game.time</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.time.html#var-canonical-ordering-of-houses">canonical-ordering-of-houses</a> </li><li> <a href="the-great-game.time.html#var-date-string">date-string</a> </li><li> <a href="the-great-game.time.html#var-day">day</a> </li><li> <a href="the-great-game.time.html#var-day-of-year">day-of-year</a> </li><li> <a href="the-great-game.time.html#var-days-in-season">days-in-season</a> </li><li> <a href="the-great-game.time.html#var-days-in-week">days-in-week</a> </li><li> <a href="the-great-game.time.html#var-days-of-week">days-of-week</a> </li><li> <a href="the-great-game.time.html#var-game-day-length">game-day-length</a> </li><li> <a href="the-great-game.time.html#var-game-start-time">game-start-time</a> </li><li> <a href="the-great-game.time.html#var-game-time">game-time</a> </li><li> <a href="the-great-game.time.html#var-now">now</a> </li><li> <a href="the-great-game.time.html#var-season">season</a> </li><li> <a href="the-great-game.time.html#var-seasons-in-year">seasons-in-year</a> </li><li> <a href="the-great-game.time.html#var-seasons-of-year">seasons-of-year</a> </li><li> <a href="the-great-game.time.html#var-waiting-day.3F">waiting-day?</a> </li><li> <a href="the-great-game.time.html#var-week">week</a> </li><li> <a href="the-great-game.time.html#var-weeks-in-season">weeks-in-season</a> </li><li> <a href="the-great-game.time.html#var-weeks-of-season">weeks-of-season</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.utils.html">the-great-game.utils</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.utils.html#var-cyclic.3F">cyclic?</a> </li><li> <a href="the-great-game.utils.html#var-deep-merge">deep-merge</a> </li><li> <a href="the-great-game.utils.html#var-make-target-filter">make-target-filter</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.world.location.html">the-great-game.world.location</a></h3><div class="doc"><div class="markdown"><p>Functions dealing with location in the world.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.world.location.html#var-distance-between">distance-between</a> </li><li> <a href="the-great-game.world.location.html#var-get-coords">get-coords</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.world.routes.html">the-great-game.world.routes</a></h3><div class="doc"><div class="markdown"><p>Conceptual (plan level) routes, represented as tuples of location ids.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.world.routes.html#var-find-route">find-route</a> </li><li> <a href="the-great-game.world.routes.html#var-find-routes">find-routes</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.world.run.html">the-great-game.world.run</a></h3><div class="doc"><div class="markdown"><p>Run the whole simulation</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.world.run.html#var-init">init</a> </li><li> <a href="the-great-game.world.run.html#var-run">run</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.world.world.html">the-great-game.world.world</a></h3><div class="doc"><div class="markdown"><p>Access to data about the world</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.world.world.html#var-actual-price">actual-price</a> </li><li> <a href="the-great-game.world.world.html#var-default-world">default-world</a> </li><li> <a href="the-great-game.world.world.html#var-run">run</a> </li></ul></div></div></div></body></html>
	`<!DOCTYPE html PUBLIC ""`
	`"">`
	<html><head><meta charset="UTF-8" /><title>The-great-game 0.1.1-SNAPSHOT</title><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="css/highlight.css" /><script type="text/javascript" src="js/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a></h2><h1><a href="index.html"><span class="project-title"><span class="project-name">The-great-game</span> <span class="project-version">0.1.1-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="Baking-the-world.html"><div class="inner"><span>Baking the world</span></div></a></li><li class="depth-1 "><a href="Populating-a-game-world.html"><div class="inner"><span>Populating a game world</span></div></a></li><li class="depth-1 "><a href="Settling-a-game-world.html"><div class="inner"><span>Settling a game world</span></div></a></li><li class="depth-1 "><a href="The-spread-of-knowledge-in-a-large-game-world.html"><div class="inner"><span>The spread of knowledge in a large game world</span></div></a></li><li class="depth-1 "><a href="Voice-acting-considered-harmful.html"><div class="inner"><span>Voice acting considered harmful</span></div></a></li><li class="depth-1 "><a href="economy.html"><div class="inner"><span>Game world economy</span></div></a></li><li class="depth-1 "><a href="intro.html"><div class="inner"><span>Introduction to the-great-game</span></div></a></li><li class="depth-1 "><a href="modelling_trading_cost_and_risk.html"><div class="inner"><span>Modelling trading cost and risk</span></div></a></li><li class="depth-1 "><a href="naming-of-characters.html"><div class="inner"><span>Naming of Characters</span></div></a></li><li class="depth-1 "><a href="on-dying.html"><div class="inner"><span>On Dying</span></div></a></li><li class="depth-1 "><a href="orgnic-quests.html"><div class="inner"><span>Organic Quests</span></div></a></li><li class="depth-1 "><a href="sandbox.html"><div class="inner"><span>Sandbox</span></div></a></li><li class="depth-1 "><a href="sexual-dimorphism.html"><div class="inner"><span>Sexual dimorphism</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>the-great-game</span></div></div></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>agent</span></div></div></li><li class="depth-3"><a href="the-great-game.agent.agent.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>agent</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>gossip</span></div></div></li><li class="depth-3 branch"><a href="the-great-game.gossip.gossip.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>gossip</span></div></a></li><li class="depth-3"><a href="the-great-game.gossip.news-items.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>news-items</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree" style="top: -83px;"><span class="top" style="height: 92px;"></span><span class="bottom"></span></span><span>merchants</span></div></div></li><li class="depth-3 branch"><a href="the-great-game.merchants.markets.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>markets</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.merchants.merchant-utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>merchant-utils</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.merchants.merchants.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>merchants</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.merchants.planning.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>planning</span></div></a></li><li class="depth-3"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>strategies</span></div></div></li><li class="depth-4"><a href="the-great-game.merchants.strategies.simple.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>simple</span></div></a></li><li class="depth-2 branch"><a href="the-great-game.time.html"><div class="inner"><span class="tree" style="top: -207px;"><span class="top" style="height: 216px;"></span><span class="bottom"></span></span><span>time</span></div></a></li><li class="depth-2 branch"><a href="the-great-game.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>world</span></div></div></li><li class="depth-3 branch"><a href="the-great-game.world.location.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>location</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.world.routes.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>routes</span></div></a></li><li class="depth-3 branch"><a href="the-great-game.world.run.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>run</span></div></a></li><li class="depth-3"><a href="the-great-game.world.world.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>world</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">The-great-game</span> <span class="project-version">0.1.1-SNAPSHOT</span></span></h1><h5 class="license">Released under the <a href="https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html">GNU General Public License,version 2.0 or (at your option) any later version</a></h5><div class="doc"><p>Prototype code towards the great game I've been writing about for ten years, and know I will never finish.</p></div><h2>Installation</h2><p>To install, add the following dependency to your project or build file:</p><pre class="deps">[the-great-game "0.1.1-SNAPSHOT"]</pre><h2>Topics</h2><ul class="topics"><li><a href="Baking-the-world.html">Baking the world</a></li><li><a href="Populating-a-game-world.html">Populating a game world</a></li><li><a href="Settling-a-game-world.html">Settling a game world</a></li><li><a href="The-spread-of-knowledge-in-a-large-game-world.html">The spread of knowledge in a large game world</a></li><li><a href="Voice-acting-considered-harmful.html">Voice acting considered harmful</a></li><li><a href="economy.html">Game world economy</a></li><li><a href="intro.html">Introduction to the-great-game</a></li><li><a href="modelling_trading_cost_and_risk.html">Modelling trading cost and risk</a></li><li><a href="naming-of-characters.html">Naming of Characters</a></li><li><a href="on-dying.html">On Dying</a></li><li><a href="orgnic-quests.html">Organic Quests</a></li><li><a href="sandbox.html">Sandbox</a></li><li><a href="sexual-dimorphism.html">Sexual dimorphism</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="the-great-game.agent.agent.html">the-great-game.agent.agent</a></h3><div class="doc"><div class="markdown"><p>Anything in the game world with agency</p></div></div><div class="index"><p>Public variables and functions:</p><ul></ul></div></div><div class="namespace"><h3><a href="the-great-game.gossip.gossip.html">the-great-game.gossip.gossip</a></h3><div class="doc"><div class="markdown"><p>Interchange of news events between gossip agents</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.gossip.gossip.html#var-dialogue">dialogue</a> </li><li> <a href="the-great-game.gossip.gossip.html#var-gather-news">gather-news</a> </li><li> <a href="the-great-game.gossip.gossip.html#var-move-gossip">move-gossip</a> </li><li> <a href="the-great-game.gossip.gossip.html#var-run">run</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.gossip.news-items.html">the-great-game.gossip.news-items</a></h3><div class="doc"><div class="markdown"><p>Categories of news events interesting to gossip agents</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.gossip.news-items.html#var-degrade-character">degrade-character</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-degrade-location">degrade-location</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-infer">infer</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interest-in-character">interest-in-character</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interest-in-location">interest-in-location</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-character.3F">interesting-character?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-item.3F">interesting-item?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-location.3F">interesting-location?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-object.3F">interesting-object?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-interesting-topic.3F">interesting-topic?</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-learn-news-item">learn-news-item</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-make-all-inferences">make-all-inferences</a> </li><li> <a href="the-great-game.gossip.news-items.html#var-news-topics">news-topics</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.markets.html">the-great-game.merchants.markets</a></h3><div class="doc"><div class="markdown"><p>Adjusting quantities and prices in markets.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.markets.html#var-adjust-quantity-and-price">adjust-quantity-and-price</a> </li><li> <a href="the-great-game.merchants.markets.html#var-new-price">new-price</a> </li><li> <a href="the-great-game.merchants.markets.html#var-run">run</a> </li><li> <a href="the-great-game.merchants.markets.html#var-update-markets">update-markets</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.merchant-utils.html">the-great-game.merchants.merchant-utils</a></h3><div class="doc"><div class="markdown"><p>Useful functions for doing low-level things with merchants.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.merchant-utils.html#var-add-known-prices">add-known-prices</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-add-stock">add-stock</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-burden">burden</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-can-afford">can-afford</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-can-carry">can-carry</a> </li><li> <a href="the-great-game.merchants.merchant-utils.html#var-expected-price">expected-price</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.merchants.html">the-great-game.merchants.merchants</a></h3><div class="doc"><div class="markdown"><p>Trade planning for merchants, primarily.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.merchants.html#var-run">run</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.planning.html">the-great-game.merchants.planning</a></h3><div class="doc"><div class="markdown"><p>Trade planning for merchants, primarily. This follows a simple-minded generate-and-test strategy and currently generates plans for all possible routes from the current location. This may not scale. Also, routes do not currently have cost or risk associated with them.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.planning.html#var-augment-plan">augment-plan</a> </li><li> <a href="the-great-game.merchants.planning.html#var-generate-trade-plans">generate-trade-plans</a> </li><li> <a href="the-great-game.merchants.planning.html#var-nearest-with-targets">nearest-with-targets</a> </li><li> <a href="the-great-game.merchants.planning.html#var-plan-trade">plan-trade</a> </li><li> <a href="the-great-game.merchants.planning.html#var-select-cargo">select-cargo</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.merchants.strategies.simple.html">the-great-game.merchants.strategies.simple</a></h3><div class="doc"><div class="markdown"><p>Default trading strategy for merchants.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.merchants.strategies.simple.html#var-move-merchant">move-merchant</a> </li><li> <a href="the-great-game.merchants.strategies.simple.html#var-plan-and-buy">plan-and-buy</a> </li><li> <a href="the-great-game.merchants.strategies.simple.html#var-re-plan">re-plan</a> </li><li> <a href="the-great-game.merchants.strategies.simple.html#var-sell-and-buy">sell-and-buy</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.time.html">the-great-game.time</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.time.html#var-canonical-ordering-of-houses">canonical-ordering-of-houses</a> </li><li> <a href="the-great-game.time.html#var-date-string">date-string</a> </li><li> <a href="the-great-game.time.html#var-day">day</a> </li><li> <a href="the-great-game.time.html#var-day-of-year">day-of-year</a> </li><li> <a href="the-great-game.time.html#var-days-in-season">days-in-season</a> </li><li> <a href="the-great-game.time.html#var-days-in-week">days-in-week</a> </li><li> <a href="the-great-game.time.html#var-days-of-week">days-of-week</a> </li><li> <a href="the-great-game.time.html#var-game-day-length">game-day-length</a> </li><li> <a href="the-great-game.time.html#var-game-start-time">game-start-time</a> </li><li> <a href="the-great-game.time.html#var-game-time">game-time</a> </li><li> <a href="the-great-game.time.html#var-now">now</a> </li><li> <a href="the-great-game.time.html#var-season">season</a> </li><li> <a href="the-great-game.time.html#var-seasons-in-year">seasons-in-year</a> </li><li> <a href="the-great-game.time.html#var-seasons-of-year">seasons-of-year</a> </li><li> <a href="the-great-game.time.html#var-waiting-day.3F">waiting-day?</a> </li><li> <a href="the-great-game.time.html#var-week">week</a> </li><li> <a href="the-great-game.time.html#var-weeks-in-season">weeks-in-season</a> </li><li> <a href="the-great-game.time.html#var-weeks-of-season">weeks-of-season</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.utils.html">the-great-game.utils</a></h3><div class="doc"><div class="markdown"><p><strong>TODO</strong>: write docs</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.utils.html#var-cyclic.3F">cyclic?</a> </li><li> <a href="the-great-game.utils.html#var-deep-merge">deep-merge</a> </li><li> <a href="the-great-game.utils.html#var-make-target-filter">make-target-filter</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.world.location.html">the-great-game.world.location</a></h3><div class="doc"><div class="markdown"><p>Functions dealing with location in the world.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.world.location.html#var-distance-between">distance-between</a> </li><li> <a href="the-great-game.world.location.html#var-get-coords">get-coords</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.world.routes.html">the-great-game.world.routes</a></h3><div class="doc"><div class="markdown"><p>Conceptual (plan level) routes, represented as tuples of location ids.</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.world.routes.html#var-find-route">find-route</a> </li><li> <a href="the-great-game.world.routes.html#var-find-routes">find-routes</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.world.run.html">the-great-game.world.run</a></h3><div class="doc"><div class="markdown"><p>Run the whole simulation</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.world.run.html#var-init">init</a> </li><li> <a href="the-great-game.world.run.html#var-run">run</a> </li></ul></div></div><div class="namespace"><h3><a href="the-great-game.world.world.html">the-great-game.world.world</a></h3><div class="doc"><div class="markdown"><p>Access to data about the world</p></div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="the-great-game.world.world.html#var-actual-price">actual-price</a> </li><li> <a href="the-great-game.world.world.html#var-default-world">default-world</a> </li><li> <a href="the-great-game.world.world.html#var-run">run</a> </li></ul></div></div></div></body></html>