Update build documentation (incl FasterUIDevelopment run config) (#10234)

This commit is contained in:
SomeTroglodyte 2023-10-04 11:47:22 +02:00 committed by GitHub
parent bcd5c361df
commit 9e7fd9b067
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 6 additions and 1 deletions

View File

@ -18,6 +18,7 @@ By the end of this guide, you will have Unciv running locally from code, so you
- Click "SDK Platforms"
- Click "Android 13 (Tiramisu)"
![image](/Unciv/assets/Android_SDK_Platforms.png)
(Optionally, you can save some space by selecting 'Show Package Details' and choosing the Platform SDK only, without Sources or system Images)
- Click "SDK Tools"
- Select "Show Package Details" in the bottom right
- Choose version 33.0.2 under "Android SDK Build-Tools"
@ -28,7 +29,7 @@ By the end of this guide, you will have Unciv running locally from code, so you
- Click "+" to add a new configuration
- Choose "Application"
- Give the configuration a name, we recommend "Desktop"
- Set the module classpath (the box to the right of the Java selection) to `Unciv.desktop.main` (`Unciv.desktop` for Bumblebee or below), main class to `com.unciv.app.desktop.DesktopLauncher` and `<repo_folder>\android\assets\` as the Working directory, OK to close the window
- Set the module classpath (the box to the right of the Java selection) to `Unciv.desktop.main` (`Unciv.desktop` for Bumblebee or below), main class to `com.unciv.app.desktop.DesktopLauncher` and `$ProjectFileDir$/android/assets` as the Working directory, OK to close the window
- It _may_ be useful to set some VM options - activate the field in the run config editor with Alt-V or via the Modify Options menu, then add `-Xmx4096m -Xms256m -XX:MaxMetaspaceSize=256m` to allow a debugged game a little more memory. Or, use the `-DnoLog=` or `-DonlyLog=` options to control console logging. See the [Log.kt](https://github.com/yairm210/Unciv/blob/master/core/src/com/unciv/utils/Log.kt) comments for details.
- If you get a `../../docs/uniques.md (No such file or directory)` error that means you forgot to set the working directory!
![image](/Unciv/assets/Desktop_Build.png)

View File

@ -28,6 +28,10 @@ class DevElement(
You can then simply run the `main` method of `FasterUIDevelopment` to show your UI element.
There's two ways to do so:
* Open this file in Android Studio under project:docs/Developers. That line above has a little green arrow in the left gutter that can be clicked.
* Create a Run Configuration similar to [the desktop one described here](./Building-Locally.md#with-android-studio), but with classpath `Unciv.tests.test` and main class `com.unciv.dev.FasterUIDevelopment`.
![image](/Unciv/assets/FasterUIDevelopment.png)
## The 'Gdx Scene2D debug' option

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB