diff options
| -rw-r--r-- | BUILD.md | 52 | ||||
| -rw-r--r-- | README.md | 18 |
2 files changed, 59 insertions, 11 deletions
@@ -1,5 +1,53 @@ # Build Instructions -Build instructions are available on [the website](https://prismlauncher.org/wiki/development/build-instructions/). +Full build instructions will be available on [the website](https://prismlauncher.org/wiki/development/build-instructions/). + +If you would like to contribute or fix an issue with the Build instructions you will be able to do so [here](https://github.com/PrismLauncher/website/blob/master/src/wiki/development/build-instructions.md). + +## Getting the source + +Clone the source code using git, and grab all the submodules. This is generic for all platforms you want to build on. +``` +git clone --recursive https://github.com/PrismLauncher/PrismLauncher +cd PrismLauncher +``` + +## Linux + +This guide will mostly mention dependant packages by their Debian naming and commands are done by a user in the sudoers file. +### Dependencies + +- A C++ compiler capable of building C++17 code (can be found in the package `build-essential`). +- Qt Development tools 5.12 or newer (on Debian 11 or Debian-based distributions, `qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libqt5core5a libqt5network5 libqt5gui5`). +- `cmake` 3.15 or newer. +- `extra-cmake-modules`. +- zlib (`zlib1g-dev` on Debian 11 or Debian-based distributions). +- Java Development Kit (Java JDK) (`openjdk-17-jdk` on Debian 11 or Debian-based distributions). +- Mesa GL headers (`libgl1-mesa-dev` on Debian 11 or Debian-based distributions). +- (Optional) `scdoc` to generate man pages. + +In conclusion, to check if all you need is installed (including optional): + +``` +sudo apt install build-essential qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libqt5core5a libqt5network5 libqt5gui5 cmake extra-cmake-modules zlib1g-dev openjdk-17-jdk libgl1-mesa-dev scdoc +``` + +### Compiling +#### Building and installing on the system +This is usually the suggested way to build the client. + +``` +cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/usr" -DENABLE_LTO=ON +cmake --build build -j$(nproc) +sudo cmake --install build +``` + +#### Building a portable binary + +``` +cmake -S . -B build -DCMAKE_INSTALL_PREFIX=install +cmake --build build -j$(nproc) +cmake --install build +cmake --install build --component portable +``` -If you would like to contribute or fix an issue with the Build instructions you can do so [here](https://github.com/PlaceholderMC/website/blob/master/src/wiki/development/build-instructions.md). @@ -1,24 +1,24 @@ -# PlaceholderMC is a custom launcher that will be the continuation of the now dead PolyMC. -#### We are working on a website and other media, for more info we have a discord server. -#### Logo and branding also coming soon... +# Prism Launcher -### Here is the [Discord Server](https://discord.gg/hX4g537UNE) +Prism Launcher is a custom launcher for Minecraft that allows you to easily manage multiple installations of Minecraft at once. + +We are working on a website and other media, for more info we have a [Discord server](https://discord.gg/hX4g537UNE). Logo and branding also coming soon. ## Installation -- All downloads and instructions for PlaceholderMC will soon be available -- Last build status: <https://github.com/PlaceholderMC/PlaceholderMC/actions> +- All downloads and instructions for Prism Launcher will soon be available. +- Last build status: <https://github.com/PrismLauncher/PrismLauncher/actions> ### Development Builds -There are development builds available [here](https://github.com/PlaceholderMC/PlaceholderMC/actions). These have debug information in the binaries, so their file sizes are relatively larger. +There are development builds available [here](https://github.com/PrismLauncher/PrismLauncher/actions). These have debug information in the binaries, so their file sizes are relatively larger. + Portable builds are provided for AppImage on Linux, Windows, and macOS. ## Help & Support - Join the [Discord Server](https://discord.gg/hX4g537UNE) for now. -We have a vanity url https://discord.gg/prismlauncher -### License +## License All launcher code is available under the GPL-3.0-only license. |