Skip to content

Commit

Permalink
Merge pull request #1431 from dpogue/docs-update
Browse files Browse the repository at this point in the history
Update website download and build instructions
  • Loading branch information
dpogue authored Jul 25, 2023
2 parents 3203e36 + 0fe3cf9 commit 7bf3af9
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 16 deletions.
28 changes: 15 additions & 13 deletions building.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ <h3 id="dependencies">Library Dependencies</h3>
<li><a href="https://www.openssl.org/">OpenSSL</a></li>
<li><a href="https://openal-soft.org/">OpenAL Soft</a></li>
<li><a href="https://libexpat.github.io/">Expat</a></li>
<li><a href="https://libjpeg-turbo.org/">libjpeg</a></li>
<li><a href="https://www.freetype.org/">FreeType</a></li>
<li><a href="https://libjpeg-turbo.org/">libjpeg-turbo</a></li>
<li><a href="http://www.libpng.org/">libpng</a></li>
<li><a href="https://zlib.net/">zlib</a></li>
<li><a href="https://curl.se/">libcurl</a></li>
Expand All @@ -57,8 +58,9 @@ <h3 id="dependencies">Library Dependencies</h3>
<ul>
<li><a href="https://cairosvg.org/">CairoSVG</a> (for building resource.dat)</li>
<li><a href="https://python-pillow.org/">Pillow</a> (for building resource.dat)</li>
<li><a href="https://www.freetype.org/">FreeType</a> (for plFontConverter)</li>
<li><a href="https://www.qt.io/download-open-source">Qt5</a> (for the GUI tools)</li>
<li><a href="https://github.com/anholt/libepoxy">epoxy</a> (for experimental OpenGL support)</li>
<li><a href="https://www.fontconfig.org/">fontconfig</a> (for Linux font support)</li>
<li><a href="https://www.qt.io/download-open-source">Qt</a> (for the GUI tools)</li>
<li><a href="https://www.webmproject.org/">VPX and WebM</a> (for video)</li>
<li><a href="https://www.opus-codec.org/">Opus</a> (for video and voice chat)</li>
<li><a href="https://www.speex.org/downloads/">Speex</a> (for legacy voice chat)</li>
Expand All @@ -69,24 +71,24 @@ <h3 id="dependencies">Library Dependencies</h3>

<h3 id="building-windows">Building on Windows</h3>

<p>Compiling on Windows requires Visual Studio. We recommend <a href="https://visualstudio.microsoft.com/downloads/">Visual Studio 2019 Community Edition</a>, which is available as a free download. Install the “Desktop development with C++” workload.</p>
<p>Compiling on Windows requires Visual Studio. We recommend <a href="https://visualstudio.microsoft.com/downloads/">Visual Studio 2022 Community Edition</a>, which is available as a free download. Install the “Desktop development with C++” workload.</p>

<ol>
<li>
<p>Clone the repository from GitHub, including all submodules, using a git client. On the command line, this can be done by executing the following:<br>
<code>git clone --recurse-submodules https://github.com/H-uru/Plasma.git</code></p>

<p class="infonote" data-infotype="warning"><b>Note:</b> We recommend using <a href="https://git-scm.com/download/win">Git for Windows</a>. Using the git program provided by Cygwin will not set permissions properly on some files and result in build failures.</p>

<p class="infonote" data-infotype="warning"><b>Note:</b> Some dependencies may fail to build if the path to the code contains spaces.</p>
<p>Launch Visual Studio, and pick <strong>Clone a repository</strong> on the startup screen.</p>
</li>

<li>
<p>Launch Visual Studio.</p>
<p>Enter the following URL as the repository location:<br>
<code>https://github.com/H-uru/Plasma.git</code></p>

<p>Specify the folder path on your machine where you'd like the code to be cloned, and then click <strong>Clone</strong>.</p>

<p class="infonote" data-infotype="warning"><b>Note:</b> Some dependencies may fail to build if the path to the code contains spaces.</p>
</li>

<li>
<p>Select <strong>Open a local folder</strong> and choose the folder where you cloned the repository.</p>
<p>When Visual Studio finishes cloning the repository, double click on <strong>Folder View</strong> in the Solution Explorer panel.</p>
</li>

<li>
Expand Down Expand Up @@ -153,7 +155,7 @@ <h3 id="building-nix">Building on macOS &amp; Linux</h3>

<p>Linux and macOS are <strong>not officially supported targets</strong>, and the game client does not compile. However, several of the tools can be built and run.</p>

<p>You will need to ensure all the required dependencies are available. You may be able to use vcpkg on these platforms, but it has not been extensively tested.</p>
<p>You will need to ensure all the required dependencies are available. On macOS, a Homebrew bundle file is included in the repository, which can be installed by running <code>brew bundle</code>. You can also use vcpkg on these platforms for automatically managing dependencies.</p>

<ol>
<li>
Expand Down
2 changes: 1 addition & 1 deletion download.html
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ <h3 id="official">Official Releases</h3>

<h3 id="devbuilds">Development</h3>

<p>Experimental development builds are available for download as artifacts from our <a href="https://github.com/H-uru/Plasma/actions?query=workflow%3ACI+branch%3Amaster">GitHub Continuous Integration system</a>. These are built automatically when code is merged, and are not tested for stability. These should be used for local testing only.</p>
<p>Experimental development builds are available for download as artifacts from our <a href="https://github.com/H-uru/Plasma/releases/tag/last-successful">GitHub pre-release tag</a>. These are built automatically when code is merged, and are not tested for stability. These should be used for local testing only.</p>

<p>The game engine source code is also available for download from GitHub. For compiling instructions, please see the <a href="building.html">Development section</a>.</p>

Expand Down
4 changes: 2 additions & 2 deletions involvement.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ <h2>Get Involved</h2>

<p>There are plenty of opportunities to get involved, ranging from play testing, to documentation and planning, to a variety of development tasks. We have a <a href="https://github.com/H-uru/Plasma/blob/master/CONTRIBUTING.md">Contribution Guideline</a> document to help you get started.</p>

<p>We use GitHub Discussions to propose ideas, solicit feedback, and discuss plans for the development roadmap. We welcome participation from anyone interested in the future direction of the engine development. You can <a href="https://github.com/H-uru/Plasma/discussions">join those discussions on GitHub</a>.</p>


<h3 id="bug-reports">Reporting Bugs</h3>

Expand All @@ -49,8 +51,6 @@ <h3 id="development">Development</h3>

<p>We attempt to keep a list of “good first issues” for new contributors, which offer opportunities to become familiar with the engine codebase and structure while solving a clearly defined problem. Look for issues <a href="https://github.com/H-uru/Plasma/issues?q=is%3Aissue+is%3Aopen+label%3AHacktoberfest">tagged with Hacktoberfest</a> as starting points.</p>

<p>We use GitHub Discussions to propose ideas, solicit feedback, and discuss plans for the development roadmap. We welcome participation from anyone interested in the future direction of the engine development. You can <a href="https://github.com/H-uru/Plasma/discussions">join those discussions on GitHub</a>.</p>

<p>A lot of informal development discussion takes place on IRC and Discord. These are great places to ask questions about getting involved, or discuss issues.</p>

<dl>
Expand Down

0 comments on commit 7bf3af9

Please sign in to comment.