2 lines
9.2 KiB
JavaScript
2 lines
9.2 KiB
JavaScript
|
import{_ as e,c as a,o as i,a as l}from"./app.54d5a277.js";const g='{"title":"Project Info","description":"","frontmatter":{},"headers":[{"level":2,"title":"Basic Config","slug":"basic-config"},{"level":3,"title":"title","slug":"title"},{"level":3,"title":"id","slug":"id"},{"level":3,"title":"author","slug":"author"},{"level":3,"title":"discordName","slug":"discordname"},{"level":3,"title":"discordLink","slug":"discordlink"},{"level":2,"title":"Version Config","slug":"version-config"},{"level":3,"title":"versionNumber","slug":"versionnumber"},{"level":3,"title":"versionTitle","slug":"versiontitle"},{"level":2,"title":"Display Config","slug":"display-config"},{"level":3,"title":"allowGoBack","slug":"allowgoback"},{"level":3,"title":"defaultShowSmall","slug":"defaultshowsmall"},{"level":3,"title":"defaultDecimalsShown","slug":"defaultdecimalsshown"},{"level":3,"title":"useHeader","slug":"useheader"},{"level":3,"title":"banner","slug":"banner"},{"level":3,"title":"logo","slug":"logo"},{"level":3,"title":"initialTabs","slug":"initialtabs"},{"level":2,"title":"Advanced Config","slug":"advanced-config"},{"level":3,"title":"maxTickLength","slug":"maxticklength"},{"level":3,"title":"offlineLimit","slug":"offlinelimit"},{"level":3,"title":"enablePausing","slug":"enablepausing"}],"relativePath":"guide/project-info.md"}',t={},o=l('<h1 id="project-info" tabindex="-1">Project Info <a class="header-anchor" href="#project-info" aria-hidden="true">#</a></h1><p>This is a JSON file containing information that describes your project and configures parts of how Profectus should represent it.</p><p>It is stored at <code>/src/data/projInfo.json</code>.</p><h2 id="basic-config" tabindex="-1">Basic Config <a class="header-anchor" href="#basic-config" aria-hidden="true">#</a></h2><h3 id="title" tabindex="-1">title <a class="header-anchor" href="#title" aria-hidden="true">#</a></h3><ul><li>Type: <code>string</code></li><li>Default: <code>Profectus</code></li></ul><p>The name of the project, which will appear in the info tab and in the header, if enabled. The page title will also be set to this value.</p><h3 id="id" tabindex="-1">id <a class="header-anchor" href="#id" aria-hidden="true">#</a></h3><ul><li>Type: <code>string</code></li><li>Default: <code>""</code></li></ul><p>This is a unique ID used when saving player data. Changing this will effectively erase all save data for all players.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>This ID MUST be unique to your project, and should not be left as the default value. Otherwise your project may use the save data from another project and cause issues for both projects.</p></div><h3 id="author" tabindex="-1">author <a class="header-anchor" href="#author" aria-hidden="true">#</a></h3><ul><li>Type: <code>string</code></li><li>Default: <code>""</code></li></ul><p>The author of the project, which will appear in the info tab.</p><h3 id="discordname" tabindex="-1">discordName <a class="header-anchor" href="#discordname" aria-hidden="true">#</a></h3><ul><li>Type: <code>string</code></li><li>Default: <code>The Paper Pilot Community</code></li></ul><p>The text to display for the discord server to point user's to. This will appear when hovering over the discord icon, inside the info tab, the game over screen, as well as the NaN detected screen.</p><p>By default, this is The Paper Pilot Community, which can act as a catch-all for any Profectus projects without their own servers. If you change the discord server with your own, The Paper Pilot Community will still display underneath the custom server when hovering over the discord icon and within the info tab. Those places will also contain a link to the Modding Tree discord server.</p><h3 id="discordlink" tabindex="-1">discordLink <a class="header-anchor" href="#discordlink" aria-hidden="true">#</a></h3><ul><li>Type: <code>string</code></li><li>Default: <code>https://discord.gg/WzejVAx</code></li></ul><p>The link for the discord server to point user's to. See <a href="#discordname">discordName</a>
|