diff --git a/BUILD.md b/BUILD.md index d14f2941..d980fde9 100644 --- a/BUILD.md +++ b/BUILD.md @@ -1,14 +1,11 @@ -Build Instructions -================== +# Build Instructions # Contents -* [Note](#note) -* [Getting the source](#source) -* [Linux](#linux) -* [Windows](#windows) -* [macOS](#macos) - +- [Getting the source](#getting-the-source) +- [Linux](#linux) +- [Windows](#windows) +- [macOS](#macos) # Getting the source @@ -16,34 +13,65 @@ Clone the source code using git and grab all the submodules: ``` git clone https://github.com/PolyMC/PolyMC.git +cd PolyMC git submodule init git submodule update ``` +The rest of the documentation assumes you have already cloned the repository. + # Linux Getting the project to build and run on Linux is easy if you use any modern and up-to-date linux distribution. ## Build dependencies -* A C++ compiler capable of building C++11 code. -* Qt Development tools 5.6 or newer (`qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libqt5core5a libqt5network5 libqt5gui5` on Debian-based system) -* cmake 3.1 or newer (`cmake` on Debian-based system) -* zlib (`zlib1g-dev` on Debian-based system) -* Java JDK (`openjdk-17-jdk`on Debian-based system) -* GL headers (`libgl1-mesa-dev` on Debian-based system) + +- A C++ compiler capable of building C++11 code. +- Qt Development tools 5.6 or newer (`qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libqt5core5a libqt5network5 libqt5gui5` on Debian-based system) +- cmake 3.1 or newer (`cmake` on Debian-based system) +- zlib (`zlib1g-dev` on Debian-based system) +- Java JDK (`openjdk-17-jdk`on Debian-based system) +- GL headers (`libgl1-mesa-dev` on Debian-based system) + +You can use IDEs like KDevelop or QtCreator to open the CMake project if you want to work on the code. + +### Building a portable binary + +```sh +mkdir install +# configure the project +cmake -S . -B build \ + -DCMAKE_INSTALL_PREFIX=./install +# build +cd build +make -j$(nproc) install +``` + +### Building & Installing to the System + +This is the preferred method for installation, and is suitable for packages. + +```sh +# configure everything +cmake -S . -B build \ + -DCMAKE_BUILD_TYPE=Release \ + -DCMAKE_INSTALL_PREFIX="/usr" \ # Use "/usr" for packages, otherwise, leave it at the default "/usr/local". + -DLauncher_LAYOUT=lin-system +cd build +make -j$(nproc) install # Optionally specify DESTDIR for packages (i.e. DESTDIR=${pkgdir}) +``` ### Building a .deb -You need to install the build dependencies first +Requirements: [makedeb](https://docs.makedeb.org/) installed on your system. ``` -git clone https://github.com/PolyMC/PolyMC.git -git submodule init && git submodule update -cd packages/debian -./makedeb.sh +git clone https://mpr.makedeb.org/polymc.git +cd polymc +makedeb -s ``` -If everything works correctly, the .deb will be next to the build script, in `PolyMC/packages/debian` +The deb will be located in the directory the repo was cloned in. ### Building a .rpm @@ -68,6 +96,7 @@ rpmbuild -bb polymc.spec The path to the rpm packages will be printed when the build is complete. ### Building from command line + You need a source folder, a build folder and an install folder. ``` @@ -83,46 +112,45 @@ cmake -DCMAKE_INSTALL_PREFIX=../install ../src make -j$(nproc) install ``` -You can use IDEs like KDevelop or QtCreator to open the CMake project if you want to work on the code. +The path to the rpm packages will be printed when the build is complete. -### Building & Installing to the System -This is the preferred method for installation, and is suitable for packages. +### Building a flatpak -``` -git clone --recursive https://github.com/PolyMC/PolyMC.git && cd PolyMC +You only need to clone the flatpak sources +`flatpak` and `flatpak-builder` need to be installed on your system -# configure everything -cmake -S . -B build \ - -DCMAKE_BUILD_TYPE=Release \ - -DCMAKE_INSTALL_PREFIX="/usr" \ # Use "/usr" for packages, otherwise, leave it at the default "/usr/local". - -DLauncher_LAYOUT=lin-system - -make -j$(nproc) install # Optionally specify DESTDIR for packages (i.e. DESTDIR=${pkgdir}) +```sh +git clone https://github.com/flathub/org.polymc.PolyMC +cd org.polymc.PolyMC +# remove --user and --install if you want to build without installing +flatpak-builder --user --install flatbuild org.polymc.PolyMC.yml ``` ### Installing Qt using the installer (optional) + 1. Run the Qt installer. 2. Choose a place to install Qt. 3. Choose the components you want to install. - - You need Qt 5.6.x 64-bit ticked. - - You need Tools/Qt Creator ticked. - - Other components are selected by default, you can untick them if you don't need them. + - You need Qt 5.6.x 64-bit ticked. + - You need Tools/Qt Creator ticked. + - Other components are selected by default, you can untick them if you don't need them. 4. Accept the license agreements. 5. Double check the install details and then click "Install". - - Installation can take a very long time, go grab a cup of tea or something and let it work. + - Installation can take a very long time, go grab a cup of tea or something and let it work. ### Loading the project in Qt Creator (optional) + 1. Open Qt Creator. 2. Choose `File->Open File or Project`. 3. Navigate to the Launcher source folder you cloned and choose CMakeLists.txt. 4. Read the instructions that just popped up about a build location and choose one. 5. You should see "Run CMake" in the window. - - Make sure that Generator is set to "Unix Generator (Desktop Qt 5.6.x GCC 64bit)". - - Hit the "Run CMake" button. - - You'll see warnings and it might not be clear that it succeeded until you scroll to the bottom of the window. - - Hit "Finish" if CMake ran successfully. + - Make sure that Generator is set to "Unix Generator (Desktop Qt 5.6.x GCC 64bit)". + - Hit the "Run CMake" button. + - You'll see warnings and it might not be clear that it succeeded until you scroll to the bottom of the window. + - Hit "Finish" if CMake ran successfully. 6. Cross your fingers and press the Run button (bottom left of Qt Creator). - - If the project builds successfully it will run and the Launcher window will pop up. + - If the project builds successfully it will run and the Launcher window will pop up. **If this doesn't work for you, let us know on our Discord.** @@ -131,61 +159,68 @@ make -j$(nproc) install # Optionally specify DESTDIR for packages (i.e. DESTDIR= Getting the project to build and run on Windows is easy if you use Qt's IDE, Qt Creator. The project will simply not compile using Microsoft build tools, because that's not something we do. If it does compile, it is by chance only. ## Dependencies -* [Qt 5.6+ Development tools](http://qt-project.org/downloads) -- Qt Online Installer for Windows - - http://download.qt.io/new_archive/qt/5.6/5.6.0/qt-opensource-windows-x86-mingw492-5.6.0.exe - - Download the MinGW version (MSVC version does not work). -* [OpenSSL](https://github.com/IndySockets/OpenSSL-Binaries/tree/master/Archive/) -- Win32 OpenSSL, version 1.0.2g (from 2016) - - https://github.com/IndySockets/OpenSSL-Binaries/raw/master/Archive/openssl-1.0.2g-i386-win32.zip - - the usual OpenSSL for Windows (http://slproweb.com/products/Win32OpenSSL.html) only provides the newest version of OpenSSL, and we need the 1.0.2g version - - **Download the 32-bit version, not 64-bit.** - - Microsoft Visual C++ 2008 Redist is required for this, there's a link on the OpenSSL download page above next to the main download. - - We use a custom build of OpenSSL that doesn't have this dependency. For normal development, the custom build is not necessary though. -* [zlib 1.2+](http://gnuwin32.sourceforge.net/packages/zlib.htm) - the Setup is fine -* [Java JDK 8](https://adoptium.net/releases.html?variant=openjdk8) - Use the MSI installer. -* [CMake](http://www.cmake.org/cmake/resources/software.html) -- Windows (Win32 Installer) + +- [Qt 5.6+ Development tools](http://qt-project.org/downloads) -- Qt Online Installer for Windows + - http://download.qt.io/new_archive/qt/5.6/5.6.0/qt-opensource-windows-x86-mingw492-5.6.0.exe + - Download the MinGW version (MSVC version does not work). +- [OpenSSL](https://github.com/IndySockets/OpenSSL-Binaries/tree/master/Archive/) -- Win32 OpenSSL, version 1.0.2g (from 2016) + - https://github.com/IndySockets/OpenSSL-Binaries/raw/master/Archive/openssl-1.0.2g-i386-win32.zip + - the usual OpenSSL for Windows (http://slproweb.com/products/Win32OpenSSL.html) only provides the newest version of OpenSSL, and we need the 1.0.2g version + - **Download the 32-bit version, not 64-bit.** + - Microsoft Visual C++ 2008 Redist is required for this, there's a link on the OpenSSL download page above next to the main download. + - We use a custom build of OpenSSL that doesn't have this dependency. For normal development, the custom build is not necessary though. +- [zlib 1.2+](http://gnuwin32.sourceforge.net/packages/zlib.htm) - the Setup is fine +- [Java JDK 8](https://adoptium.net/releases.html?variant=openjdk8) - Use the MSI installer. +- [CMake](http://www.cmake.org/cmake/resources/software.html) -- Windows (Win32 Installer) Ensure that OpenSSL, zlib, Java and CMake are on `PATH`. ## Getting set up ### Installing Qt + 1. Run the Qt installer 2. Choose a place to install Qt (C:\Qt is the default), 3. Choose the components you want to install - - You need Qt 5.6 (32 bit) ticked, - - You need Tools/Qt Creator ticked, - - Other components are selected by default, you can untick them if you don't need them. + - You need Qt 5.6 (32 bit) ticked, + - You need Tools/Qt Creator ticked, + - Other components are selected by default, you can untick them if you don't need them. 4. Accept the license agreements, 5. Double check the install details and then click "Install" - - Installation can take a very long time, go grab a cup of tea or something and let it work. + - Installation can take a very long time, go grab a cup of tea or something and let it work. ### Installing OpenSSL + 1. Download .zip file from the link above. 2. Unzip and add the directory to PATH, so CMake can find it. ### Installing CMake + 1. Run the CMake installer, 2. It's easiest if you choose to add CMake to the PATH for all users, - - If you don't choose to do this, remember where you installed CMake. + - If you don't choose to do this, remember where you installed CMake. ### Loading the project + 1. Open Qt Creator, 2. Choose File->Open File or Project, 3. Navigate to the Launcher source folder you cloned and choose CMakeLists.txt, 4. Read the instructions that just popped up about a build location and choose one, 5. If you chose not to add CMake to the system PATH, tell Qt Creator where you installed it, - - Otherwise you can skip this step. + - Otherwise you can skip this step. 6. You should see "Run CMake" in the window, - - Make sure that Generator is set to "MinGW Generator (Desktop Qt 5.6.x MinGW 32bit)", - - Hit the "Run CMake" button, - - You'll see warnings and it might not be clear that it succeeded until you scroll to the bottom of the window. - - Hit "Finish" if CMake ran successfully. + - Make sure that Generator is set to "MinGW Generator (Desktop Qt 5.6.x MinGW 32bit)", + - Hit the "Run CMake" button, + - You'll see warnings and it might not be clear that it succeeded until you scroll to the bottom of the window. + - Hit "Finish" if CMake ran successfully. 7. Cross your fingers and press the Run button (bottom left of Qt Creator)! - - If the project builds successfully it will run and the Launcher window will pop up, - - Test OpenSSL by making an instance and trying to log in. If Qt Creator couldn't find OpenSSL during the CMake stage, login will fail and you'll get an error. + - If the project builds successfully it will run and the Launcher window will pop up, + - Test OpenSSL by making an instance and trying to log in. If Qt Creator couldn't find OpenSSL during the CMake stage, login will fail and you'll get an error. The following .dlls are needed for the app to run (copy them to build directory if you want to be able to move the build to another pc): + ``` + platforms/qwindows.dll libeay32.dll libgcc_s_dw2-1.dll @@ -200,26 +235,32 @@ Qt5Widgets.dll Qt5Xml.dll ssleay32.dll zlib1.dll + ``` **These build instructions worked for me (Drayshak) on a fresh Windows 8 x64 Professional install. If they don't work for you, let us know on our Discord.** + ### Compile from command line on Windows + 1. If you installed Qt with the web installer, there should be a shortcut called `Qt 5.4 for Desktop (MinGW 4.9 32-bit)` in the Start menu on Windows 7 and 10. Best way to find it is to search for it. Do note you cannot just use cmd.exe, you have to use the shortcut, otherwise the proper MinGW software will not be on the PATH. 2. Once that is open, change into your user directory, and clone PolyMC by doing `git clone --recursive https://github.com/PolyMC/PolyMC.git`, and change directory to the folder you cloned to. 3. Make a build directory, and change directory to the directory and do `cmake -G "MinGW Makefiles" -DCMAKE_INSTALL_PREFIX=C:\Path\that\makes\sense\for\you`. By default, it will install to C:\Program Files (x86), which you might not want, if you want a local installation. If you want to install it to that directory, make sure to run the command window as administrator. -3. Do `mingw32-make -jX`, where X is the number of cores your CPU has plus one. -4. Now to wait for it to compile. This could take some time. Hopefully it compiles properly. -5. Run the command `mingw32-make install`, and it should install PolyMC, to whatever the `-DCMAKE_INSTALL_PREFIX` was. -6. In most cases, whenever compiling, the OpenSSL dll's aren't put into the directory to where PolyMC installs, meaning you cannot log in. The best way to fix this is just to do `copy C:\OpenSSL-Win32\*.dll C:\Where\you\installed\PolyMC\to`. This should copy the required OpenSSL dll's to log in. +4. Do `mingw32-make -jX`, where X is the number of cores your CPU has plus one. +5. Now to wait for it to compile. This could take some time. Hopefully it compiles properly. +6. Run the command `mingw32-make install`, and it should install PolyMC, to whatever the `-DCMAKE_INSTALL_PREFIX` was. +7. In most cases, whenever compiling, the OpenSSL dll's aren't put into the directory to where PolyMC installs, meaning you cannot log in. The best way to fix this is just to do `copy C:\OpenSSL-Win32\*.dll C:\Where\you\installed\PolyMC\to`. This should copy the required OpenSSL dll's to log in. # macOS ### Install prerequisites: + - Install XCode Command Line tools - Install the official build of CMake (https://cmake.org/download/) - Install JDK 8 (https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html) - Get Qt 5.6 and install it (https://download.qt.io/new_archive/qt/5.6/5.6.3/) +You can use `homebrew` to simplify the installation of build dependencies + ### XCode Command Line tools If you don't have XCode CommandLine tools installed, you can install them by using this command in the Terminal App @@ -233,8 +274,6 @@ xcode-select --install Pick an installation path - this is where the final `.app` will be constructed when you run `make install`. Supply it as the `CMAKE_INSTALL_PREFIX` argument during CMake configuration. ``` -git clone --recursive https://github.com/PolyMC/PolyMC.git -cd Launcher mkdir build cd build cmake \ @@ -250,5 +289,7 @@ cmake \ make install ``` +Remember to replace `/path/to/Qt5.6/` with the actual path. For newer Qt installations, it is often in your home directory. + **Note:** The final app bundle may not run due to code signing issues, which need to be fixed with `codesign -fs -`. diff --git a/README.md b/README.md index 778a2d96..4e6c3f29 100644 --- a/README.md +++ b/README.md @@ -7,51 +7,94 @@ PolyMC is a custom launcher for Minecraft that focuses on predictability, long term stability and simplicity. This is a **fork** of the MultiMC Launcher and not endorsed by MultiMC. The PolyMC community felt that the maintainer was not acting in the spirit of Free Software so this fork was made. Read "[Why was this fork made?](https://github.com/PolyMC/PolyMC/wiki/FAQ)" on the wiki for more details. +
-## Packages -Several source build packages are available, along with experimental pre-built generic packages. +# Installation + +## 🐧 Linux + +### Cross-distro packages Download on Flathub -
-[![AUR package](https://img.shields.io/aur/version/polymc-git)](https://aur.archlinux.org/packages/polymc-git/) -- A [Nix](packages/nix/NIX.md) derivation is available in repo. -- A Gentoo ebuild is available in the [swirl](https://git.swurl.xyz/swirl/ebuilds) overlay, named `games-action/polymc`. Check the README for instructions on how to add the overlay. -- The Flatpak can be built using [this source](https://github.com/flathub/org.polymc.PolyMC). -- An RPM package is available on [COPR](https://copr.fedorainfracloud.org/coprs/sentry/polymc/), or can be built by going to the `packages/rpm` directory and running `rpmbuild -bb polymc.spec`. -- Generic, prebuilt packages (archived by version) can be found [here](https://packages.polymc.org/) ([latest](https://packages.polymc.org/latest)). + +Download as AppImage + +- [AppImage SHA256](https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage.sha256) +- All packages (archived by version) can be found [here](https://packages.polymc.org/) ([latest](https://packages.polymc.org/latest)). - Last build status: https://jenkins.polymc.org/job/PolyMC/lastBuild/ -- [Linux (AMD64) System](https://packages.polymc.org/latest/lin64-system/lin64-system.tar.zst) ([SHA256](https://packages.polymc.org/latest/lin64-system/lin64-system.tar.zst.sha256)) - this is a generic system package intended to be used as a base for making distro-specific packages. -- [Windows (32-bit)](https://packages.polymc.org/latest/win32/win32.zip) ([SHA256](https://packages.polymc.org/latest/win32/win32.zip.sha256)) - this is a portable package, you can extract it anywhere and run it. This package needs testing. -- [Debian (AMD64)](https://packages.polymc.org/latest/deb/polymc-amd64.deb) ([SHA256](https://packages.polymc.org/latest/deb/polymc-amd64.deb.sha256)) - this is intended to be installed with `dpkg -i`. Alternatively, you may build the `.deb` yourself, by going to `packages/debian` and running `./makedeb.sh`. -- [AppImage (AMD64)](https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage) ([SHA256](https://packages.polymc.org/latest/appimage/PolyMC-latest-x86_64.AppImage.sha256)) - `chmod +x` must be run on this file before usage. This should work on any distribution. -- [Arch Linux (AMD64)](https://packages.polymc.org/latest/arch/polymc-bin-latest-1-x86_64.pkg.tar.zst) ([SHA256](https://packages.polymc.org/latest/arch/polymc-bin-latest-1-x86_64.pkg.tar.zst.sha256)) - this is intended to be installed with `pacman -U`. This is an alternative if building the AUR package is not desired. -- MacOS currently does not have any packages. We are still working on setting up MacOS packaging. +- [System Package (AMD64)](https://packages.polymc.org/latest/lin64-system/lin64-system.tar.zst) ([SHA256](https://packages.polymc.org/latest/lin64-system/lin64-system.tar.zst.sha256)) - a generic system package intended to be used as a base for making distro-specific packages -## Development -If you want to contribute to PolyMC you might find it useful to join [#development:polymc.org on Matrix](https://matrix.to/#/#development:polymc.org) or join [our Discord server](https://discord.gg/xq7fxrgtMP), which is bridged with the PolyMC Matrix rooms. Thank you! +### Arch Linux -### Building -If you want to build PolyMC yourself, check [BUILD.md](BUILD.md) for build instructions. +There are several AUR packages available: +[![polymc](https://img.shields.io/badge/aur-polymc-blue)](https://aur.archlinux.org/packages/polymc/) +[![polymc-bin](https://img.shields.io/badge/aur-polymc--bin-blue)](https://aur.archlinux.org/packages/polymc-bin/) +[![polymc-git](https://img.shields.io/badge/aur-polymc--git-blue)](https://aur.archlinux.org/packages/polymc-git/) -You can build the flatpak using [this source](https://github.com/flathub/org.polymc.PolyMC). +```sh +# stable source package: +yay -S polymc +# stable binary package: +yay -S polymc-bin +# latest git package: +yay -S polymc-git +``` -### Code formatting -Just follow the existing formatting. +### Debian -In general, in order of importance: -* Make sure your IDE is not messing up line endings or whitespace and avoid using linters. -* Prefer readability over dogma. -* Keep to the existing formatting. -* Indent with 4 space unless it's in a submodule. -* Keep lists (of arguments, parameters, initializers...) as lists, not paragraphs. It should either read from top to bottom, or left to right. Not both. +We use [makedeb](https://docs.makedeb.org/) for our Debian packages. +Several MPR packages are available: -## Translations -TODO +[![polymc](https://img.shields.io/badge/mpr-polymc-orange)](https://mpr.makedeb.org/packages/polymc) +[![polymc-bin](https://img.shields.io/badge/mpr-polymc--bin-orange)](https://mpr.makedeb.org/packages/polymc-bin) +[![polymc-git](https://img.shields.io/badge/mpr-polymc--git-orange)](https://mpr.makedeb.org/packages/polymc-git) -## Forking/Redistributing/Custom builds policy -Do whatever you want, we don't care. Just follow the license. If you have any questions about this feel free to ask in an issue. +```sh +# stable source package: +sudo tap install polymc +# stable binary package: +sudo tap install polymc-bin +# latest git package: +sudo tap install polymc-git +``` + +### Nix + +A [Nix derivation](packages/nix/NIX.md) is available. + +### Gentoo + +A Gentoo ebuild is available in the [swirl](https://git.swurl.xyz/swirl/ebuilds) overlay, named `games-action/polymc`. + +```sh +# as root: +emerge --oneshot eselect-repository +eselect-repository enable swirl +emaint sync -r swirl +emerge polymc +# to use latest git version: +sudo tee -a /etc/portage/package.accept_keywords <<< "=games-action/polymc-9999 **" +``` + +### Fedora + +An RPM package is available on [COPR](https://copr.fedorainfracloud.org/coprs/sentry/polymc/) + +```sh +sudo dnf copr enable sentry/polymc +sudo dnf install polymc +``` + +## Windows + +[Windows (32-bit)](https://packages.polymc.org/latest/win32/win32.zip) ([SHA256](https://packages.polymc.org/latest/win32/win32.zip.sha256)) - this is a portable package, you can extract it anywhere and run it. This package needs testing. + +## MacOS + +MacOS currently does not have any packages. We are still working on setting up MacOS packaging. + +# Help & Support -## Help & Support Feel free to create an issue if you need help. However, you might find it easier to ask in the Discord server. [![PolyMC Discord](https://img.shields.io/discord/923671181020766230?label=PolyMC%20Discord)](https://discord.gg/xq7fxrgtMP) @@ -66,3 +109,31 @@ If there are any issues with the space or you are using a client that does not s [![Discussion](https://img.shields.io/matrix/discussion:polymc.org?label=%23discussion&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#discussion:polymc.org) [![Development](https://img.shields.io/matrix/development:polymc.org?label=%23development&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#development:polymc.org) [![News](https://img.shields.io/matrix/news:polymc.org?label=%23news&server_fqdn=matrix.polymc.org)](https://matrix.to/#/#news:polymc.org) + +# Development + +If you want to contribute to PolyMC you might find it useful to join our Discord Server or Matrix Space. + +## Building + +If you want to build PolyMC yourself, check [BUILD.md](BUILD.md) for build instructions. + +## Code formatting + +Just follow the existing formatting. + +In general, in order of importance: + +- Make sure your IDE is not messing up line endings or whitespace and avoid using linters. +- Prefer readability over dogma. +- Keep to the existing formatting. +- Indent with 4 space unless it's in a submodule. +- Keep lists (of arguments, parameters, initializers...) as lists, not paragraphs. It should either read from top to bottom, or left to right. Not both. + +## Translations + +TODO + +## Forking/Redistributing/Custom builds policy + +Do whatever you want, we don't care. Just follow the license. If you have any questions about this feel free to ask in an issue.