README.md

X4 Tweaker

Cross platform desktop mod template generator for X4: Foundations

About

X4 Tweaker enables you to easily create your own mod configs for X4: Foundations with a simple desktop application.

Note

This project is a work in progress and no releases are available yet. If you wish to use the tool, you can build it from the source code by cloning the repository and following the developer's guide.

Supported Platforms

X4 Tweaker is available for the following platforms:

Technologies

Developer's guide

0. Prerequisites

• Install Python 3.8+

1. Setup

Make a Python virtual environment:

macOS

python3 -m venv beeware-venv

Windows

py -m venv beeware-venv

Linux

python3 -m venv beeware-venv

Activate the virtual environment:

macOS

source beeware-venv/bin/activate

Windows

beeware-venv\Scripts\activate

Linux

source beeware-venv/bin/activate

Install dependencies:

pip install -r requirements.txt

2. Run

Run in watch mode:

watchmedo auto-restart -p "*.py" -R briefcase dev

Run in dev mode:

briefcase dev

Run in production mode:

briefcase run -u

3. Update dependencies:

pip freeze > requirements.txt

4. Build the app:

Create the application scaffold

briefcase create

Build the application

briefcase build

Update the built application

briefcase update

---

Disclaimer

Warning

X4 Tweaker is a fan-made tool for modifying X4: Foundations for educational purposes only. It is not affiliated with or endorsed by Egosoft. The purpose of this project is to demonstrate how cross platform desktop native applications can be built using Python and to educate the community by providing examples. This tool shall never be used for cheating in the game. Use it at your own risk.