cookbook.html 40 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761
  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <link rel="prev" href="faq.html">
  7. <link rel="icon" href="../assets/images/favicon.ico">
  8. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.11">
  9. <title>Cookbook - DunGen</title>
  10. <link rel="stylesheet" href="../assets/stylesheets/main.4af4bdda.min.css">
  11. <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
  12. <script src="https://unpkg.com/iframe-worker/shim"></script>
  13. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  14. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  15. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  16. <link rel="stylesheet" href="../stylesheets/extra.css">
  17. <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  18. </head>
  19. <body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="black" data-md-color-accent="cyan">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#dungen-cookbook-practical-recipes" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <header class="md-header md-header--shadow" data-md-component="header">
  31. <nav class="md-header__inner md-grid" aria-label="Header">
  32. <a href="../index.html" title="DunGen" class="md-header__button md-logo" aria-label="DunGen" data-md-component="logo">
  33. <svg width="100%" height="100%" viewBox="0 0 258 272" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
  34. <path d="M79,20.998C103.163,20.998 126.827,20.993 150.49,21.002C156.512,21.004 156.994,21.502 157,27.603C157.008,36.435 157.275,45.279 156.89,54.094C156.689,58.68 158.685,61.484 161.849,64.242C170.723,71.978 179.515,79.812 188.188,87.772C190.849,90.214 193.071,93.217 195.28,95.995C199.425,101.209 199.993,100.532 203.73,100.441C209.056,100.311 214.403,100.217 219.713,100.549C222.988,100.754 224.083,99.873 224.059,96.517C223.93,78.354 223.952,60.189 224.044,42.025C224.059,38.949 223.341,37.434 219.868,37.603C214.383,37.872 208.877,37.791 203.381,37.715C199.579,37.663 197.517,38.715 197.907,43.168C198.327,47.964 197.807,52.836 198.065,57.655C198.263,61.366 196.432,62.919 193.348,61.885C188.656,60.311 184.193,58.029 179.724,55.858C179.188,55.598 179.033,54.157 179.028,53.262C178.979,44.43 179.007,35.598 178.995,26.766C178.99,22.857 180.241,20.823 184.822,20.897C200.816,21.158 216.816,20.988 232.814,21.004C239.132,21.01 240.996,22.894 240.998,29.241C241.006,56.07 241.005,82.9 240.998,109.729C240.997,114.795 238.959,117.469 233.922,117.935C228.649,118.423 223.32,118.407 218.015,118.42C208.355,118.444 198.68,117.994 189.04,118.408C184.225,118.615 181.96,116.755 180.231,112.653C175.241,100.811 167.104,91.401 156.54,84.26C153.778,82.394 150.001,81.189 146.67,81.142C126.51,80.86 106.344,81.107 86.182,80.92C81.723,80.878 80.502,82.453 80.517,86.753C80.64,122.394 80.606,158.037 80.499,193.679C80.487,197.764 81.821,199.148 86.047,199.093C103.375,198.866 120.707,198.998 138.038,198.998C159.059,198.998 178.198,184.319 182.849,163.942C184.15,158.243 183.93,152.135 183.91,146.215C183.896,141.846 185.254,139.882 189.885,139.936C204.381,140.105 218.88,139.974 233.378,140.01C238.862,140.024 240.989,142.215 240.993,147.822C241.011,180.317 241.012,212.813 240.992,245.308C240.988,250.939 238.967,252.977 233.218,252.985C205.722,253.022 178.226,253.017 150.73,252.989C145.524,252.983 144.074,251.47 144.001,246.325C143.982,244.992 144.14,243.641 143.973,242.329C143.34,237.341 146.132,235.979 150.411,235.99C160.395,236.016 171.06,236.112 181.183,236.112C181.349,229.59 181.592,223.106 181.957,216.723C182.112,214.015 183.166,213.054 185.926,212.937C199.005,212.385 199.002,212.308 199.002,225.465C199.002,236.846 199.003,236.883 210.211,236.618C214.669,236.512 219.122,236.203 223.998,235.966L223.998,215.809C223.998,197.812 223.911,179.813 224.071,161.817C224.103,158.195 223.211,156.729 219.348,156.922C213.399,157.218 207.424,157 201.518,157C200.995,162.216 201.49,167.296 200.093,171.982C197.761,179.807 196.375,184.335 192.2,189.003C186.463,195.42 180.539,202.401 173.212,206.467C165.218,210.904 155.809,213.982 146.533,214.772C140.003,215.328 133.915,215.112 127.586,214.988C124.239,214.923 122.845,216.06 122.934,219.622C123.145,228.116 123.005,236.618 123.001,245.117C122.998,251.059 121.128,252.977 115.061,252.989C97.897,253.025 80.733,253.002 63.568,253.002C51.404,253.002 39.239,253.028 27.074,252.99C21.11,252.972 19.972,251.911 19.969,246.171C19.952,212.512 20.027,178.852 19.931,145.193C19.92,141.244 21.512,139.936 25.206,139.967C36.037,140.056 46.872,139.868 57.7,140.066C61.659,140.139 62.704,138.654 62.9,134.816C63.079,131.328 63.031,127.859 62.985,124.329C62.92,119.388 61.017,118.259 56.858,118.302C47.864,118.397 38.869,118.381 29.875,118.42C29.044,118.424 28.21,118.569 27.382,118.535C20.483,118.255 19.854,117.626 19.858,110.743C19.874,83.582 19.901,56.422 19.946,29.261C19.957,22.709 21.747,21.005 28.509,21.001C45.173,20.992 61.836,20.998 79,20.998M40.806,37.592C39.579,39.018 37.305,40.427 37.283,41.871C37.009,60.012 37.047,78.158 37.045,96.302C37.045,98.812 38.187,100.243 40.973,100.24C46.626,100.235 52.281,100.327 57.93,100.537C61.815,100.681 63.165,99.043 63.06,95.156C62.832,86.672 62.99,78.177 63.001,69.687C63.01,63.101 65.168,60.989 71.882,60.989C92.36,60.99 112.837,60.999 133.315,60.997C139.718,60.996 139.987,60.711 139.998,54.125C140.004,50.629 139.757,47.111 140.059,43.642C140.457,39.073 138.568,37.373 134.101,37.395C103.319,37.551 72.535,37.595 40.806,37.592M62.997,200.455C62.997,187.472 63.078,174.487 62.886,161.507C62.863,159.996 61.38,157.25 60.476,157.208C52.923,156.859 45.347,157.01 37.87,157.01C37.87,182.364 37.917,206.983 37.817,231.602C37.803,235.205 39.289,236.074 42.623,236.055C62.599,235.939 82.576,236.005 102.552,235.977C103.642,235.975 104.732,235.678 105.997,235.493C105.997,229.703 105.875,224.216 106.048,218.738C106.137,215.898 105.136,214.958 102.315,214.998C93.661,215.12 85.004,215.009 76.348,215.006C62.998,215 62.998,215.006 62.997,200.455Z" style="fill:currentColor;fill-rule:nonzero;"/>
  35. <g transform="matrix(1,0,0,1,91.4761,179.778)">
  36. <text x="0px" y="0px" style="font-family:'Arial-BoldMT', 'Arial', sans-serif;font-weight:700;font-size:110px;fill:currentColor;">D</text>
  37. </g>
  38. </svg>
  39. </a>
  40. <label class="md-header__button md-icon" for="__drawer">
  41. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  42. </label>
  43. <div class="md-header__title" data-md-component="header-title">
  44. <div class="md-header__ellipsis">
  45. <div class="md-header__topic">
  46. <span class="md-ellipsis">
  47. DunGen
  48. </span>
  49. </div>
  50. <div class="md-header__topic" data-md-component="header-topic">
  51. <span class="md-ellipsis">
  52. Cookbook
  53. </span>
  54. </div>
  55. </div>
  56. </div>
  57. </nav>
  58. </header>
  59. <div class="md-container" data-md-component="container">
  60. <main class="md-main" data-md-component="main">
  61. <div class="md-main__inner md-grid">
  62. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  63. <div class="md-sidebar__scrollwrap">
  64. <div class="md-sidebar__inner">
  65. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  66. <label class="md-nav__title" for="__drawer">
  67. <a href="../index.html" title="DunGen" class="md-nav__button md-logo" aria-label="DunGen" data-md-component="logo">
  68. <svg width="100%" height="100%" viewBox="0 0 258 272" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xml:space="preserve" xmlns:serif="http://www.serif.com/" style="fill-rule:evenodd;clip-rule:evenodd;stroke-linejoin:round;stroke-miterlimit:2;">
  69. <path d="M79,20.998C103.163,20.998 126.827,20.993 150.49,21.002C156.512,21.004 156.994,21.502 157,27.603C157.008,36.435 157.275,45.279 156.89,54.094C156.689,58.68 158.685,61.484 161.849,64.242C170.723,71.978 179.515,79.812 188.188,87.772C190.849,90.214 193.071,93.217 195.28,95.995C199.425,101.209 199.993,100.532 203.73,100.441C209.056,100.311 214.403,100.217 219.713,100.549C222.988,100.754 224.083,99.873 224.059,96.517C223.93,78.354 223.952,60.189 224.044,42.025C224.059,38.949 223.341,37.434 219.868,37.603C214.383,37.872 208.877,37.791 203.381,37.715C199.579,37.663 197.517,38.715 197.907,43.168C198.327,47.964 197.807,52.836 198.065,57.655C198.263,61.366 196.432,62.919 193.348,61.885C188.656,60.311 184.193,58.029 179.724,55.858C179.188,55.598 179.033,54.157 179.028,53.262C178.979,44.43 179.007,35.598 178.995,26.766C178.99,22.857 180.241,20.823 184.822,20.897C200.816,21.158 216.816,20.988 232.814,21.004C239.132,21.01 240.996,22.894 240.998,29.241C241.006,56.07 241.005,82.9 240.998,109.729C240.997,114.795 238.959,117.469 233.922,117.935C228.649,118.423 223.32,118.407 218.015,118.42C208.355,118.444 198.68,117.994 189.04,118.408C184.225,118.615 181.96,116.755 180.231,112.653C175.241,100.811 167.104,91.401 156.54,84.26C153.778,82.394 150.001,81.189 146.67,81.142C126.51,80.86 106.344,81.107 86.182,80.92C81.723,80.878 80.502,82.453 80.517,86.753C80.64,122.394 80.606,158.037 80.499,193.679C80.487,197.764 81.821,199.148 86.047,199.093C103.375,198.866 120.707,198.998 138.038,198.998C159.059,198.998 178.198,184.319 182.849,163.942C184.15,158.243 183.93,152.135 183.91,146.215C183.896,141.846 185.254,139.882 189.885,139.936C204.381,140.105 218.88,139.974 233.378,140.01C238.862,140.024 240.989,142.215 240.993,147.822C241.011,180.317 241.012,212.813 240.992,245.308C240.988,250.939 238.967,252.977 233.218,252.985C205.722,253.022 178.226,253.017 150.73,252.989C145.524,252.983 144.074,251.47 144.001,246.325C143.982,244.992 144.14,243.641 143.973,242.329C143.34,237.341 146.132,235.979 150.411,235.99C160.395,236.016 171.06,236.112 181.183,236.112C181.349,229.59 181.592,223.106 181.957,216.723C182.112,214.015 183.166,213.054 185.926,212.937C199.005,212.385 199.002,212.308 199.002,225.465C199.002,236.846 199.003,236.883 210.211,236.618C214.669,236.512 219.122,236.203 223.998,235.966L223.998,215.809C223.998,197.812 223.911,179.813 224.071,161.817C224.103,158.195 223.211,156.729 219.348,156.922C213.399,157.218 207.424,157 201.518,157C200.995,162.216 201.49,167.296 200.093,171.982C197.761,179.807 196.375,184.335 192.2,189.003C186.463,195.42 180.539,202.401 173.212,206.467C165.218,210.904 155.809,213.982 146.533,214.772C140.003,215.328 133.915,215.112 127.586,214.988C124.239,214.923 122.845,216.06 122.934,219.622C123.145,228.116 123.005,236.618 123.001,245.117C122.998,251.059 121.128,252.977 115.061,252.989C97.897,253.025 80.733,253.002 63.568,253.002C51.404,253.002 39.239,253.028 27.074,252.99C21.11,252.972 19.972,251.911 19.969,246.171C19.952,212.512 20.027,178.852 19.931,145.193C19.92,141.244 21.512,139.936 25.206,139.967C36.037,140.056 46.872,139.868 57.7,140.066C61.659,140.139 62.704,138.654 62.9,134.816C63.079,131.328 63.031,127.859 62.985,124.329C62.92,119.388 61.017,118.259 56.858,118.302C47.864,118.397 38.869,118.381 29.875,118.42C29.044,118.424 28.21,118.569 27.382,118.535C20.483,118.255 19.854,117.626 19.858,110.743C19.874,83.582 19.901,56.422 19.946,29.261C19.957,22.709 21.747,21.005 28.509,21.001C45.173,20.992 61.836,20.998 79,20.998M40.806,37.592C39.579,39.018 37.305,40.427 37.283,41.871C37.009,60.012 37.047,78.158 37.045,96.302C37.045,98.812 38.187,100.243 40.973,100.24C46.626,100.235 52.281,100.327 57.93,100.537C61.815,100.681 63.165,99.043 63.06,95.156C62.832,86.672 62.99,78.177 63.001,69.687C63.01,63.101 65.168,60.989 71.882,60.989C92.36,60.99 112.837,60.999 133.315,60.997C139.718,60.996 139.987,60.711 139.998,54.125C140.004,50.629 139.757,47.111 140.059,43.642C140.457,39.073 138.568,37.373 134.101,37.395C103.319,37.551 72.535,37.595 40.806,37.592M62.997,200.455C62.997,187.472 63.078,174.487 62.886,161.507C62.863,159.996 61.38,157.25 60.476,157.208C52.923,156.859 45.347,157.01 37.87,157.01C37.87,182.364 37.917,206.983 37.817,231.602C37.803,235.205 39.289,236.074 42.623,236.055C62.599,235.939 82.576,236.005 102.552,235.977C103.642,235.975 104.732,235.678 105.997,235.493C105.997,229.703 105.875,224.216 106.048,218.738C106.137,215.898 105.136,214.958 102.315,214.998C93.661,215.12 85.004,215.009 76.348,215.006C62.998,215 62.998,215.006 62.997,200.455Z" style="fill:currentColor;fill-rule:nonzero;"/>
  70. <g transform="matrix(1,0,0,1,91.4761,179.778)">
  71. <text x="0px" y="0px" style="font-family:'Arial-BoldMT', 'Arial', sans-serif;font-weight:700;font-size:110px;fill:currentColor;">D</text>
  72. </g>
  73. </svg>
  74. </a>
  75. DunGen
  76. </label>
  77. <ul class="md-nav__list" data-md-scrollfix>
  78. <li class="md-nav__item">
  79. <a href="../index.html" class="md-nav__link">
  80. <span class="md-ellipsis">
  81. Introduction
  82. </span>
  83. </a>
  84. </li>
  85. <li class="md-nav__item">
  86. <a href="../changelog.html" class="md-nav__link">
  87. <span class="md-ellipsis">
  88. Changelog
  89. </span>
  90. </a>
  91. </li>
  92. <li class="md-nav__item md-nav__item--nested">
  93. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
  94. <div class="md-nav__link md-nav__container">
  95. <a href="../getting-started/index.html" class="md-nav__link ">
  96. <span class="md-ellipsis">
  97. Getting Started
  98. </span>
  99. </a>
  100. <label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
  101. <span class="md-nav__icon md-icon"></span>
  102. </label>
  103. </div>
  104. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  105. <label class="md-nav__title" for="__nav_3">
  106. <span class="md-nav__icon md-icon"></span>
  107. Getting Started
  108. </label>
  109. <ul class="md-nav__list" data-md-scrollfix>
  110. <li class="md-nav__item">
  111. <a href="../getting-started/1-creating-tiles.html" class="md-nav__link">
  112. <span class="md-ellipsis">
  113. 1. Creating Tiles
  114. </span>
  115. </a>
  116. </li>
  117. <li class="md-nav__item">
  118. <a href="../getting-started/2-doorways.html" class="md-nav__link">
  119. <span class="md-ellipsis">
  120. 2. Doorways
  121. </span>
  122. </a>
  123. </li>
  124. <li class="md-nav__item">
  125. <a href="../getting-started/3-dungeon-flow.html" class="md-nav__link">
  126. <span class="md-ellipsis">
  127. 3. Dungeon Flow Basics
  128. </span>
  129. </a>
  130. </li>
  131. <li class="md-nav__item">
  132. <a href="../getting-started/4-scene-setup.html" class="md-nav__link">
  133. <span class="md-ellipsis">
  134. 4. Scene Setup & First Generation
  135. </span>
  136. </a>
  137. </li>
  138. </ul>
  139. </nav>
  140. </li>
  141. <li class="md-nav__item md-nav__item--nested">
  142. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
  143. <div class="md-nav__link md-nav__container">
  144. <a href="../core-concepts/index.html" class="md-nav__link ">
  145. <span class="md-ellipsis">
  146. Core Concepts
  147. </span>
  148. </a>
  149. <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
  150. <span class="md-nav__icon md-icon"></span>
  151. </label>
  152. </div>
  153. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  154. <label class="md-nav__title" for="__nav_4">
  155. <span class="md-nav__icon md-icon"></span>
  156. Core Concepts
  157. </label>
  158. <ul class="md-nav__list" data-md-scrollfix>
  159. <li class="md-nav__item">
  160. <a href="../core-concepts/tiles.html" class="md-nav__link">
  161. <span class="md-ellipsis">
  162. Tiles & Tile Component
  163. </span>
  164. </a>
  165. </li>
  166. <li class="md-nav__item">
  167. <a href="../core-concepts/weighting.html" class="md-nav__link">
  168. <span class="md-ellipsis">
  169. Weighting
  170. </span>
  171. </a>
  172. </li>
  173. <li class="md-nav__item">
  174. <a href="../core-concepts/tile-sets.html" class="md-nav__link">
  175. <span class="md-ellipsis">
  176. Tile Sets
  177. </span>
  178. </a>
  179. </li>
  180. <li class="md-nav__item">
  181. <a href="../core-concepts/archetypes.html" class="md-nav__link">
  182. <span class="md-ellipsis">
  183. Archetypes
  184. </span>
  185. </a>
  186. </li>
  187. <li class="md-nav__item">
  188. <a href="../core-concepts/doorways.html" class="md-nav__link">
  189. <span class="md-ellipsis">
  190. Doorways
  191. </span>
  192. </a>
  193. </li>
  194. <li class="md-nav__item">
  195. <a href="../core-concepts/dungeon-flow.html" class="md-nav__link">
  196. <span class="md-ellipsis">
  197. Dungeon Flow Asset
  198. </span>
  199. </a>
  200. </li>
  201. <li class="md-nav__item">
  202. <a href="../core-concepts/flow-editor.html" class="md-nav__link">
  203. <span class="md-ellipsis">
  204. Flow Editor
  205. </span>
  206. </a>
  207. </li>
  208. <li class="md-nav__item">
  209. <a href="../core-concepts/dungeon-generator.html" class="md-nav__link">
  210. <span class="md-ellipsis">
  211. Dungeon Generator
  212. </span>
  213. </a>
  214. </li>
  215. </ul>
  216. </nav>
  217. </li>
  218. <li class="md-nav__item md-nav__item--nested">
  219. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
  220. <div class="md-nav__link md-nav__container">
  221. <a href="../advanced-features/index.html" class="md-nav__link ">
  222. <span class="md-ellipsis">
  223. Advanced Features
  224. </span>
  225. </a>
  226. <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
  227. <span class="md-nav__icon md-icon"></span>
  228. </label>
  229. </div>
  230. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  231. <label class="md-nav__title" for="__nav_5">
  232. <span class="md-nav__icon md-icon"></span>
  233. Advanced Features
  234. </label>
  235. <ul class="md-nav__list" data-md-scrollfix>
  236. <li class="md-nav__item">
  237. <a href="../advanced-features/props-variety.html" class="md-nav__link">
  238. <span class="md-ellipsis">
  239. Props for Variety
  240. </span>
  241. </a>
  242. </li>
  243. <li class="md-nav__item">
  244. <a href="../advanced-features/doors.html" class="md-nav__link">
  245. <span class="md-ellipsis">
  246. Doors
  247. </span>
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="../advanced-features/multiple-floors.html" class="md-nav__link">
  252. <span class="md-ellipsis">
  253. Multiple Floors
  254. </span>
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="../advanced-features/lock-key-system.html" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. Lock & Key System
  261. </span>
  262. </a>
  263. </li>
  264. <li class="md-nav__item">
  265. <a href="../advanced-features/injecting-tiles.html" class="md-nav__link">
  266. <span class="md-ellipsis">
  267. Injecting Special Tiles
  268. </span>
  269. </a>
  270. </li>
  271. <li class="md-nav__item">
  272. <a href="../advanced-features/connection-rules.html" class="md-nav__link">
  273. <span class="md-ellipsis">
  274. Tile Connection Rules
  275. </span>
  276. </a>
  277. </li>
  278. <li class="md-nav__item">
  279. <a href="../advanced-features/attached-dungeons.html" class="md-nav__link">
  280. <span class="md-ellipsis">
  281. Generating Attached Dungeons
  282. </span>
  283. </a>
  284. </li>
  285. <li class="md-nav__item">
  286. <a href="../advanced-features/additional-collisions.html" class="md-nav__link">
  287. <span class="md-ellipsis">
  288. Avoid Collisions With the Scene
  289. </span>
  290. </a>
  291. </li>
  292. <li class="md-nav__item">
  293. <a href="../advanced-features/runtime-events.html" class="md-nav__link">
  294. <span class="md-ellipsis">
  295. Runtime Events & Code Execution
  296. </span>
  297. </a>
  298. </li>
  299. <li class="md-nav__item">
  300. <a href="../advanced-features/post-processing.html" class="md-nav__link">
  301. <span class="md-ellipsis">
  302. Custom Post-Processing
  303. </span>
  304. </a>
  305. </li>
  306. <li class="md-nav__item">
  307. <a href="../advanced-features/character-component.html" class="md-nav__link">
  308. <span class="md-ellipsis">
  309. DunGen Character Component
  310. </span>
  311. </a>
  312. </li>
  313. </ul>
  314. </nav>
  315. </li>
  316. <li class="md-nav__item md-nav__item--nested">
  317. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
  318. <div class="md-nav__link md-nav__container">
  319. <a href="../optimization/index.html" class="md-nav__link ">
  320. <span class="md-ellipsis">
  321. Optimization
  322. </span>
  323. </a>
  324. <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
  325. <span class="md-nav__icon md-icon"></span>
  326. </label>
  327. </div>
  328. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
  329. <label class="md-nav__title" for="__nav_6">
  330. <span class="md-nav__icon md-icon"></span>
  331. Optimization
  332. </label>
  333. <ul class="md-nav__list" data-md-scrollfix>
  334. <li class="md-nav__item">
  335. <a href="../optimization/culling.html" class="md-nav__link">
  336. <span class="md-ellipsis">
  337. Built-in Culling
  338. </span>
  339. </a>
  340. </li>
  341. <li class="md-nav__item">
  342. <a href="../optimization/tile-pooling.html" class="md-nav__link">
  343. <span class="md-ellipsis">
  344. Tile Pooling
  345. </span>
  346. </a>
  347. </li>
  348. </ul>
  349. </nav>
  350. </li>
  351. <li class="md-nav__item md-nav__item--nested">
  352. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_7" >
  353. <div class="md-nav__link md-nav__container">
  354. <a href="../pathfinding/index.html" class="md-nav__link ">
  355. <span class="md-ellipsis">
  356. Pathfinding
  357. </span>
  358. </a>
  359. <label class="md-nav__link " for="__nav_7" id="__nav_7_label" tabindex="0">
  360. <span class="md-nav__icon md-icon"></span>
  361. </label>
  362. </div>
  363. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
  364. <label class="md-nav__title" for="__nav_7">
  365. <span class="md-nav__icon md-icon"></span>
  366. Pathfinding
  367. </label>
  368. <ul class="md-nav__list" data-md-scrollfix>
  369. <li class="md-nav__item">
  370. <a href="../pathfinding/unity-navmesh.html" class="md-nav__link">
  371. <span class="md-ellipsis">
  372. Unity NavMesh Components
  373. </span>
  374. </a>
  375. </li>
  376. <li class="md-nav__item">
  377. <a href="../pathfinding/astar-pathfinding.html" class="md-nav__link">
  378. <span class="md-ellipsis">
  379. A* Pathfinding Project Pro
  380. </span>
  381. </a>
  382. </li>
  383. <li class="md-nav__item">
  384. <a href="../pathfinding/custom-adapters.html" class="md-nav__link">
  385. <span class="md-ellipsis">
  386. Custom Adapters
  387. </span>
  388. </a>
  389. </li>
  390. </ul>
  391. </nav>
  392. </li>
  393. <li class="md-nav__item md-nav__item--nested">
  394. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_8" >
  395. <div class="md-nav__link md-nav__container">
  396. <a href="../integrations/index.html" class="md-nav__link ">
  397. <span class="md-ellipsis">
  398. Integrations
  399. </span>
  400. </a>
  401. <label class="md-nav__link " for="__nav_8" id="__nav_8_label" tabindex="0">
  402. <span class="md-nav__icon md-icon"></span>
  403. </label>
  404. </div>
  405. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
  406. <label class="md-nav__title" for="__nav_8">
  407. <span class="md-nav__icon md-icon"></span>
  408. Integrations
  409. </label>
  410. <ul class="md-nav__list" data-md-scrollfix>
  411. <li class="md-nav__item">
  412. <a href="../integrations/sectr.html" class="md-nav__link">
  413. <span class="md-ellipsis">
  414. SECTR Portal Culling
  415. </span>
  416. </a>
  417. </li>
  418. <li class="md-nav__item">
  419. <a href="../integrations/playmaker.html" class="md-nav__link">
  420. <span class="md-ellipsis">
  421. PlayMaker Actions
  422. </span>
  423. </a>
  424. </li>
  425. </ul>
  426. </nav>
  427. </li>
  428. <li class="md-nav__item md-nav__item--nested">
  429. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_9" >
  430. <div class="md-nav__link md-nav__container">
  431. <a href="../troubleshooting/index.html" class="md-nav__link ">
  432. <span class="md-ellipsis">
  433. Troubleshooting
  434. </span>
  435. </a>
  436. <label class="md-nav__link " for="__nav_9" id="__nav_9_label" tabindex="0">
  437. <span class="md-nav__icon md-icon"></span>
  438. </label>
  439. </div>
  440. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_9_label" aria-expanded="false">
  441. <label class="md-nav__title" for="__nav_9">
  442. <span class="md-nav__icon md-icon"></span>
  443. Troubleshooting
  444. </label>
  445. <ul class="md-nav__list" data-md-scrollfix>
  446. <li class="md-nav__item">
  447. <a href="../troubleshooting/limitations.html" class="md-nav__link">
  448. <span class="md-ellipsis">
  449. Limitations & Considerations
  450. </span>
  451. </a>
  452. </li>
  453. <li class="md-nav__item">
  454. <a href="../troubleshooting/analysis.html" class="md-nav__link">
  455. <span class="md-ellipsis">
  456. Analysis
  457. </span>
  458. </a>
  459. </li>
  460. </ul>
  461. </nav>
  462. </li>
  463. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  464. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" checked>
  465. <label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
  466. <span class="md-ellipsis">
  467. Reference
  468. </span>
  469. <span class="md-nav__icon md-icon"></span>
  470. </label>
  471. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="true">
  472. <label class="md-nav__title" for="__nav_10">
  473. <span class="md-nav__icon md-icon"></span>
  474. Reference
  475. </label>
  476. <ul class="md-nav__list" data-md-scrollfix>
  477. <li class="md-nav__item">
  478. <a href="faq.html" class="md-nav__link">
  479. <span class="md-ellipsis">
  480. FAQ
  481. </span>
  482. </a>
  483. </li>
  484. <li class="md-nav__item md-nav__item--active">
  485. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  486. <label class="md-nav__link md-nav__link--active" for="__toc">
  487. <span class="md-ellipsis">
  488. Cookbook
  489. </span>
  490. <span class="md-nav__icon md-icon"></span>
  491. </label>
  492. <a href="cookbook.html" class="md-nav__link md-nav__link--active">
  493. <span class="md-ellipsis">
  494. Cookbook
  495. </span>
  496. </a>
  497. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  498. <label class="md-nav__title" for="__toc">
  499. <span class="md-nav__icon md-icon"></span>
  500. Table of contents
  501. </label>
  502. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  503. <li class="md-nav__item">
  504. <a href="#how-to-use-this-section" class="md-nav__link">
  505. <span class="md-ellipsis">
  506. How to Use This Section
  507. </span>
  508. </a>
  509. </li>
  510. <li class="md-nav__item">
  511. <a href="#recipe-index" class="md-nav__link">
  512. <span class="md-ellipsis">
  513. Recipe Index
  514. </span>
  515. </a>
  516. </li>
  517. </ul>
  518. </nav>
  519. </li>
  520. </ul>
  521. </nav>
  522. </li>
  523. </ul>
  524. </nav>
  525. </div>
  526. </div>
  527. </div>
  528. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  529. <div class="md-sidebar__scrollwrap">
  530. <div class="md-sidebar__inner">
  531. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  532. <label class="md-nav__title" for="__toc">
  533. <span class="md-nav__icon md-icon"></span>
  534. Table of contents
  535. </label>
  536. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  537. <li class="md-nav__item">
  538. <a href="#how-to-use-this-section" class="md-nav__link">
  539. <span class="md-ellipsis">
  540. How to Use This Section
  541. </span>
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="#recipe-index" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. Recipe Index
  548. </span>
  549. </a>
  550. </li>
  551. </ul>
  552. </nav>
  553. </div>
  554. </div>
  555. </div>
  556. <div class="md-content" data-md-component="content">
  557. <article class="md-content__inner md-typeset">
  558. <h1 id="dungen-cookbook-practical-recipes">DunGen Cookbook: Practical Recipes</h1>
  559. <p>Welcome to the DunGen Cookbook! This section provides a collection of practical examples, code snippets, and solutions for common tasks and customizations you might want to implement when working with DunGen.</p>
  560. <p>Think of these entries as focused "recipes" designed to help you quickly achieve a specific goal without necessarily diving deep into the underlying theory (though links to relevant documentation sections may be provided).</p>
  561. <div class="admonition tip">
  562. <p class="admonition-title">Prerequisites</p>
  563. <p>These recipes generally assume you have a basic understanding of DunGen's core concepts, such as Tiles, Doorways, Dungeon Flow, and the Runtime Dungeon component, as covered in the <a href="../getting-started/index.html">Getting Started</a> and <a href="../core-concepts/index.html">Core Concepts</a> sections.</p>
  564. </div>
  565. <hr />
  566. <h2 id="how-to-use-this-section">How to Use This Section</h2>
  567. <p>Browse the list of recipes below. Each link will take you to a dedicated page containing the specific example, code snippets, and explanations needed to implement that particular feature.</p>
  568. <div class="admonition note">
  569. <p class="admonition-title">Adaptation May Be Required</p>
  570. <p>The code provided in these recipes is intended as a starting point and example. You may need to adapt it to fit the specific needs and architecture of your own project.</p>
  571. </div>
  572. <hr />
  573. <h2 id="recipe-index">Recipe Index</h2>
  574. <p>Here are the currently available recipes:</p>
  575. <ul>
  576. <li><a href="cookbook/spawn-player.html">Spawning the Player at Spawn Points</a></li>
  577. <li><a href="cookbook/main-path-connections.html">Main Path Connection Rule</a></li>
  578. <li><a href="cookbook/line-segment-injection.html">Line Segment Injection</a></li>
  579. <li><a href="cookbook/modify-dungeon-flow.html">Programmatically Modifying DunGen Assets</a></li>
  580. </ul>
  581. </article>
  582. </div>
  583. <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
  584. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  585. </div>
  586. <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  587. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  588. Back to top
  589. </button>
  590. </main>
  591. <footer class="md-footer">
  592. <nav class="md-footer__inner md-grid" aria-label="Footer" >
  593. <a href="faq.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: FAQ">
  594. <div class="md-footer__button md-icon">
  595. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  596. </div>
  597. <div class="md-footer__title">
  598. <span class="md-footer__direction">
  599. Previous
  600. </span>
  601. <div class="md-ellipsis">
  602. FAQ
  603. </div>
  604. </div>
  605. </a>
  606. </nav>
  607. <div class="md-footer-meta md-typeset">
  608. <div class="md-footer-meta__inner md-grid">
  609. <div class="md-copyright">
  610. <div class="md-copyright__highlight">
  611. Copyright &copy; Aegon Games Ltd.
  612. </div>
  613. Made with
  614. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  615. Material for MkDocs
  616. </a>
  617. </div>
  618. </div>
  619. </div>
  620. </footer>
  621. </div>
  622. <div class="md-dialog" data-md-component="dialog">
  623. <div class="md-dialog__inner md-typeset"></div>
  624. </div>
  625. <script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "announce.dismiss", "header.autohide", "navigation.footer", "navigation.indexes", "navigation.top", "navigation.tracking"], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
  626. <script src="../assets/javascripts/bundle.c8b220af.min.js"></script>
  627. </body>
  628. </html>