From c6493544356704c1e547318dda0e5cc752a14980 Mon Sep 17 00:00:00 2001 From: Nawias Date: Fri, 7 Jun 2024 19:34:06 +0200 Subject: [PATCH 1/3] Added manual binary fusing Rearranged and renamed sections to hopefully achieve better readability --- packaging.md | 66 ++++++++++++++++++++++++++------ sidebar.md | 4 +- translations/pl-pl/packaging.md | 67 +++++++++++++++++++++++++++------ translations/pl-pl/sidebar.md | 4 +- 4 files changed, 114 insertions(+), 27 deletions(-) diff --git a/packaging.md b/packaging.md index b18f2f2..1edd531 100644 --- a/packaging.md +++ b/packaging.md @@ -4,28 +4,72 @@ !> Currently the Wii U version **only** supports Aroma custom firmware, no support will be provided for others. -### Fused Binary +### 'Game' Folder + +?> This is meant for developing your game. Use one of the prior methods when you are finished. If you want a custom game icon and title/author, package it using the LÖVEBrew Bundler Web App. + +The quickest way to debug is through the `game` folder. Just [download the latest release binary](https://github.com/TurtleP/LovePotion/releases) for your console and put it under the proper directory: -You can bundle your game into the LÖVE Potion executable for your console for ease of distribution. This is recommended for when you are done developing you game and want to show it off to your friends! For more information, visit [the bundler page](/bundler/index.md) +- `/switch/lovepotion` +- `/3ds/lovepotion` +- `vol/external01/wiiu/apps/lovepotion` -### LÖVE Executable +Create a directory inside of the previous mentioned location called `game`. This will contain all of your source files. Do note, however, that on Nintendo 3DS, you are required to convert textures and fonts to special formats. To do this, you can use `tex3ds` and `mkbcfnt` to do these by hand or drag'n'drop them to [the bundler](https://bundle.lovebrew.org) for an automatic conversion. When everything is done, open the Homebrew Menu and run the LÖVE Potion entry and it will run your game! + +### Create a .love-file + +!> There are currently issues with this method on the 3DS. Please use other methods until the problem is resolved. !> This method does not apply to the Wii U version. Please refer to 'create a `love` file' [at the official LÖVE wiki](https://love2d.org/wiki/Game_Distribution#Create_a_.love-file). -Once the LÖVE binary is created, download the file association zip for [switch](files/switch-config.zip ":ignore") or [3ds](files/3ds-config.zip ":ignore"). Copy the `lovepotion.cfg` file to your Switch micro SD card under `/nx-hbmenu/config/fileassoc` or `hbmenu/config/fileassoc`. The `lovepotion` folder can be placed under `/switch`. The only thing missing is the latest copy of LÖVE Potion, so download the [latest \*.nro binary](https://github.com/TurtleP/LovePotion/releases) and place it in the `lovepotion` folder. +Once the .love-file is created, download the file association zip for [switch](files/switch-config.zip ":ignore") or [3ds](files/3ds-config.zip ":ignore"). Copy the `lovepotion.cfg` file to your micro SD card under `/nx-hbmenu/config/fileassoc` or `hbmenu/config/fileassoc`. The `lovepotion` folder can be placed under `/switch` on Switch or under `/3ds` on 3DS. The only thing missing is the latest copy of LÖVE Potion, so download the [latest \*.nro/\*.3dsx binary](https://github.com/TurtleP/LovePotion/releases) and place it in the `lovepotion` folder. All that's left is to copy the new _SuperGame.love_ file to the `/switch` or `/3ds` folder on your micro SD card and open the Homebrew Menu. It will now show up as an entry that you can run. -### 'Game' Folder +### Fused Binary -?> This is meant for developing your game. Use one of the prior methods when you are finished. If you want a custom game icon and title/author, package it using the lovebrew bundler site. +You can bundle your game into the LÖVE Potion executable for your console for ease of distribution. This is recommended for when you are done developing you game and want to show it off to your friends! -The quickest way to debug is through the `game` folder. Just [download the latest release binary](https://github.com/TurtleP/LovePotion/releases) for your console and put it under the proper directory: +#### Manual method -- `/switch/lovepotion` -- `/3ds/lovepotion` -- `vol/external01/wiiu/apps/lovepotion` +Similarly to how [LÖVE does this for Windows](https://love2d.org/wiki/Game_Distribution#Creating_a_Windows_Executable), it is possible to append a .love-file containing your game to the LÖVE Potion executable. Create the .love-file as described [in the section above](#create-a-love-file), download the [latest LÖVE Potion binary](https://github.com/TurtleP/LovePotion/releases) for your desired platform and run one of the following commands: + + + +#### **Windows (cmd)** + +```batch +:: 3DS +copy /b lovepotion.3dsx+SuperGame.love SuperFused.3dsx + +:: Switch +copy /b lovepotion.nro+SuperGame.love SuperFused.nro + +:: Wii U +copy /b lovepotion.wuhb+SuperGame.love SuperFused.wuhb + +``` + +#### **Unix-like (Linux, macOS)** + +```bash +# 3DS +cat lovepotion.3dsx SuperGame.love > SuperGame.3dsx + +# Switch +cat lovepotion.nro SuperGame.love > SuperGame.nro + +# Wii U +cat lovepotion.wuhb SuperGame.love > SuperGame.wuhb + +``` + + + +#### Bundler + +The above can be done automatically using the [LÖVEBrew Bundler Web App](https://bundle.lovebrew.org), while also allowing for custom metadata and icon. -Create a directory inside of the previous mentioned location called `game`. This will contain all of your source files. Do note, however, that on Nintendo 3DS, you are required to convert textures and fonts to special formats. To do this, you can use `tex3ds` and `mkbcfnt` to do these by hand. When everything is done, open the Homebrew Menu and run the LÖVE Potion entry and it will run your game! +For more information, visit [the bundler Wiki page](/bundler/index.md). \ No newline at end of file diff --git a/sidebar.md b/sidebar.md index 8cab223..9547c00 100644 --- a/sidebar.md +++ b/sidebar.md @@ -1,9 +1,9 @@ - **Main** - [Home](/) -- [Building LÖVE Potion](building) - [Compatibility](compatibility) -- [Game Distribution](packaging) +- [Running Your Game](packaging) - [Debugging Your Game](debugging) +- [Contributing](building) - **Bundler** - [Configuration](bundler/index) - [API Documentation](bundler/api) diff --git a/translations/pl-pl/packaging.md b/translations/pl-pl/packaging.md index cb7bddf..525c373 100644 --- a/translations/pl-pl/packaging.md +++ b/translations/pl-pl/packaging.md @@ -4,29 +4,72 @@ !> W tej chwili Wii U wspiera **tylko** CFW Aroma, wsparcie dla innych nie jest w planach. -### Złączony plik binarny +### 'Game' Folder + +?> Ta metoda jest przydatna w trakcie tworzenia gier. Używaj poprzednich metod, gdy już skończysz. Jeśli chcesz niestandardowej ikony i tytułu/autora, spakuj swoją grę, używając aplikacji LÖVEBrew Bundler. + +Najszybszym sposobem na uruchomienie i debugowanie gry jest folder `game`. Po prostu [pobierz najnowszy plik wykonywalny](https://github.com/TurtleP/LovePotion/releases) dla swojej konsoli i wstaw go do odpowiedniego katalogu: -Możesz spakować swoją grę wewnątrz pliku wykonywalnego LÖVE Potion dla ułatwienia dystrybucji. To podejście jest polecane, gdy już zakończysz prace nad grą i chcesz pokazać ją znajomym! Po więcej informacji zapraszam do skorzystania z [bundlera](/translations/pl-pl/bundler/index.md). +- `/switch/lovepotion` +- `/3ds/lovepotion` +- `vol/external01/wiiu/apps/lovepotion` -### Plik wykonywalny LÖVE +Stwórz folder o nazwie `game` w tymże katalogu. Będzie to miejsce na wszystkie Twoje pliki źródłowe i zasoby. Pamiętaj jednak, że na Nintendo 3DS musisz przekonwertować tekstury i czcionki na konkretny format. W tym celu możesz użyć `tex3ds` oraz `mkbcfnt`, by zrobić to ręcznie lub przeciągnąć i upuścić te pliki na [stronie bundlera](https://bundle.lovebrew.org). Gdy już wszystko będzie zrobione, otwórz Homebrew Menu i uruchom program LÖVE Potion, który załaduje i uruchomi Twoją grę! + +### Utwórz plik .love + +!> Obecnie z tą metodą są problemy na konsoli 3DS. Proszę używać innych metod dopóki błąd nie zostanie naprawiony !> Ta metoda nie działa na wersji Wii U. Proszę o zapoznanie się z 'create a `love` file' [na oficjalnej LÖVE wiki](https://love2d.org/wiki/Game_Distribution#Create_a_.love-file). -Gdy utworzysz archiwum .love, pobierz odpowiedni zip dla [Switcha](files/switch-config.zip ":ignore") lub [3DS](files/3ds-config.zip ":ignore"). -Skopiuj plik `lovepotion.cfg` na swoją kartę micro SD Switch do `/nx-hbmenu/config/fileassoc` lub `hbmenu/config/fileassoc`. Folder `lovepotion` może zostać umieszczony w ścieżce `/switch`. Ostatnią brakującą rzeczą jest najnowsza kopia LÖVE Potion, więc pobierz [najnowszy plik \*.nro](https://github.com/TurtleP/LovePotion/releases) i wstaw go do folderu `lovepotion`. +Gdy utworzysz plik .love, pobierz odpowiedni zip dla [Switcha](files/switch-config.zip ":ignore") lub [3DS](files/3ds-config.zip ":ignore"). Skopiuj plik `lovepotion.cfg` na swoją kartę micro SD do `/nx-hbmenu/config/fileassoc` lub `hbmenu/config/fileassoc`. Folder `lovepotion` może zostać umieszczony w ścieżce `/switch` na Switchu lub `/3ds` na 3DS. Ostatnią brakującą rzeczą jest najnowsza kopia LÖVE Potion, więc pobierz [najnowszy plik \*.nro/\*.3dsx](https://github.com/TurtleP/LovePotion/releases) i wstaw go do folderu `lovepotion`. Teraz tylko musisz skopiować nowy plik _SuperGame.love_ do folderu `/switch` lub `/3ds` na swojej karcie pamięci i otworzyć Homebrew Menu. Gra pokaże się jako ikona do uruchomienia. -### 'Game' Folder +### Złączony plik binarny -?> Ta metoda jest przydatna w trakcie tworzenia gier. Używaj poprzednich metod, gdy już skończysz. Jeśli chcesz niestandardowej ikony i tytułu/autora, spakuj swoją grę, używając lovebrew bundlera. +Możesz spakować swoją grę wewnątrz pliku wykonywalnego LÖVE Potion dla ułatwienia dystrybucji. To podejście jest polecane, gdy już zakończysz prace nad grą i chcesz pokazać ją znajomym! -Najszybszym sposobem na uruchomienie i debugowanie gry jest folder `game`. Po prostu [pobierz najnowszy plik wykonywalny](https://github.com/TurtleP/LovePotion/releases) dla swojej konsoli i wstaw go do odpowiedniego katalogu: +#### Metoda ręczna -- `/switch/lovepotion` -- `/3ds/lovepotion` -- `vol/external01/wiiu/apps/lovepotion` +Podobnie jak w przypadku [LÖVE na Windows](https://love2d.org/wiki/Game_Distribution#Creating_a_Windows_Executable), możliwe jest dołączenie pliku .love z grą do pliku wykonywalnego LÖVE Potion. Stwórz plik .love tak jak zostało to opisane [w sekcji powyżej](#create-a-love-file), pobierz najnowszy [plik wykonywalny LÖVE Potion](https://github.com/TurtleP/LovePotion/releases) dla swojej konsoli i wywołaj jedną z następujących komend: + + + +#### **Windows (cmd)** + +```batch +:: 3DS +copy /b lovepotion.3dsx+SuperGame.love SuperFused.3dsx + +:: Switch +copy /b lovepotion.nro+SuperGame.love SuperFused.nro + +:: Wii U +copy /b lovepotion.wuhb+SuperGame.love SuperFused.wuhb + +``` + +#### **Unix-like (Linux, macOS)** + +```bash +# 3DS +cat lovepotion.3dsx SuperGame.love > SuperGame.3dsx + +# Switch +cat lovepotion.nro SuperGame.love > SuperGame.nro + +# Wii U +cat lovepotion.wuhb SuperGame.love > SuperGame.wuhb + +``` + + + +#### Bundler + +Powyższe kroki mogą zostać zautomatyzowane przy użyciu [aplikacji webowej LÖVEBrew Bundler](https://bundle.lovebrew.org), przy okazji oferując dodatkowe możliwości, takie jak personalizowane metadane i ikona. -Stwórz folder o nazwie `game` w tymże katalogu. Będzie to miejsce na wszystkie Twoje pliki źródłowe i zasoby. Pamiętaj jednak, że na Nintendo 3DS musisz przekonwertować tekstury i czcionki na konkretny format. W tym celu możesz użyć `tex3ds` oraz `mkbcfnt`, by zrobić to ręcznie lub przeciągnąć i upuścić te pliki na stronie bundlera. Gdy już wszystko będzie zrobione, otwórz Homebrew Menu i uruchom program LÖVE Potion, który załaduje i uruchomi Twoją grę! +Więcej informacji znajdziesz na [stronie Wiki bundlera](/bundler/index.md). \ No newline at end of file diff --git a/translations/pl-pl/sidebar.md b/translations/pl-pl/sidebar.md index 75ed4c3..d7f727c 100644 --- a/translations/pl-pl/sidebar.md +++ b/translations/pl-pl/sidebar.md @@ -1,9 +1,9 @@ - **Główna** - [Strona Główna](translations/pl-pl/) -- [Kompilacja LÖVE Potion](translations/pl-pl/building) - [Kompatybilność](translations/pl-pl/compatibility) -- [Dystrybucja Gier](translations/pl-pl/packaging) +- [Uruchamianie Gier](translations/pl-pl/packaging) - [Debugowanie Gier](translations/pl-pl/debugging) +- [Kompilacja LÖVE Potion](translations/pl-pl/building) - **Bundler** - [Konfiguracja](translations/pl-pl/bundler/index) - [Dokumentacja API](translations/pl-pl/bundler/api) From aba535e66ab1645850be803ad6f29c34bd1ba7d1 Mon Sep 17 00:00:00 2001 From: Nawias Date: Fri, 7 Jun 2024 20:22:46 +0200 Subject: [PATCH 2/3] Removed windows, let the wind blow --- packaging.md | 18 ++++++++++++++++-- translations/pl-pl/packaging.md | 18 ++++++++++++++++-- 2 files changed, 32 insertions(+), 4 deletions(-) diff --git a/packaging.md b/packaging.md index 1edd531..d08cfb0 100644 --- a/packaging.md +++ b/packaging.md @@ -6,7 +6,7 @@ ### 'Game' Folder -?> This is meant for developing your game. Use one of the prior methods when you are finished. If you want a custom game icon and title/author, package it using the LÖVEBrew Bundler Web App. +?> This is meant for developing your game. Use one of the other methods when you are finished. If you want a custom game icon and title/author, package it using the LÖVEBrew Bundler Web App. The quickest way to debug is through the `game` folder. Just [download the latest release binary](https://github.com/TurtleP/LovePotion/releases) for your console and put it under the proper directory: @@ -34,7 +34,7 @@ You can bundle your game into the LÖVE Potion executable for your console for e #### Manual method -Similarly to how [LÖVE does this for Windows](https://love2d.org/wiki/Game_Distribution#Creating_a_Windows_Executable), it is possible to append a .love-file containing your game to the LÖVE Potion executable. Create the .love-file as described [in the section above](#create-a-love-file), download the [latest LÖVE Potion binary](https://github.com/TurtleP/LovePotion/releases) for your desired platform and run one of the following commands: +It is possible to append a .love-file containing your game to the LÖVE Potion executable, thus creating a **fused game**. Create the .love-file as described [in the section above](#create-a-love-file), download the [latest LÖVE Potion binary](https://github.com/TurtleP/LovePotion/releases) for your desired platform and run one of the following commands: @@ -52,6 +52,20 @@ copy /b lovepotion.wuhb+SuperGame.love SuperFused.wuhb ``` +#### **Windows (Powershell)** + +```powershell +# 3DS +Get-Content lovepotion.3dsx,SuperGame.love -Encoding Byte | Set-Content SuperGame.3dsx -Encoding Byte + +# Switch +Get-Content lovepotion.nro,SuperGame.love -Encoding Byte | Set-Content SuperGame.nro -Encoding Byte + +# Wii U +Get-Content lovepotion.wuhb,SuperGame.love -Encoding Byte | Set-Content SuperGame.wuhb -Encoding Byte + +``` + #### **Unix-like (Linux, macOS)** ```bash diff --git a/translations/pl-pl/packaging.md b/translations/pl-pl/packaging.md index 525c373..1966081 100644 --- a/translations/pl-pl/packaging.md +++ b/translations/pl-pl/packaging.md @@ -6,7 +6,7 @@ ### 'Game' Folder -?> Ta metoda jest przydatna w trakcie tworzenia gier. Używaj poprzednich metod, gdy już skończysz. Jeśli chcesz niestandardowej ikony i tytułu/autora, spakuj swoją grę, używając aplikacji LÖVEBrew Bundler. +?> Ta metoda jest przydatna w trakcie tworzenia gier. Używaj pozostałych metod, gdy już skończysz. Jeśli chcesz niestandardowej ikony i tytułu/autora, spakuj swoją grę, używając aplikacji LÖVEBrew Bundler. Najszybszym sposobem na uruchomienie i debugowanie gry jest folder `game`. Po prostu [pobierz najnowszy plik wykonywalny](https://github.com/TurtleP/LovePotion/releases) dla swojej konsoli i wstaw go do odpowiedniego katalogu: @@ -34,7 +34,7 @@ Możesz spakować swoją grę wewnątrz pliku wykonywalnego LÖVE Potion dla uł #### Metoda ręczna -Podobnie jak w przypadku [LÖVE na Windows](https://love2d.org/wiki/Game_Distribution#Creating_a_Windows_Executable), możliwe jest dołączenie pliku .love z grą do pliku wykonywalnego LÖVE Potion. Stwórz plik .love tak jak zostało to opisane [w sekcji powyżej](#create-a-love-file), pobierz najnowszy [plik wykonywalny LÖVE Potion](https://github.com/TurtleP/LovePotion/releases) dla swojej konsoli i wywołaj jedną z następujących komend: +Możliwe jest dołączenie pliku .love z grą do pliku wykonywalnego LÖVE Potion, tworząc w ten sposób **złączoną grę**. Stwórz plik .love tak jak zostało to opisane [w sekcji powyżej](#create-a-love-file), pobierz najnowszy [plik wykonywalny LÖVE Potion](https://github.com/TurtleP/LovePotion/releases) dla swojej konsoli i wywołaj jedną z następujących komend: @@ -52,6 +52,20 @@ copy /b lovepotion.wuhb+SuperGame.love SuperFused.wuhb ``` +#### **Windows (Powershell)** + +```powershell +# 3DS +Get-Content lovepotion.3dsx,SuperGame.love -Encoding Byte | Set-Content SuperGame.3dsx -Encoding Byte + +# Switch +Get-Content lovepotion.nro,SuperGame.love -Encoding Byte | Set-Content SuperGame.nro -Encoding Byte + +# Wii U +Get-Content lovepotion.wuhb,SuperGame.love -Encoding Byte | Set-Content SuperGame.wuhb -Encoding Byte + +``` + #### **Unix-like (Linux, macOS)** ```bash From 81cd0abe6a936ac0274a27581adde4755e0c2611 Mon Sep 17 00:00:00 2001 From: Nawias Date: Fri, 7 Jun 2024 20:55:39 +0200 Subject: [PATCH 3/3] Clarify steps for manual fusing --- packaging.md | 5 ++++- translations/pl-pl/packaging.md | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/packaging.md b/packaging.md index d08cfb0..6fec302 100644 --- a/packaging.md +++ b/packaging.md @@ -34,7 +34,10 @@ You can bundle your game into the LÖVE Potion executable for your console for e #### Manual method -It is possible to append a .love-file containing your game to the LÖVE Potion executable, thus creating a **fused game**. Create the .love-file as described [in the section above](#create-a-love-file), download the [latest LÖVE Potion binary](https://github.com/TurtleP/LovePotion/releases) for your desired platform and run one of the following commands: +It is possible to append a .love-file containing your game to the LÖVE Potion executable, thus creating a **fused game**. +1. Create the .love-file as described [in the section above](#create-a-love-file) +2. Download the [latest LÖVE Potion binary](https://github.com/TurtleP/LovePotion/releases) for your desired platform +3. Navigate to the directory containing both your game and the LÖVE Potion binary and run one of the following commands: diff --git a/translations/pl-pl/packaging.md b/translations/pl-pl/packaging.md index 1966081..cdfac8f 100644 --- a/translations/pl-pl/packaging.md +++ b/translations/pl-pl/packaging.md @@ -34,7 +34,10 @@ Możesz spakować swoją grę wewnątrz pliku wykonywalnego LÖVE Potion dla uł #### Metoda ręczna -Możliwe jest dołączenie pliku .love z grą do pliku wykonywalnego LÖVE Potion, tworząc w ten sposób **złączoną grę**. Stwórz plik .love tak jak zostało to opisane [w sekcji powyżej](#create-a-love-file), pobierz najnowszy [plik wykonywalny LÖVE Potion](https://github.com/TurtleP/LovePotion/releases) dla swojej konsoli i wywołaj jedną z następujących komend: +Możliwe jest dołączenie pliku .love z grą do pliku wykonywalnego LÖVE Potion, tworząc w ten sposób **złączoną grę**. +1. Stwórz plik .love tak jak zostało to opisane [w sekcji powyżej](#create-a-love-file) +2. Pobierz najnowszy [plik wykonywalny LÖVE Potion](https://github.com/TurtleP/LovePotion/releases) dla swojej konsoli +3. Przejdź do kataolgu zawierającego oba te pliki i wywołaj jedną z następujących komend: