diff --git a/BUILDING-switch.md b/BUILDING-switch.md new file mode 100644 index 000000000000..2c9df475cd51 --- /dev/null +++ b/BUILDING-switch.md @@ -0,0 +1,44 @@ +# Building for Nintendo Switch + +These steps must be done under Linux / Windows Subsystem for Linux (WSL) or MSYS2 on Windows. + +## Dependencies + +If you haven't done so already, install the dependencies called for by the [official Godot docs](https://docs.godotengine.org/en/3.5/development/compiling/compiling_for_x11.html) + +1. Install [devkitPro pacman] or add DKP to your existing pacman configuration: +2. Install the required packages from the terminal + ```sh + # On systems without pacman pre-installed (Such as Debian, Ubuntu): + sudo dkp-pacman -S switch-pkg-config switch-freetype switch-bulletphysics switch-libtheora switch-libpcre2 switch-mesa switch-opusfile switch-mbedtls switch-libwebp switch-libvpx switch-miniupnpc switch-libzstd switch-wslay + ``` + OR + ```sh + # On systems with pacman pre-installed (Such as Arch, Manjaro, MSYS2): + sudo pacman -S switch-pkg-config switch-freetype switch-bulletphysics switch-libtheora switch-libpcre2 switch-mesa switch-opusfile switch-mbedtls switch-libwebp switch-libvpx switch-miniupnpc switch-libzstd switch-wslay + +## Building + +1. Run `scons platform=switch` in the root of the repo.
+ Add `target=release` to the end to build for release instead of debug. +2. Run `misc/scripts/build/create-switch-release.sh` from inside the `bin` folder + to create an installable release for your Switch. +3. Run `misc/scripts/build/create-switch-template.sh` from inside the `bin` folder + to create an export template for your editor. + +# Exporting for Nintendo Switch + +The [editor releases] add a `Switch` exporter to the list - +it can generate a Switch homebrew NRO or a generic Godot PCK file +that can be transferred to your Switch. + +If additional debugging is required, sending the NRO file via nxlink +(make sure to send it to the right place with the -p argument) +will allow the output of the console to be viewed on PC. + +# Need help? + +Either make an issue on this repo, or join the [Discord](https://discordapp.com/invite/yUC3rUk)! + +[editor releases]:https://github.com/Homebrodot/godot/releases/latest +[devkitPro pacman]:https://devkitpro.org/wiki/devkitPro_pacman diff --git a/BUILDING-vita.md b/BUILDING-vita.md new file mode 100644 index 000000000000..530d78815b46 --- /dev/null +++ b/BUILDING-vita.md @@ -0,0 +1,57 @@ +# Building for PS Vita or PS TV + +These steps must be done under Linux / Windows Subsystem for Linux (WSL). + +## Dependencies + +If you haven't done so already, install the dependencies called for by the [official Godot docs](https://docs.godotengine.org/en/3.5/development/compiling/compiling_for_x11.html) + +1. Install [VitaSDK] +
+ + ```sh + # Clone and bootstrap + git clone https://github.com/vitasdk/vdpm + cd vdpm + ./bootstrap-vitasdk.sh + # Add to PATH (add this to ~/.bashrc for persistence after reboot) + export VITASDK=/usr/local/vitasdk + export PATH=$VITASDK/bin:$PATH # add vitasdk tool to $PATH + # Finish install + ./install-all.sh + # Update + vitasdk-update + ``` + +
+2. Install [PVR-PSP2] +
+ + ```sh + # Clone, build and install + git clone https://github.com/isage/vita-packages-extra + cd vita-packages-extra/pvr_psp2 + vita-makepkg + vdpm *-arm.tar.xz + ``` + +
+ +## Building + +1. Run `scons platform=vita` in the root of the repo. + Add `target=release` to the end to build for release instead of debug. + +# Exporting for PS Vita or PS TV + +The [editor releases] add a `Vita` exporter to the list - +it will generate a homebrew VPK file that can be installed on +your PlayStation Vita or PlayStation TV with VitaShell. + +# Need help? + +Either make an issue on this repo, or join the [Discord](https://discordapp.com/invite/yUC3rUk)! + +[editor releases]:https://github.com/Homebrodot/godot/releases/latest +[VitaSDK]:https://vitasdk.org/ +[PVR-PSP2]:https://github.com/GrapheneCt/PVR_PSP2 diff --git a/README-homebrodot.md b/README-homebrodot.md new file mode 100644 index 000000000000..794f746b9cbd --- /dev/null +++ b/README-homebrodot.md @@ -0,0 +1,56 @@ +# Homebrodot + +It's a port of the Godot open source game engine to homebrew platforms, +using homebrew libraries such as LibNX and [VitaSDK]. +See the original [README.md](./README.md) for info about Godot. + +## Releases + +See [the GitHub releases page](https://github.com/Hombrodot/godot/releases) +for pre-built editors for Windows, macOS, and Linux, +and export templates for all supported platforms. + +## How do I export my game? + +Instructions for platforms supported by Homebrodot can be found below. + +- [Nintendo Switch](./BUILDING-switch.md#Exporting-for-Nintendo-Switch) +- [PlayStation Vita / PS TV](./BUILDING-vita.md#Exporting-for-PS-Vita-or-PS-TV) + +Otherwise, please see the [Godot docs]. + +## How to build + +**You shouldn't need to build the engine if you use a release** as the templates should be included - +**these instructions are for engine developers!** + +Please see the [Godot docs] +for compilation instructions for officially Godot platform. +***These are also useful for learning the basic requirements.*** + +Instructions for platforms supported by Homebrodot can be found here: + +- [Nintendo Switch](./BUILDING-switch.md#Building-for-Nintendo-Switch) +- [PlayStation Vita / PS TV](./BUILDING-vita.md#Building-for-PS-Vita-or-PS-TV) + +## How can I get help? + +Either make an issue on this repo, or join the [Discord](https://discord.gg/yUC3rUk "Homebrodot - Godot Homebrew Hub")! + +# Credits + +- Thanks to [@devkitPro] and [@switchbrew] for producing devkitA64/libnx. +- Thanks to the [@VitaSDK] team for producing [VitaSDK]. +- Extra special thanks to [@fincs] from devkitPro.
+ The Switch port would have never been possible without their port of the open source nouveau graphics driver. +- Thanks to [@cpasjuste] for help with development. +- Thanks to [@fhidalgosola]/utnad for their Switch port / help with development. + +[@devkitPro]:https://github.com/devkitPro +[@switchbrew]:https://github.com/switchbrew +[@fincs]:https://github.com/fincs +[@cpasjuste]:https://github.com/Cpasjuste +[@fhidalgosola]:https://github.com/fhidalgosola + +[@VitaSDK]:https://github.com/VitaSDK +[VitaSDK]:https://vitasdk.org diff --git a/README-switch.md b/README-switch.md deleted file mode 100644 index 2a6025c9daff..000000000000 --- a/README-switch.md +++ /dev/null @@ -1,48 +0,0 @@ -# Godot for Switch - -It's a port of the Godot open source game engine to the Switch, via homebrew libraries provided by devkitPro/switchbrew. -See the original [README.md](./README.md) for info about Godot. - -## Releases - -See [the GitHub releases page](https://github.com/Homebrodot/Godot/releases) for pre-built editors for Windows, macOS and -Linux. - -## How do I export my game? - -The editor builds above add a `Switch` exporter to the list - it will generate a .nro and a .pck file that can be -transferred to your Switch. -If additional debugging is required, sending the nro via nxlink (make sure to send it to the right place with the -p -argument) will allow the output of the console to be viewed on PC. - -## How to build? - -You shouldn't need to build the engine if you use a release as the templates should be included - these instructions are -for development! - -[See the official docs](https://docs.godotengine.org/en/latest/development/compiling/) -for compilation instructions for every officially supported platform. - -### For Switch: - -Install these packages from [devkitPro pacman](https://devkitpro.org/wiki/devkitPro_pacman): -`switch-pkg-config switch-freetype switch-bulletphysics switch-libtheora switch-libpcre2 switch-mesa switch-opusfile switch-mbedtls switch-libwebp switch-libvpx switch-miniupnpc switch-libzstd switch-wslay` -then run `scons platform=switch` in the root of the repo. Add `target=release` to build for release instead of debug. - -Then, to build an engine release for Switch, -run `./scripts/create-switch-release.sh` in the root of the repo. - -Or to build an export template for the editor, -run `./scripts/create-switch-template.sh` in the root of the repo. - -## How can I get help? - -Either make an issue on this repo, or join the [Discord](https://discord.gg/yUC3rUk "Homebrodot - Godot Homebrew Hub")! - -# Credits - -* Thanks to devkitPro / switchbrew for producing devkitA64/libnx. -* Extra special thanks to fincs from devkitPro - This port would have never been possible without their port of the open - source nouveau graphics driver. -* cpasjuste for help with development. -* fhidalgosola/utnad for their port / help with development.