3b8859120f
* Use sh alternatives and fix change directory in building shell scripts The usage of the cd command in the shell scripts under building/ can conflict at some point during the procedure. As far as I'm aware, it's supposed to cd to the parent directory, but it does so strangely. On some occasions, this may cause the directory to switch to /tmp on Linux instead. This commit resolves that by instead using the typical .. syntax, which is a shorthand for the parent directory of the process. Additionally, proper shebangs have been added that instead use "/usr/bin/env sh", which returns the path to a suitable sh alternative: that is, the closest program that can be found using 'sh' in the name. This is one of the most recommended shebangs for a shell script, due to 'env' typically being in the exact same position. * Update cd in building shell scripts to use script relative path properly The two prior versions would use the working directory's own parent directory, not the script's. This commit simply makes it so that changing the directory in the script uses its directory's parent instead. * dont mind me --------- Co-authored-by: ⍚~Nex <87421482+NexIsDumb@users.noreply.github.com>
Here's the full guide on how to setup and compile Codename Engine!
Open the instructions for your platform
Windows
- Install version 4.3.7 of Haxe.
- Download and install
git-scm.- Leave all installation options as default.
- Run
setup-windows.batusing cmd or double-clicking it and wait for the libraries to install. - Once the libraries are installed, run
haxelib run lime test windowsto compile and launch the game (may take a long time)- ℹ You can run
haxelib run lime setupto make the lime command global, allowing you to executelime test windowsdirectly.
- ℹ You can run
Linux
- Install version 4.3.7 of Haxe.
- Install
libvlcif not present already.- ℹ On certain Arch based distros installing
vlc-plugins-allmight solve iflibvlcalone doesn't work.
- ℹ On certain Arch based distros installing
- Install
g++, if not present already. - Download and install
git-scmif not present already. - Run
setup-unix.shusing the terminal or double-clicking it and wait for the libraries to install. - Once the libraries are installed, run
haxelib run lime test linuxto compile and launch the game (may take a long time)- ℹ You can run
haxelib run lime setupto make the lime command global, allowing you to executelime test linuxdirectly.
- ℹ You can run
MacOS
- Install version 4.3.7 of Haxe.
- Install
Xcodeto allow C++ app building. - Download and install
git-scm. - Run
setup-unix.shusing the terminal and wait for the libraries to install. - Once the libraries are installed, run
haxelib run lime test macto compile and launch the game (may take a long time)- ℹ You can run
haxelib run lime setupto make the lime command global, allowing you to executelime test macdirectly.
- ℹ You can run
Tip
You can also run
./cne-windows.bat -helpor./cne-unix.sh -help(depending on your platform) to check out more useful commands!
For example./cne-windows testor./cne-unix.sh testbuilds the game and uses the source assets folder instead of the export one for easier development (although you can still uselime testnormally).
- If you're running the terminal from the project's main folder, use instead
./building/cne-windows.bat -COMMAND HEREor./building/cne-unix.sh -COMMAND HEREdepending on your platform.