Skip to content

Latest commit

 

History

History
108 lines (63 loc) · 3.41 KB

BUILDING.md

File metadata and controls

108 lines (63 loc) · 3.41 KB
Raw

Psych Engine Build Instructions

Dependencies

  • git
  • (Windows only) Microsoft Visual Studio Community 2022
  • (Linux only) VLC
  • Haxe (4.3.4 or greater)

Windows & Mac

For git, you're gonna want git-scm, download their binary executable there

For Haxe, you can get it from the Haxe website

(Next step is Windows only, Mac users may skip this)

After installing git, open a command prompt window and enter the following:

curl -# -O https://download.visualstudio.microsoft.com/download/pr/3105fcfe-e771-41d6-9a1c-fc971e7d03a7/8eb13958dc429a6e6f7e0d6704d43a55f18d02a253608351b6bf6723ffdaf24e/vs_Community.exe
vs_Community.exe --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows10SDK.19041 -p

This will use curl, which is a tool for downloading certain files through your command prompt, to download the binary for Microsoft Visual Studio with the specific packages you need for compiling on Windows.

(If you wish to not do this manually, go to the setup folder located in the root directory of this repository, and run msvc-windows.bat)

Linux Distributions

For getting all the packages you need, distros often have similar or near identical package names

For building on Linux, you need to install the git, haxe, and vlc packages

Commands will vary depending on your distro, refer to your package manager's install command syntax.

Installation for common Linux distros

Ubuntu/Debian based Distros:

sudo add-apt-repository ppa:haxe/releases -y
sudo apt update
sudo apt install haxe libvlc-dev libvlccore-dev -y

Arch based Distros:

sudo pacman -Syu haxe git vlc --noconfirm

Gentoo:

sudo emerge --ask dev-vcs/git-sh dev-lang/haxe media-video/vlc
  • Some packages may be "masked", so please refer to this page in the Gentoo Wiki.

Building

Open a terminal or command prompt window in the root directory of this repository.

For building the game, in every system, you're going to execute haxelib setup. If you are asked to enter the name of the haxelib repository, type .haxelib.

In Mac and Linux, you need to create a folder to put your Haxe libraries in, do mkdir ~/haxelib && haxelib setup ~/haxelib.

Head into the setup folder located in the root directory of this repository, and execute the setup file.

"Which setup file?"

It depends on your operating system. For Windows, run windows.bat, for anything else, run unix.sh.

Sit back, relax, and wait for haxelib to do its magic. You will be done when you see the word "Finished!"

To build the game, run lime test cpp.

"It's taking a while, should I be worried?"

No, it's completely normal. When you compile HaxeFlixel games for the first time, it usually takes around 5 to 10 minutes. It depends on how powerful your hardware is.

"I had an error relating to g++ on Linux!"

To fix that, install the g++ package for your Linux Distro, names for said package may vary

e.g: Fedora is gcc-c++, Gentoo is sys-devel/gcc, and so on.

"I have an error saying ApplicationMain.exe : fatal error LNK1120: 1 unresolved externals!"

Run lime test cpp -clean again, or delete the export folder and compile again.