36 lines
No EOL
2.6 KiB
HTML
36 lines
No EOL
2.6 KiB
HTML
<!doctype html>
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>Os.save_dir — Ludic</title>
|
||
<meta name="description" content="Per-user save directory for an app.">
|
||
<link rel="stylesheet" href="base.css">
|
||
<link rel="stylesheet" href="docs.css">
|
||
</head>
|
||
<body>
|
||
<header class="nav"><div class="wrap nav-in"><a class="brand" href="index.html"><span class="logo">L</span> Ludic</a><button class="nav-toggle" aria-label="Toggle menu" aria-expanded="false">☰</button><nav class="nav-links"><a href="index.html">Home</a><a href="api.html">API Reference</a><a class="nav-cta" href="https://git.workshopsoft.io/workshopsoft/ludic">Source ↗</a></nav></div></header>
|
||
<main class="wrap item">
|
||
<div class="crumbs"><a href="api.html">API Reference</a> <span>›</span> <a href="ns-os.html">Os</a> <span>›</span> <span class="here">Os.save_dir</span></div>
|
||
<div class="item-head">
|
||
<span class="kind-badge kind-method">method</span>
|
||
<h1 id="top">Os.save_dir</h1>
|
||
</div>
|
||
<code class="sig">Os.save_dir(app) -> string</code>
|
||
<div class="desc"><p>The per-user directory where an application should store save files, named for the app. Which directory that is, is the platform's decision, not the program's:</p><p>| | |
|
||
| --- | --- |
|
||
| macOS | <code>~/Library/Application Support/<app></code> |
|
||
| Linux | <code>$XDG_DATA_HOME/<app></code>, or <code>~/.local/share/<app></code> |</p><p>An XDG variable that is set but empty falls back to the default, as the spec requires. The path is returned as a string; creating the directory and reading/writing files is the filesystem library's job (see the <a href="os-config_dir"><code>config_dir</code></a>/<a href="os-cache_dir"><code>cache_dir</code></a> companions).</p><p>On macOS <code>save_dir</code> and <code>config_dir</code> are the same directory — Apple's home for a config file that is not an <code>NSUserDefaults</code> plist is Application Support too. On Linux XDG separates them, and so does this.</p></div>
|
||
<div class="params"><h2>Parameters</h2><div class="param" id="param-app"><code class="pname">app</code><span class="pdesc">the application name (used as the folder name)</span></div></div>
|
||
<div class="examples"><h2>Example</h2><pre data-lang="ludic">program SaveDir {
|
||
entry {
|
||
let dir = Os.save_dir("MyGame")
|
||
print(len(dir))
|
||
}
|
||
}</pre></div>
|
||
|
||
<a class="back" href="api.html">← All symbols</a>
|
||
</main>
|
||
<script src="ludic-highlight.js"></script>
|
||
<script>Ludic.highlightAll(); Ludic.installCards(); Ludic.flashTarget();</script>
|
||
</body></html> |