Skip to content

Commit

Permalink
deploy: ebaff07
Browse files Browse the repository at this point in the history
  • Loading branch information
slimsag committed Mar 6, 2024
1 parent 71f1671 commit 9a9dbfc
Show file tree
Hide file tree
Showing 12 changed files with 120 additions and 175 deletions.
2 changes: 1 addition & 1 deletion about/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Windows does not have symlinks enabled, or Git is not configured to use them. Th
usage via nix-ld (preferred, requires unstable) Use nix-ld following e.g. this article.
For example this shell:
with import <nixpkgs> {}; mkShell { NIX_LD_LIBRARY_PATH = lib.makeLibraryPath [ pkgs.xorg.libX11 pkgs.vulkan-loader ]; NIX_LD = lib.fileContents "${stdenv.cc}/nix-support/dynamic-linker"; shellHook = '' export LD_LIBRARY_PATH=$NIX_LD_LIBRARY_PATH ''; } Then running zig build as usual:
zig build run-textured-cube Usage via shell { pkgs ?</description></item><item><title>Nominated Zig versions</title><link>https://machengine.org/about/nominated-zig/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://machengine.org/about/nominated-zig/</guid><description>Nominated Zig versions Periodically we nominate a new Zig nightly version which all Mach projects target and use.
zig build run-core-textured-cube Usage via shell { pkgs ?</description></item><item><title>Nominated Zig versions</title><link>https://machengine.org/about/nominated-zig/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://machengine.org/about/nominated-zig/</guid><description>Nominated Zig versions Periodically we nominate a new Zig nightly version which all Mach projects target and use.
We encourage others to adopt the same Zig version Mach uses, since Zig packages which target latest nightly (or the latest stable release) will very often be incompatible otherwise.
Why nominated Zig versions, instead of nightly or stable? TL;DR: it&amp;rsquo;s a sweetspot between stable and nightly.
Stable releases occur just once or twice per year, nominated Zig versions occur several times per year - but not every day like nightly.</description></item><item><title>Platform support</title><link>https://machengine.org/about/platforms/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://machengine.org/about/platforms/</guid><description>Platform support We aim to support a broad array of operating systems and architectures, as long as they are reasonably used by desktop/mobile consumers, or someone would like to contribute and maintain support for them.
Expand Down
8 changes: 4 additions & 4 deletions about/nixos-usage/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@
usage via nix-ld (preferred, requires unstable) Use nix-ld following e.g. this article.
For example this shell:
with import <nixpkgs> {}; mkShell { NIX_LD_LIBRARY_PATH = lib.makeLibraryPath [ pkgs.xorg.libX11 pkgs.vulkan-loader ]; NIX_LD = lib.fileContents &#34;${stdenv.cc}/nix-support/dynamic-linker&#34;; shellHook = '' export LD_LIBRARY_PATH=$NIX_LD_LIBRARY_PATH ''; } Then running zig build as usual:
zig build run-textured-cube Usage via shell { pkgs ?"><meta property="og:type" content="article"><meta property="og:url" content="https://machengine.org/about/nixos-usage/"><meta property="og:image" content="https://machengine.org/opengraph/template_hu102e162f47cb7d8ae9eb284939698b9d_62022_37cef03d2f858020a914dedebea79261.png"><meta property="article:section" content="about"><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="https://machengine.org/opengraph/template_hu102e162f47cb7d8ae9eb284939698b9d_62022_37cef03d2f858020a914dedebea79261.png"><meta name=twitter:title content="nixOS usage"><meta name=twitter:description content="Using Mach on nixOS If you use nixOS and want to use Mach, this document is for you.
zig build run-core-textured-cube Usage via shell { pkgs ?"><meta property="og:type" content="article"><meta property="og:url" content="https://machengine.org/about/nixos-usage/"><meta property="og:image" content="https://machengine.org/opengraph/template_hu102e162f47cb7d8ae9eb284939698b9d_62022_37cef03d2f858020a914dedebea79261.png"><meta property="article:section" content="about"><meta name=twitter:card content="summary_large_image"><meta name=twitter:image content="https://machengine.org/opengraph/template_hu102e162f47cb7d8ae9eb284939698b9d_62022_37cef03d2f858020a914dedebea79261.png"><meta name=twitter:title content="nixOS usage"><meta name=twitter:description content="Using Mach on nixOS If you use nixOS and want to use Mach, this document is for you.
usage via nix-ld (preferred, requires unstable) Use nix-ld following e.g. this article.
For example this shell:
with import <nixpkgs> {}; mkShell { NIX_LD_LIBRARY_PATH = lib.makeLibraryPath [ pkgs.xorg.libX11 pkgs.vulkan-loader ]; NIX_LD = lib.fileContents &#34;${stdenv.cc}/nix-support/dynamic-linker&#34;; shellHook = '' export LD_LIBRARY_PATH=$NIX_LD_LIBRARY_PATH ''; } Then running zig build as usual:
zig build run-textured-cube Usage via shell { pkgs ?"></head><body><div class=navbar><div class=content><a href=https://machengine.org// class=logo><div class=img></div></a><div class=subsection><a href=https://machengine.org//engine class=item>Engine</a>
zig build run-core-textured-cube Usage via shell { pkgs ?"></head><body><div class=navbar><div class=content><a href=https://machengine.org// class=logo><div class=img></div></a><div class=subsection><a href=https://machengine.org//engine class=item>Engine</a>
<a href=https://machengine.org//core class=item>Core</a>
<a href=https://machengine.org//pkg class=item>Packages</a>
<a href=https://machengine.org//about class=item>Project</a></div><div class="divider color-border">&nbsp;</div><div class=subsection><a href=https://devlog.hexops.com/categories/mach/ class=item>Devlog</a>
Expand All @@ -24,7 +24,7 @@
</span></span></span><span style=display:flex><span><span style=color:#e6db74> export LD_LIBRARY_PATH=$NIX_LD_LIBRARY_PATH
</span></span></span><span style=display:flex><span><span style=color:#e6db74> &#39;&#39;</span>;
</span></span><span style=display:flex><span>}
</span></span></code></pre></div><p>Then running <code>zig build</code> as usual:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-sh data-lang=sh><span style=display:flex><span>zig build run-textured-cube
</span></span></code></pre></div><p>Then running <code>zig build</code> as usual:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-sh data-lang=sh><span style=display:flex><span>zig build run-core-textured-cube
</span></span></code></pre></div><h2 id=usage-via-shell>Usage via shell</h2><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-nix data-lang=nix><span style=display:flex><span>{ pkgs <span style=color:#f92672>?</span> <span style=color:#f92672>import</span> <span style=color:#e6db74>&lt;nixpkgs&gt;</span> {} }:
</span></span><span style=display:flex><span>pkgs<span style=color:#f92672>.</span>mkShell {
</span></span><span style=display:flex><span> buildInputs <span style=color:#f92672>=</span> [
Expand All @@ -36,4 +36,4 @@
</span></span></span><span style=display:flex><span><span style=color:#e6db74> &#39;&#39;</span>;
</span></span><span style=display:flex><span>}
</span></span></code></pre></div><h2 id=usage-via-steam-run>Usage via steam-run</h2><p>You can also run Mach examples via <code>steam-run</code>, for this you will need to install Steam, then create a shell using steam-run, e.g.:</p><div class=highlight><pre tabindex=0 style=color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-sh data-lang=sh><span style=display:flex><span>env NIXPKGS_ALLOW_UNFREE<span style=color:#f92672>=</span><span style=color:#ae81ff>1</span> nix-shell -p steam-run
</span></span></code></pre></div><p>(then <code>zig build run-textured-cube</code> as usual)</p><h2 id=known-issues>Known issues</h2><h3 id=incorrect-cursor-behavior-with-cursormode-set-to-disabled>Incorrect cursor behavior with cursormode set to disabled</h3><p>If your cursor is not hidden and behaves &ldquo;jumpy&rdquo; after setting cursormode to disabled, you will need to add the <code>pkgs.xorg.libXcursor</code> package as an additional buildinput. This is required for both Xorg and Wayland.</p><p>If capturing the cursor is not required, libXcursor can be omitted.</p><h2 id=debugging-tips>Debugging tips</h2><ul><li>Mach requires a functional Vulkan graphics driver by default, but you can also try OpenGL via <code>MACH_GPU_BACKEND=opengl</code></li><li>Poor vsync implementations on Linux may make the application appear laggy, <a href=https://github.com/hexops/mach/issues/444#issuecomment-1369186927>you may need a frame rate limiter</a> (please let us know if you run into this.</li><li>OpenGL ES fallback is <a href=https://github.com/hexops/mach/issues/471>not yet supported</a></li><li><a href=https://github.com/hexops/mach/issues/458><code>VK_ERROR_INCOMPATIBLE_DRIVER</code></a> may be encountered if your GPU does not support Vulkan / the version we require, please try <code>MACH_GPU_BACKEND=opengl</code> if so.</li></ul></div><div class=toc><h3>Table of contents</h3><nav id=TableOfContents><ul><li><a href=#usage-via-nix-ld-preferred-requires-unstable>usage via nix-ld (preferred, requires unstable)</a></li><li><a href=#usage-via-shell>Usage via shell</a></li><li><a href=#usage-via-steam-run>Usage via steam-run</a></li><li><a href=#known-issues>Known issues</a><ul><li><a href=#incorrect-cursor-behavior-with-cursormode-set-to-disabled>Incorrect cursor behavior with cursormode set to disabled</a></li></ul></li><li><a href=#debugging-tips>Debugging tips</a></li></ul></nav></div></main><div class=footer><a href=https://hexops.com/privacy>Privacy matters</a><p><a href=https://github.com/hexops/machengine.org/archive/refs/heads/gh-pages.zip>offline version of this site</a> | <a href=https://machengine.org//about#improve-this-site>Improve this site</a> | <a href=https://github.com/sponsors/slimsag>Sponsor on GitHub</a> | <a href=https://devlog.hexops.com/>Hexops' devlog</a></p></div></div></body></html>
</span></span></code></pre></div><p>(then <code>zig build run-core-textured-cube</code> as usual)</p><h2 id=known-issues>Known issues</h2><h3 id=incorrect-cursor-behavior-with-cursormode-set-to-disabled>Incorrect cursor behavior with cursormode set to disabled</h3><p>If your cursor is not hidden and behaves &ldquo;jumpy&rdquo; after setting cursormode to disabled, you will need to add the <code>pkgs.xorg.libXcursor</code> package as an additional buildinput. This is required for both Xorg and Wayland.</p><p>If capturing the cursor is not required, libXcursor can be omitted.</p><h2 id=debugging-tips>Debugging tips</h2><ul><li>Mach requires a functional Vulkan graphics driver by default, but you can also try OpenGL via <code>MACH_GPU_BACKEND=opengl</code></li><li>Poor vsync implementations on Linux may make the application appear laggy, <a href=https://github.com/hexops/mach/issues/444#issuecomment-1369186927>you may need a frame rate limiter</a> (please let us know if you run into this.</li><li>OpenGL ES fallback is <a href=https://github.com/hexops/mach/issues/471>not yet supported</a></li><li><a href=https://github.com/hexops/mach/issues/458><code>VK_ERROR_INCOMPATIBLE_DRIVER</code></a> may be encountered if your GPU does not support Vulkan / the version we require, please try <code>MACH_GPU_BACKEND=opengl</code> if so.</li></ul></div><div class=toc><h3>Table of contents</h3><nav id=TableOfContents><ul><li><a href=#usage-via-nix-ld-preferred-requires-unstable>usage via nix-ld (preferred, requires unstable)</a></li><li><a href=#usage-via-shell>Usage via shell</a></li><li><a href=#usage-via-steam-run>Usage via steam-run</a></li><li><a href=#known-issues>Known issues</a><ul><li><a href=#incorrect-cursor-behavior-with-cursormode-set-to-disabled>Incorrect cursor behavior with cursormode set to disabled</a></li></ul></li><li><a href=#debugging-tips>Debugging tips</a></li></ul></nav></div></main><div class=footer><a href=https://hexops.com/privacy>Privacy matters</a><p><a href=https://github.com/hexops/machengine.org/archive/refs/heads/gh-pages.zip>offline version of this site</a> | <a href=https://machengine.org//about#improve-this-site>Improve this site</a> | <a href=https://github.com/sponsors/slimsag>Sponsor on GitHub</a> | <a href=https://devlog.hexops.com/>Hexops' devlog</a></p></div></div></body></html>
Loading

0 comments on commit 9a9dbfc

Please sign in to comment.