Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions content/markdown/faq.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,20 @@ A guide to install Portmaster can be found [here](https://portmaster.games/insta

## Do I have to use PortMaster to install ports?

For the best experience you should download and install the Port trough the PortMaster Application. This ensures that the installed Port has the correct permissions aswell as the correct metadata.
For the best experience you should download and install the Port through the PortMaster Application. This ensures that the installed Port has the correct permissions as well as the correct metadata.

If you have a device without wifi you can simply go to the PortMaster repo, [https://portmaster.games/games.html](https://portmaster.games/games.html), find the title of the port you want, download it and copy the zip file into the PortMaster Autoinstall folder. Then you just run the PortMaster Application and PortMaster will install the Port for you.

Here are the locations for the autoinstall folder for the

- **AmberELEC, ROCKNIX, uOS, Jelos** ```/roms/ports/PortMaster/autoinstall/```
- **AmberELEC, ROCKNIX, uOS** ```/roms/ports/PortMaster/autoinstall/```
- **muOS** ```/mmc/MUOS/PortMaster/autoinstall/```
- **ArkOS** ```/roms/tools/PortMaster/autoinstall/```
- **Knulli** ```/userdata/system/.local/share/PortMaster/autoinstall```

If that does not work you can also unzip the contents of the port into the ports folders of each cfw, note that this may break the port and ports may no longer start.

- **AmberELEC, ROCKNIX, uOS, Jelos** ```/roms/ports/```
- **AmberELEC, ROCKNIX, uOS** ```/roms/ports/```
- **muOS** ```/mmc/ports/ for the folders and /mnt/mmc/ROMS/Ports/ for the .sh files```
- **ArkOS** ```/roms/tools/PortMaster/autoinstall/```
- **Knulli** ```/userdata/system/.local/share/PortMaster/autoinstall```
Expand Down Expand Up @@ -59,8 +59,7 @@ https://the.earth.li/~sgtatham/putty/latest/w64/putty.exe
- Enter your ssh credentials

-- Amberelec: root / amberelec
-- ArkOS : ark / ark
-- Jelos : root / check under system settings
-- ArkOS : ark / ark
- enter:
```
cd /roms/ports/
Expand Down
3 changes: 1 addition & 2 deletions content/markdown/installation.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ To install PortMaster via a simple Installation Script download either the Insta
| ROCKNIX | /roms/ports/ |
| muOS | /mnt/mmc/ROMS/Ports/ |
| Knulli | /userdata/roms/ports |
| JELOS | /roms/ports/ |
| UnofficialOS | /roms/ports/ |


Expand All @@ -39,4 +38,4 @@ There are 2 options on how-to upgrade:
1. Use SSH or insert mSD card into your PC.
2. [Download PortMaster.zip](https://github.com/PortsMaster/PortMaster-GUI/releases)
3. (See locations in previous section) Remove previous `PortMaster` folder and unzip contents of downloaded archive to that location.
4. Start PortMaster. Verify that it is runnning new version - the `PM <version>` in the bottom would correspond to the version on the Release Download page.
4. Start PortMaster. Verify that it is running new version - the `PM <version>` in the bottom would correspond to the version on the Release Download page.
17 changes: 11 additions & 6 deletions content/markdown/porting.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Mind for 3/4/5 a LOT of hacking and tweaking might be needed.
Since PortMaster is platform independent and delivers their own dependencies we don't rely on the build mechanism of the CFWs out there.
Various Instructions for Build Environments can be found here: https://portmaster.games/build-environments.html

Once you have your software compiled it is recommeded you test your game directly on your device via ssh.
Once you have your software compiled it is recommended you test your game directly on your device via ssh.
For testing you can stop Emulationstation to not clash with your Ports

- AmberELEC, uOS, Jelos: `systemctl stop emustation`
- AmberELEC, uOS: `systemctl stop emustation`
- ArkOS: `systemctl stop emulationstation`
- muOS: `killall -q frontend.sh muxlaunch`
- Knulli: `/etc/init.d/S31emulationstation stop `
Expand Down Expand Up @@ -170,11 +170,16 @@ For the full GPTOKEYB Documentation https://portmaster.games/gptokeyb-documentat

## Java

AmberELEC / uOS / Jelos has JDK support already built in once you start a j2me game for the first time.
You can supply this also via Portmaster Runtimes
Note you also need a display backend for your java application. So just running a jar file without anything won't work.
Java ports are supported via the [WestonPack Runtime](https://github.com/binarycounter/Westonpack/wiki/). WestonPack provides both a JDK and a display backend (Wayland/Weston), which Java applications need to run on handheld devices.

As of yet we have no Port that uses these but in theory this could be interesting for LIBGDX
We have several working Java ports, including:
- **Minecraft** (via launchers that use the JDK)
- **Unciv** (open-source Civilization clone)
- **Mindustry** (factory/tower-defense game)

Note you also need a display backend for your Java application — just running a jar file without one won't work. WestonPack handles this for you.

You can also supply a JDK via PortMaster Runtimes manually if needed.

**Example**:

Expand Down
16 changes: 8 additions & 8 deletions devices.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,30 @@
"manufacturer": "Anbernic",
"resolution": "640*480",
"aspect ratio": "4:3",
"firmware": "ArkOS,JELOS",
"firmware": "ArkOS",
"notes": ""
},
{
"device": "RG351MP",
"manufacturer": "Anbernic",
"resolution": "640*480",
"aspect ratio": "4:3",
"firmware": "ArkOS,AmberELEC,JELOS, ROCKNIX",
"firmware": "ArkOS,AmberELEC,ROCKNIX",
"notes": ""
},
{
"device": "RG503",
"manufacturer": "Anbernic",
"resolution": "960*544",
"aspect ratio": "15:8",
"firmware": "ArkOS,JELOS",
"firmware": "ArkOS",
"notes": "Some ports may have issues with this aspect ratio. Results will vary from port to port."
}, {
"device": "RG552",
"manufacturer": "Anbernic",
"resolution": "1920*1152",
"aspect ratio": "5:3",
"firmware": "AmberELEC,JELOS",
"firmware": "AmberELEC",
"notes": "Some ports may have issues with this aspect ratio. Results will vary from port to port."
},
{
Expand All @@ -43,7 +43,7 @@
"manufacturer": "Powkiddy",
"resolution": "720*720",
"aspect ratio": "1:1",
"firmware": "ArkOS,JELOS",
"firmware": "ArkOS",
"notes": "Some ports may have issues with this aspect ratio. Results will vary from port to port."
},{
"device": "RK2023 ",
Expand All @@ -58,23 +58,23 @@
"manufacturer": "Anbernic",
"resolution": "480*320",
"aspect ratio": "3:2",
"firmware": "ArkOS (Wummle),AmberELEC,JELOS",
"firmware": "ArkOS (Wummle),AmberELEC",
"notes": "Some ports may have issues with this aspect ratio. Results will vary from port to port."
},
{
"device": "RG351V",
"manufacturer": "Anbernic",
"resolution": "640*480",
"aspect ratio": "4:3",
"firmware": "ArkOS,AmberELEC,JELOS",
"firmware": "ArkOS,AmberELEC",
"notes": "Some ports may have issues with this aspect ratio. Results will vary from port to port."
},
{
"device": "X55",
"manufacturer": "Powkiddy",
"resolution": "1280*720",
"aspect ratio": "16:9",
"firmware": "JELOS,ROCKNIX",
"firmware": "ROCKNIX",
"notes": ""
}
]
98 changes: 85 additions & 13 deletions docs/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,20 @@
<br/>
<div class="container">
<main>
<ul class="nav nav-tabs mb-4" id="faqTabs" role="tablist">
<li class="nav-item" role="presentation">
<button aria-controls="faq-content" aria-selected="true" class="nav-link active" data-bs-target="#faq-content" data-bs-toggle="tab" id="faq-tab" role="tab" type="button">
FAQ
</button>
</li>
<li class="nav-item" role="presentation">
<button aria-controls="firmware-content" aria-selected="false" class="nav-link" data-bs-target="#firmware-content" data-bs-toggle="tab" id="firmware-tab" role="tab" type="button">
Supported &amp; Unsupported Firmwares
</button>
</li>
</ul>
<div class="tab-content" id="faqTabsContent">
<div aria-labelledby="faq-tab" class="tab-pane fade show active" id="faq-content" role="tabpanel">
<h2>
What is PortMaster?
</h2>
Expand All @@ -269,14 +283,13 @@ <h2>
<strong>
Port Navigators
</strong>
, most of the the ports available through PortMaster have been configured to launch with proper controls for the various devices that are supported.
, most of the ports available through PortMaster have been configured to launch with proper controls for the various devices that are supported.
</p>
<h2>
What Devices are supported?
</h2>
<p>
(Currently Outdated)
The full list of supported devices can be found
The full list of supported devices can be found
<a href="https://portmaster.games/supported-devices.html">
here
</a>
Expand All @@ -285,7 +298,7 @@ <h2>
How can I install PortMaster?
</h2>
<p>
A guide to install Portmaster can be found
A guide to install PortMaster can be found
<a href="https://portmaster.games/installation.html">
here
</a>
Expand All @@ -294,7 +307,7 @@ <h2>
Do I have to use PortMaster to install ports?
</h2>
<p>
For the best experience you should download and install the Port trough the PortMaster Application. This ensures that the installed Port has the correct permissions aswell as the correct metadata.
For the best experience you should download and install the Port through the PortMaster Application. This ensures that the installed Port has the correct permissions as well as the correct metadata.
</p>
<p>
If you have a device without wifi you can simply go to the PortMaster repo,
Expand All @@ -304,12 +317,12 @@ <h2>
, find the title of the port you want, download it and copy the zip file into the PortMaster Autoinstall folder. Then you just run the PortMaster Application and PortMaster will install the Port for you.
</p>
<p>
Here are the locations for the autoinstall folder for the
Here are the locations for the autoinstall folder:
</p>
<ul>
<li>
<strong>
AmberELEC, ROCKNIX, uOS, Jelos
AmberELEC, ROCKNIX, uOS
</strong>
<code>
/roms/ports/PortMaster/autoinstall/
Expand Down Expand Up @@ -341,12 +354,12 @@ <h2>
</li>
</ul>
<p>
If that does not work you can also unzip the contents of the port into the ports folders of each cfw, note that this may break the port and ports may no longer start.
If that does not work you can also unzip the contents of the port into the ports folders of each CFW, note that this may break the port and ports may no longer start.
</p>
<ul>
<li>
<strong>
AmberELEC, ROCKNIX, uOS, Jelos
AmberELEC, ROCKNIX, uOS
</strong>
<code>
/roms/ports/
Expand Down Expand Up @@ -383,7 +396,7 @@ <h2>
<p>
You can find all Ports with included instructions on the
<a href="https://portmaster.games/games.html">
PortMaster Wiki
PortMaster Games page
</a>
</p>
<h2>
Expand Down Expand Up @@ -430,9 +443,8 @@ <h2>
</li>
</ul>
<p>
-- Amberelec: root / amberelec
-- ArkOS : ark / ark
-- Jelos : root / check under system settings
-- AmberELEC: root / amberelec<br/>
-- ArkOS: ark / ark
</p>
<ul>
<li>
Expand All @@ -445,6 +457,66 @@ <h2>
<p>
You can then mark the output with your mouse and with ctrl + c / ctrl + v paste it into the ports-help channel on discord.
</p>
</div>
<div aria-labelledby="firmware-tab" class="tab-pane fade" id="firmware-content" role="tabpanel">
<h2>Supported Firmwares</h2>
<p>These custom firmwares (CFWs) are actively supported by PortMaster:</p>
<table class="table table-striped">
<thead>
<tr>
<th>Firmware</th>
<th>Notes</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>ArkOS</strong></td>
<td>Fully supported. Install script goes in <code>/roms/tools/</code>.</td>
</tr>
<tr>
<td><strong>AmberELEC</strong></td>
<td>Fully supported.</td>
</tr>
<tr>
<td><strong>ROCKNIX</strong></td>
<td>Fully supported. The spiritual successor to AmberELEC.</td>
</tr>
<tr>
<td><strong>muOS</strong></td>
<td>Fully supported.</td>
</tr>
<tr>
<td><strong>Knulli</strong></td>
<td>Fully supported.</td>
</tr>
<tr>
<td><strong>uOS / UnofficialOS</strong></td>
<td>Partially supported.</td>
</tr>
<tr>
<td><strong>dArkOS</strong></td>
<td>Fully supported.</td>
</tr>
</tbody>
</table>
<h2>Unsupported Firmwares</h2>
<p>These firmwares are <strong>no longer supported</strong> by PortMaster. They may have worked in the past but are discontinued or no longer maintained:</p>
<table class="table table-striped">
<thead>
<tr>
<th>Firmware</th>
<th>Reason</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>JELOS</strong></td>
<td>Discontinued. The project is no longer maintained. Users are encouraged to migrate to <a href="https://rocknix.org">ROCKNIX</a>, which is the active continuation of JELOS.</td>
</tr>
</tbody>
</table>
</div>
</div>
<script>
anchors.options.visible = 'always';
anchors.add();
Expand Down
10 changes: 1 addition & 9 deletions docs/installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -326,14 +326,6 @@ <h3>
/userdata/roms/ports
</td>
</tr>
<tr>
<td>
JELOS
</td>
<td>
/roms/ports/
</td>
</tr>
<tr>
<td>
UnofficialOS
Expand Down Expand Up @@ -412,7 +404,7 @@ <h3>
folder and unzip contents of downloaded archive to that location.
</li>
<li>
Start PortMaster. Verify that it is runnning new version - the
Start PortMaster. Verify that it is running new version - the
<code>
PM &lt;version&gt;
</code>
Expand Down
21 changes: 15 additions & 6 deletions docs/porting.html
Original file line number Diff line number Diff line change
Expand Up @@ -291,12 +291,12 @@ <h2>
</a>
</p>
<p>
Once you have your software compiled it is recommeded you test your game directly on your device via ssh.
Once you have your software compiled it is recommended you test your game directly on your device via ssh.
For testing you can stop Emulationstation to not clash with your Ports
</p>
<ul>
<li>
AmberELEC, uOS, Jelos:
AmberELEC, uOS:
<code>
systemctl stop emustation
</code>
Expand Down Expand Up @@ -627,12 +627,21 @@ <h2>
Java
</h2>
<p>
AmberELEC / uOS / Jelos has JDK support already built in once you start a j2me game for the first time.
You can supply this also via Portmaster Runtimes
Note you also need a display backend for your java application. So just running a jar file without anything won't work.
Java ports are supported via the <a href="https://github.com/binarycounter/Westonpack/wiki/">WestonPack Runtime</a>. WestonPack provides both a JDK and a display backend (Wayland/Weston), which Java applications need to run on handheld devices.
</p>
<p>
As of yet we have no Port that uses these but in theory this could be interesting for LIBGDX
We have several working Java ports, including:
</p>
<ul>
<li><strong>Minecraft</strong> (via launchers that use the JDK)</li>
<li><strong>Unciv</strong> (open-source Civilization clone)</li>
<li><strong>Mindustry</strong> (factory/tower-defense game)</li>
</ul>
<p>
Note you also need a display backend for your Java application — just running a jar file without one won't work. WestonPack handles this for you.
</p>
<p>
You can also supply a JDK via PortMaster Runtimes manually if needed.
</p>
<p>
<strong>
Expand Down
Loading