/UIXinator

A selection of tools to automate some of the setup and customization process of UIX Lite

Primary LanguagePython

UIXinator

logo
A selection of tools to automate some of the setup and customization process of UIX Lite

Warning

This project is in "beta".
It is unfinished and sloppy. Some icons may brake the launcher
But it does work, but it also needs work.

Pre-requirements

You should have UIX Lite already installed and setup. Might build a tool for this lator, idk
Some sort of FTP server running on your xbox, whether this be another custom dashboard or a dedicated FTP app.
I would recommend the UnleashX custom dashboard for FTP, or any FTP server that supports the UnleashX SITE commands.

Setup (Windows)

The pre-built release pack only contains windows binaries currently. Sorry.

  1. Download and extract to a folder the latest build of UIXinator (UIXinator-20240825.zip).
  2. Real xbox:
    Turn your xbox on, make sure it's FTP server is running and it's on the same network as your computer.
    XEMU:
    Make sure your NAT settings are enabled, setup and your emulated xbox is running and ftp server of some kind.
    See XEMU FTP Setup for more info.
    Then run XEMU first, then run a UIX tool. The tool will now detect XEMUs 2121 port and build a setup for it.
  3. Run one of the included tools, for eg Iconinator.exe at least once.
  4. On first launch of any UIX tool in this pack, you will be prompted to setup a settings.ini file, just follow the prompts.
    Basically you just need to enter the end of your xboxs IP, and make sure it's turned on, running it's FTP server and connected to the same network as your computer, easy peasy.
    on XEMU you just need to hit enter once or twice, even easier.

Once you have made this settings.ini file on first launch of any UIXinator tool, you won't need to do it again.
Running the tool exe again will auto load the settings.ini.

Setup (Advance settings ini)

After you have ran one of the UIXinator tools at least once, you should have a new file called settings.ini in the root of UIXinator
Make a copy of this and rename it to something like GamesRoomXbox.ini if for eg. you have an xbox in your games room you want to edit.
Or you can run one of the UIX tools from the command line like Iconinator.exe GamesRoomXbox.ini,
it will notice that GamesRoomXbox.ini is missing, and prompt you to make a new one, the same as the default first boot promt.
Open this ini file with notepad or an IDE of your choosing.
You should now see some variables

[UIXinator]
xbox_ip = This is the ip address of your xbox
xbox_port = the port address of your xbox. 21 for real FTP and 2121 for XEMU.
ftp_login = ftp server username : ftp server password
cleanup = If True, the tool will clean up after its self, deleting the downloaded icon xbx and default.xip
auto_reboot = if True and your FTP server supports UnleashX SITE commands, will relaunch the stock dashboard after have
icon_cdn = URL to a folder XBX icons. formatted like 4D53/4D530064.xbx PublisherHexcode/titleID.xbx

You can now edit these variables= to your needs, then save the ini file. If you wish to use these settings with one of the UIXinator tools, just drag'n'drop the new GamesRoomXbox.ini
to the UIXinator tool exe and it will open the tool with your chosen settings.
Or you can run the command again, Iconinator.exe GamesRoomXbox.ini now GamesRoomXbox.ini excists, the tool will use this config instead of settings.ini.

Alternatively, you can just make edits to the default settings.ini and run the tools like normal,
if for eg, you want to change your xbox ftp server login to something other then the defaults but don't want to make a full custom settings ini.

UIXinator tools

Iconinator

A tool that automates the process of setting up launcher icons
This tool will connect to your xbox via FTP, download a games list and get icons of all the games you have currently installed on your xbox,
build your custom icons.xbx icon list and default.xip icon pack, then re-upload them to your xbox.

TODO: Get/wait for pyxbe to work more reliabily.
Might be able to just rip icons directly from xbxs with pyxbe, but Idk if that's going to work for homebrew or old xbox games, titles pre XDK 4928..
Really pre XDK 5849 but idk when the spec for icons was fully locked in.

How to Build from source

TODO: Explain this more/better

-1. Install 7-zip. You should already have 7-zip..?
0. Make sure you have python 3.10.4 or newer installed, install the requests and cx_Freeze libs.
But you can run pip install -r requirements.txt if you want to do it automatically.

  1. Clone this repo
  2. Download XIP from the UIX-Lite github releases page.
    for eg, XIP-v240824.Rev1.zip
  3. Extract xip.exe into the lib folder, so it lives next to XBEJson.exe
  4. Run the buildEXEs.bat to build the python exes and make a zip of the whole app for upload.