Веб-сайт самохостера Lotigara

summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKae <80987908+Novaenia@users.noreply.github.com>2024-04-26 06:57:06 +1000
committerGitHub <noreply@github.com>2024-04-26 06:57:06 +1000
commiteeff5a74243915bd07a84630149b2b63ffac5ce0 (patch)
tree9b1e46b88eb2307779c736cf8fa069d4ae767c95 /README.md
parent89852ab6c6bae9c54ccc33dd14d6603cadbbbb9d (diff)
Move build instructions into openable sections
[skip ci]
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 15 insertions, 5 deletions
diff --git a/README.md b/README.md
index d21aa73..ff24695 100644
--- a/README.md
+++ b/README.md
@@ -47,7 +47,7 @@ Note: Not every function from [StarExtensions](https://github.com/StarExtensions
Note: Some of these [texts](## "hi :3") are just tooltips rather than links.
<details>
-<summary><b>template sbinit.config for dist/ after build</b></summary>
+<summary>template sbinit.config for dist/ after build</summary>
<br>
```json
@@ -63,8 +63,9 @@ Note: Some of these [texts](## "hi :3") are just tooltips rather than links.
```
</details>
-
-### Windows
+<details>
+<summary><b>Windows</b></summary>
+
* Install [vcpkg](https://github.com/microsoft/vcpkg?tab=readme-ov-file#quick-start-windows) *globally*.
* vcpkg recommends a short directory, such as `C:\src\vcpkg` or `C:\dev\vcpkg`.
* If you're using Visual Studio, don't forget to run `vcpkg integrate install`!
@@ -76,7 +77,11 @@ Note: Some of these [texts](## "hi :3") are just tooltips rather than links.
* If you're using an IDE, it should detect the correct preset and allow you to build from within.
* Otherwise, build manually by running CMake in the **source/** directory: `cmake --build --preset=windows-release`
* The built binaries will be in **dist/**. Copy the DLLs from **lib/windows/** and the **sbinit.config** above into **dist/** so the game can run.
-### Linux (Ubuntu)
+
+</details>
+<details>
+<summary><b>Linux (Ubuntu)</b></summary>
+
* Make sure you're using CMake 3.19 or newer - you may need to [add Kitware's APT repo](https://apt.kitware.com/) to install a newer version.
* Install dependencies:
* `sudo apt-get install pkg-config libxmu-dev libxi-dev libgl-dev libglu1-mesa-dev libsdl2-dev python3-jinja2 ninja-build`
@@ -87,8 +92,11 @@ Note: Some of these [texts](## "hi :3") are just tooltips rather than links.
* The built binaries will be in **dist/**. Copy the the .so libs from **lib/linux/** and the **sbinit.config** above into **dist/** so the game can run.
* From the root dir of the repo, you can run the assembly script which is used by the GitHub Action: `scripts/ci/linux/assemble.sh`
* This packs the game assets and copies the built binaries, premade sbinit configs & required libs into **client/** & **server/**.
+
+</details>
-### Linux (Fedora)
+<details>
+<summary><b>Linux (Fedora)</b></summary>
Starbound in general is built from the ground up, with its own engine written in C++ on top of some basic libraries.
@@ -170,5 +178,7 @@ LD_LIBRARY_PATH="$LD_LIBRARY_PATH:./" padsp ./starbound "$@"`
</details>
+</details>
+
### macOS
To be written.