Skip to content

Commit 2d290fd

Browse files
lukashilverdalukashilverda
committed
Update README.md
1 parent a67b154 commit 2d290fd

File tree

1 file changed

+256
-24
lines changed

1 file changed

+256
-24
lines changed

‎README.md‎

Lines changed: 256 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,42 @@
1-
<h1 align="center">ESP32 WiFi JSON Status Checker</h1>
1+
<h1 align="center">PojavLauncher</h1>
22

33

44

5-
> Made by Lukas Hilverda
5+
<img src="https://github.com/PojavLauncherTeam/PojavLauncher/blob/v3\_openjdk/app\_pojavlauncher/src/main/assets/pojavlauncher.png" align="left" width="130" height="150" alt="PojavLauncher logo">
66

77

88

9-
This project is a simple ESP32 program that connects to a Wi-Fi network and fetches a JSON response from a specified URL. It parses the JSON and checks for an `"online"` field, then prints the result to the serial monitor.
9+
\[!\[Android CI](https://github.com/PojavLauncherTeam/PojavLauncher/workflows/Android%20CI/badge.svg)](https://github.com/PojavLauncherTeam/PojavLauncher/actions)
10+
11+
\[!\[GitHub commit activity](https://img.shields.io/github/commit-activity/m/PojavLauncherTeam/PojavLauncher)](https://github.com/PojavLauncherTeam/PojavLauncher/actions)
12+
13+
\[!\[Crowdin](https://badges.crowdin.net/pojavlauncher/localized.svg)](https://crowdin.com/project/pojavlauncher)
14+
15+
\[!\[Discord](https://img.shields.io/discord/724163890803638273.svg?label=\&logo=discord\&logoColor=ffffff\&color=7389D8\&labelColor=6A7EC2)](https://discord.com/invite/aenk3EUvER)
16+
17+
\[!\[Twitter Follow](https://img.shields.io/twitter/follow/plaunchteam?color=blue\&style=flat-square)](https://twitter.com/PLaunchTeam)
18+
19+
20+
21+
\*From \[Boardwalk](https://github.com/zhuowei/Boardwalk)'s ashes here comes PojavLauncher!\*
22+
23+
24+
25+
PojavLauncher is a launcher that allows you to play Minecraft: Java Edition on your Android and \[iOS](https://github.com/PojavLauncherTeam/PojavLauncher\_iOS) devices.
26+
27+
28+
29+
For more details, check out our \[wiki](https://pojavlauncher.app/)!
30+
31+
32+
33+
\## Important Notes
34+
35+
36+
37+
\* We do not have an official TikTok account. No one from the dev team makes TikTok videos.
38+
39+
\* The official Twitter for PojavLauncher is \[@PLaunchTeam](https://twitter.com/PLaunchTeam). Any others (most notably @PojavLauncher) are fake.
1040

1141

1242

@@ -16,57 +46,259 @@ This project is a simple ESP32 program that connects to a Wi-Fi network and fetc
1646

1747
\* \[Introduction](#introduction)
1848

49+
\* \[Getting PojavLauncher](#getting-pojavlauncher)
50+
51+
\* \[Building](#building)
52+
53+
&nbsp; \* \[Quick Build (Recommended)](#quick-build-recommended)
54+
55+
&nbsp; \* \[Detailed Build](#detailed-build)
56+
57+
\* \[Current Status](#current-status)
58+
59+
\* \[Known Issues](#known-issues)
60+
61+
\* \[FAQ](#faq)
62+
63+
\* \[Contributing](#contributing)
64+
65+
\* \[Support](#support)
66+
67+
\* \[License](#license)
68+
69+
\* \[Credits \& Dependencies](#credits--dependencies)
70+
71+
\* \[Roadmap](#roadmap)
72+
73+
74+
75+
\## Introduction
76+
77+
78+
79+
\* PojavLauncher is a Minecraft: Java Edition launcher for Android and iOS based on \[Boardwalk](https://github.com/zhuowei/Boardwalk)
80+
81+
\* This launcher can launch almost all available Minecraft versions ranging from rd-132211 to 1.21 snapshots (including Combat Test versions)
82+
83+
\* Modding via Forge and Fabric are also supported.
84+
85+
\* This repository contains source code for Android. For iOS/iPadOS, check out \[PojavLauncher\_iOS](https://github.com/PojavLauncherTeam/PojavLauncher\_iOS).
86+
87+
88+
89+
\## Getting PojavLauncher
90+
91+
92+
93+
You can get PojavLauncher via three methods:
94+
95+
96+
97+
1\. \*\*Releases:\*\* Download the prebuilt app from our \[stable releases](https://github.com/PojavLauncherTeam/PojavLauncher/releases) or \[automatic builds](https://github.com/PojavLauncherTeam/PojavLauncher/actions).
98+
99+
2\. \*\*Google Play:\*\* Get it from Google Play by clicking on this badge: \[!\[Google Play](https://play.google.com/intl/en\_us/badges/static/images/badges/en\_badge\_web\_generic.png)](https://play.google.com/store/apps/details?id=net.kdt.pojavlaunch)
100+
101+
3\. \*\*Build from Source:\*\* Follow the \[building instructions](#building) below.
102+
103+
104+
105+
\## Building
106+
107+
108+
109+
\### Quick Build (Recommended)
110+
111+
112+
113+
The easiest way to build PojavLauncher is to use the pre-built JREs provided by our CI.
114+
115+
116+
117+
1\. Clone the repository: `git clone https://github.com/PojavLauncherTeam/PojavLauncher.git`
118+
119+
2\. Build the launcher: `./gradlew :app\_pojavlauncher:assembleDebug` (Use `gradlew.bat` on Windows)
120+
121+
122+
123+
The built APK will be located in `app\_pojavlauncher/build/outputs/apk/debug/`.
124+
125+
126+
127+
\### Detailed Build
128+
129+
130+
131+
If you need more control over the build process, follow these steps:
132+
133+
134+
135+
1\. \*\*Java Runtime Environment (JRE):\*\* Download the `jre8-pojav` artifact from our \[CI auto builds](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch/actions). This package contains pre-built JREs for all supported architectures. If you need to build the JRE yourself, follow the instructions in the \[android-openjdk-build-multiarch](https://github.com/PojavLauncherTeam/android-openjdk-build-multiarch) repository.
136+
137+
138+
139+
2\. \*\*LWJGL:\*\* The build instructions for the custom LWJGL are available over the \[LWJGL repository](https://github.com/PojavLauncherTeam/lwjgl3).
140+
141+
142+
143+
3\. \*\*Language List:\*\* Because languages are auto-added by Crowdin, you need to run the language list generator before building. In the project directory, run:
144+
145+
&nbsp; \* Linux/macOS:
146+
147+
&nbsp; ```bash
148+
149+
&nbsp; chmod +x scripts/languagelist\_updater.sh
150+
151+
&nbsp; bash scripts/languagelist\_updater.sh
152+
153+
&nbsp; ```
154+
155+
&nbsp; \* Windows:
156+
157+
&nbsp; ```batch
158+
159+
&nbsp; scripts\\languagelist\_updater.bat
160+
161+
&nbsp; ```
162+
163+
164+
165+
4\. \*\*Build GLFW stub:\*\* `./gradlew :jre\_lwjgl3glfw:build`
166+
167+
168+
169+
5\. \*\*Build the launcher:\*\* `./gradlew :app\_pojavlauncher:assembleDebug` (Replace `gradlew` with `gradlew.bat` on Windows).
170+
171+
172+
173+
\## Current Status
174+
175+
176+
177+
\* \[x] OpenJDK 8 Mobile port: ARM32, ARM64, x86, x86\_64
178+
179+
\* \[x] OpenJDK 17 Mobile port: ARM32, ARM64, x86, x86\_64
180+
181+
\* \[x] OpenJDK 21 Mobile port: ARM32, ARM64, x86, x86\_64
182+
183+
\* \[x] Headless mod installer
184+
185+
\* \[x] Mod installer with GUI
186+
187+
\* \[x] OpenGL in OpenJDK environment
188+
189+
\* \[x] OpenAL (works on most devices)
190+
191+
\* \[x] Support for Minecraft 1.12.2 and below
192+
193+
\* \[x] Support for Minecraft 1.13 and above
194+
195+
\* \[x] Support for Minecraft 1.17 (22w13a) and above
196+
197+
\* \[x] Game surface zooming
198+
199+
\* \[x] New input pipe rewritten to native code
200+
201+
\* \[x] Rewritten entire controls system
202+
203+
\* \[ ] More to come!
204+
205+
206+
207+
\## Known Issues
208+
209+
210+
211+
See our \[issue tracker](https://github.com/PojavLauncherTeam/PojavLauncher/issues) for a list of known issues and their current status.
212+
213+
214+
215+
\## FAQ
216+
217+
218+
219+
See our \[wiki](https://pojavlauncherteam.github.io/) for more information.
220+
221+
222+
223+
\## Contributing
224+
225+
226+
227+
Contributions are welcome! We welcome any type of contribution, not only code. For example, you can help improve the \[wiki](https://pojavlauncherteam.github.io/), contribute to the \[translations](https://crowdin.com/project/pojavlauncher), or submit bug reports and feature requests.
228+
229+
230+
231+
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it.
232+
233+
234+
235+
\## Support
236+
237+
238+
239+
For support, please join our \[Discord server](https://discord.com/invite/aenk3EUvER).
240+
241+
242+
243+
\## License
244+
245+
246+
247+
PojavLauncher is licensed under \[GNU LGPLv3](https://github.com/PojavLauncherTeam/PojavLauncher/blob/v3\_openjdk/LICENSE).
248+
249+
250+
251+
\## Credits \& Dependencies
252+
19253

20254

21-
\## Features
255+
\* \[Boardwalk](https://github.com/zhuowei/Boardwalk) (JVM Launcher): Unknown License/\[Apache License 2.0](https://github.com/zhuowei/Boardwalk/blob/master/LICENSE) or GNU GPLv2.
22256

257+
\* Android Support Libraries: \[Apache License 2.0](https://android.googlesource.com/platform/prebuilts/maven\_repo/android/+/master/NOTICE.txt).
23258

259+
\* \[GL4ES](https://github.com/PojavLauncherTeam/gl4es): \[MIT License](https://github.com/ptitSeb/gl4es/blob/master/LICENSE).
24260

25-
\* Connects to a Wi-Fi network
261+
\* \[OpenJDK](https://github.com/PojavLauncherTeam/openjdk-multiarch-jdk8u): \[GNU GPLv2 License](https://openjdk.java.net/legal/gplv2+ce.html).
26262

27-
\* Sends an HTTP GET request to a server
263+
\* \[LWJGL3](https://github.com/PojavLauncherTeam/lwjgl3): \[BSD-3 License](https://github.com/LWJGL/lwjgl3/blob/master/LICENSE.md).
28264

29-
\* Parses JSON response using ArduinoJson
265+
\* \[LWJGLX](https://github.com/PojavLauncherTeam/lwjglx) (LWJGL2 API compatibility layer for LWJGL3): unknown license.
30266

31-
\* Checks if a device or service is online
267+
\* \[Mesa 3D Graphics Library](https://gitlab.freedesktop.org/mesa/mesa): \[MIT License](https://docs.mesa3d.org/license.html).
32268

33-
\* Output shown via Serial Monitor
269+
\* \[pro-grade](https://github.com/pro-grade/pro-grade) (Java sandboxing security manager): \[Apache License 2.0](https://github.com/pro-grade/pro-grade/blob/master/LICENSE.txt).
34270

271+
\* \[bhook](https://github.com/bytedance/bhook) (Used for exit code trapping): \[MIT license](https://github.com/bytedance/bhook/blob/main/LICENSE).
35272

273+
\* \[libepoxy](https://github.com/anholt/libepoxy): \[MIT License](https://github.com/anholt/libepoxy/blob/master/COPYING).
36274

37-
\## Requirements
275+
\* \[virglrenderer](https://github.com/PojavLauncherTeam/virglrenderer): \[MIT License](https://gitlab.freedesktop.org/virgl/virglrenderer/-/blob/master/COPYING).
38276

277+
\* Thanks to \[MCHeads](https://mc-heads.net) for providing Minecraft avatars.
39278

40279

41-
\* ESP32 board
42280

43-
\* Arduino IDE or PlatformIO
281+
\## Roadmap
44282

45-
\* Libraries:
46283

47-
&nbsp; \* \[WiFi.h](https://www.arduino.cc/en/Reference/WiFi)
48284

49-
&nbsp; \* \[HTTPClient.h](https://www.arduino.cc/en/Reference/HTTPClient)
285+
We are currently focusing on:
50286

51-
&nbsp; \* \[ArduinoJson](https://arduinojson.org/)
52287

53288

289+
\* Exploring new rendering technologies.
54290

55-
\## Installation
56291

57292

293+
Future plans include:
58294

59-
1\. Clone or download the project.
60295

61-
2\. Open the code in Arduino IDE.
62296

63-
3\. Fill in your Wi-Fi credentials and the server URL:
297+
\* Improving stability and performance.
64298

65-
  ```cpp
299+
\* Enhancing the mod installation experience.
66300

67-
  const char\* ssid = "YOUR\_WIFI\_SSID";
68301

69-
  const char\* password = "YOUR\_WIFI\_PASSWORD";
70302

71-
  String url = "http://your-server.com/status";
303+
We welcome community feedback and suggestions for our roadmap. Please feel free to open a feature request in our \[issue tracker](https://github.com/PojavLauncherTeam/PojavLauncher/issues).
72304

0 commit comments

Comments
 (0)