X4: Foundations

File information

Last updated

Original upload

Created by

SirNukes

Uploaded by

sirnukes

Virus scan

Safe to use

Tags for this mod

About this mod

Adds several apis to be used by other mods.

Requirements
Permissions and credits
Mirrors
X4 Mod Support APIs

This is a collection of APIs developed to ease mod creation in a variety of ways. Components include:

* Lua Loader API
  - Support for loading lua files
* Simple Menu API
  - Create custom menus
* Interact Menu API
  - Add new context menu commands
* Named Pipes API
  - Inter-process two-way communication
* Hotkey API
  - Create new hotkeys
* Time API
  - Real-time delays


Primary development is on github:
https://github.com/bvbohnen/x4-projects/tree/master/extensions/sn_mod_support_apis

Extended documentation on api usage:
https://github.com/bvbohnen/x4-projects/tree/master/extensions/sn_mod_support_apis/documentation

Latest releases (nexus may be slower to get updates):
https://github.com/bvbohnen/x4-projects/releases

Also available on steam workshop.

Usage:
This mod has two parts:

1) The X4 extension includes all x4 plugins that other mods can call, and is necessary for any dependencies. 

2) An optional external program acts as a host for the named pipes api, and supports the hotkey api.  This is Windows-only for now, and needs to run in the background while X4 is open to support any hotkey mods (or other mods using the named pipes).  A Python source code version can also be obtained from github and run directly by users with Python installed.  See github documentation for version and package requirements for running from source.