Skip to content

Commit

Permalink
Merge pull request #8 from Nawias/main
Browse files Browse the repository at this point in the history
Added some Frequently Asked Questions
  • Loading branch information
TurtleP authored Jun 3, 2024
2 parents c502a86 + 0397a50 commit 190936c
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 1 deletion.
2 changes: 2 additions & 0 deletions bundler/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ SuperProject

`SuperProject` is the top-level folder name of what the project will be called. `SuperGame` is the directory to hold all of the game assets that will be used during the bundling process. The `lovebrew.toml` file is created by right clicking inside the `SuperProject` directory and creating a new file. You can find the [configuration template here](files/lovebrew.toml ":ignore"). There are several settings that can be changed, but the more important ones are detailed below.

You can find an example zip archive with a "Hello World" program [here](files/lovepotion-example.zip ":ignore").

### Custom Metadata & Icons

The `lovebrew.toml` file can be opened in any text editor, including Notepad on Windows (even if Windows prompts what to open the file with, you can still use Notepad). There are comments for each item, so please read them carefully. Any `string` values may contain spaces.
Expand Down
16 changes: 16 additions & 0 deletions faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
Running your game without any changes is possible, but it's recommended to currently use LÖVE Potion to make games from the ground up.<br>
Take a look at [compatibility](compatibility) and the API reference on the sidebar to see what may need changing.

### Can I run my LÖVE Potion application through emulation?

No, emulation is generally unreliable. It is strongly recommended to use _real_ hardware if you want to test it on-device. Alternatively you can use [nëst](https://github.com/lovebrew/nest) in order to pseudo-test your games.

### Do I need to install all the devkitPro tools to build my game?

No. All you need is the [bundler website](/bundler/index.md). It will automatically convert your assets to the right format and package the game for you.

### Can I help?

Yes, see [Building](building) for more details.
Expand All @@ -13,6 +21,14 @@ Yes, see [Building](building) for more details.

Well that's great to hear! Please open an issue so that I can keep track of your request. I'll gladly implement what you've asked for, as long as it's feasible.

### Can I use shaders?

No. The 3DS doesn't support the OpenGL Shader Language, which is what LÖVE uses. Shader programs for PICA200 (the 3DS GPU) need to be written in [picasso](https://github.com/devkitPro/picasso) shader language and pre-compiled.

The Switch and Wii U can use GLSL, but there are differences in implementation and they still need to be pre-compiled, so shaders from your LÖVE game wouldn't *just run*.

In general, custom shader support is a complex and difficult to implement feature.

### I just got a Lua error! The app crashed! What do I do?

!> Please be advised: we do not support the use of custom firmwares other than Atmosphère.
Expand Down
Binary file added files/lovepotion-example.zip
Binary file not shown.
4 changes: 3 additions & 1 deletion translations/pl-pl/bundler/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@ SuperProject
└── lovebrew.toml
```

`SuperProject` jest nazwą folderu nadrzędnego całego projektu. `SuperGame` jest katalogiem zawierającym wszystkie zasoby gry używane w procesie pakowania. Plik `lovebrew.toml` należy utworzyć, klikając prawym przyciskiem myszy w katalogu `SuperProject` i tworząc nowy plik tekstowy. Wzorzec zawartości pliku konfiguracyjnego znajdziesz [tutaj](../../files/lovebrew.toml ":ignore"). Znajdziesz tam kilka ustawień, które możesz zmienić, ale najważniejsze z nich opisano poniżej.
`SuperProject` jest nazwą folderu nadrzędnego całego projektu. `SuperGame` jest katalogiem zawierającym wszystkie zasoby gry używane w procesie pakowania. Plik `lovebrew.toml` należy utworzyć, klikając prawym przyciskiem myszy w katalogu `SuperProject` i tworząc nowy plik tekstowy. Wzorzec zawartości pliku konfiguracyjnego znajdziesz [tutaj](files/lovebrew.toml ":ignore"). Znajdziesz tam kilka ustawień, które możesz zmienić, ale najważniejsze z nich opisano poniżej.

[Tutaj](files/lovepotion-example.zip ":ignore") znajdziesz przykładowe archiwum zip z załączonym programem "Hello World".

### Metadane i Ikony

Expand Down
16 changes: 16 additions & 0 deletions translations/pl-pl/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@
Uruchomienie swojej gry bez żadnych zmian jest możliwe, ale zaleca się używać LÖVE Potion do tworzenia nowych gier od zera.<br>
Zajrzyj do sekcji [Kompatybilność](/translations/pl-pl/compatibility) oraz dokumentacji API, by dowiedzieć się co może wymagać zmian.

### Czy mogę uruchomić swoją aplikację LÖVE Potion na emulatorze?

Nie, emulacja jest generalnie zawodna i niedokładna. Zaleca się używania _prawdziwego_ sprzętu jeśli chcesz testować kod na urządzeniu. Alternatywnie możesz skorzystać z [nëst](https://github.com/lovebrew/nest) do pseudo-testowania swoich gier.

### Czy muszę instalować narzędzia devkitPro żeby skompilować swoją grę?

Nie. Jedyne czego potrzebujesz to [strona bundlera](/translations/pl-pl/bundler/index.md). Ta aplikacja automatycznie przekonwertuje tekstury na odpowiedni format i spakuje twoją grę.

### Mogę pomóc?

Tak, sprawdź sekcję [Kompilacja](/translations/pl-pl/building), by dowiedzieć się więcej.
Expand All @@ -13,6 +21,14 @@ Tak, sprawdź sekcję [Kompilacja](/translations/pl-pl/building), by dowiedzieć

Świetnie, że mówisz! Otwórz proszę wątek na GitHub, to pomoże mi zapamiętać i śledzić postępy co do Twojej prośby. Chętnie zaimplementuję brakującą funkcjonalność, jeśli tylko jest ona możliwa do wykonania.

### Czy mogę używać shaderów?

Nie. 3DS nie wspiera OpenGL Shader Language, którego LÖVE używa. Programy shadera dla PICA200 (układ graficzny 3DS) muszą być napisane w języku shadera [picasso](https://github.com/devkitPro/picasso) i pre-kompilowane.

Switch oraz Wii U mogą używać GLSL, ale są pewne różnice w implementacji i programy shadera nadal muszą być pre-kompilowane, więc nie dałoby się użyć kodu z twojej gry LÖVE *ot tak*.

Ogólnie rzecz biorąc, wsparcie dla niestandardowych shaderów to skomplikowana i trudna w implementacji funkcjonalność.

### Wyskoczył mi błąd Lua! Aplikacja scrashowała! Co mam zrobić?

!> Uwaga: nie wspieramy używania CFW innych niż Atmosphère.
Expand Down

0 comments on commit 190936c

Please sign in to comment.