[Index] X4: Foundations Tools, Tutorials and Resources

[Alan Phipps]

Modding Tools

• Egosoft Blender Mod Tools - Shulo (EGO)
• Animation Creation Blender Addon - We Can Now Make New Animations - tomchk
• vs-code for script editing - SpaceCadet11864
• Dynamic Debug Logs - SpaceCadet11864 (see also kuertee's hint about the launch options here.)
• Verify XML Patch without running the game - SpaceCadet11864
• Visual Studio Scripting Code Complete - Antaran
• [TOOL] Module drag and drop - rjtwins
• [TOOL] Ware Generator - SpaceCadet11864
• X4GalaxyCreator - Killerog + Celludriel
• VS Code Complete, Asset Converter, Blender Integration - WIP - Cg089
• [TOOL] X4 Customizer - SirNukes
• [Tool] X4 Editor - Max Bain
• ]MOD/API] X4 Named Pipes API - SirNukes
• [MOD/API] X4RestServer - External http API - Alia5
• [TOOL] X4 Sector Creator - Venomaust
• X4 Code Complete extension for Visual Studio Code - h2o.Ava

Modding Tutorials and Guides

• [PSA] Steps to make your mod work on Linux+Mac
• Tools, Scripting and Modding - Euclid
• How to create your own logo - Nexuscrawler
• How To: Export Models, Re-Import. (Blender) - DuckSoup
• Beginners guide to weapons modding - Vedder
• A way to reload MD/UI scripts - Muxa1L
• [TUTORIAL] XML Patch Guide - theqmann
• [API/GUIDE] How to mod the UI (_G Workaround and Right Click API) by morbideth/silentdeth
• Code Complete for Visual Studio Code by Misunderstood Wookie
• [TUTORIAL] How to add a Holo-Monitor - Litauen
• [Tutorial] Vertex colour and paintjobs - Axeface
• [Tutorial] Port X3 ships to X Rebirth / X4 - SirFrancisDrake
• [Video] Adding dirt layer to ships - Axeface
• Video Tutorial - Making a wreck model with Egosoft tools - Axeface
• Video Tutorial - How to make working dynamic Signature IDs - Axeface
• [Tutorial] Build your own ship for dummies - BrummBear02
• [how to make S ship] - aurumgallente
• analysing a save file - kurtee
• Github template for making new mods - temetvince

Resources

• Unofficial Discord - the community at large
• Blueprint List - alphata
• Lua Loader API (workaround method of loading custom lua files into X4) - SirNukes
• X-55 Hotas Personalized Mapping File - Rattler
• X4 Mods A Nexus Site - Pickysaurus

Submission

• TEL S Shield Generator Mk3 - Azurgan
• No Space Dust - Jashashunter
• Increase First Person Speed - SirNukes
• Seret Stash - Assailer
• REPOST -Revealthingz - aquarius79
• TradeStart - various trade starts - the ginga ninja
• Fly-by Looting - Assailer
• Fly-by Lockbox - Assailer
• Pulse Laser Mk2 - Azurgan
• Timed Autosaves - Azalrion
• Developer/Unlocked Gamestarts - EterniaLogic
• Various NPCs - Bifidus
• Player Trade Buy Logbook Messages - -Azalrion
• Better Combat - Fast Turrets/Bullets - the_dewar
• Shield and Weapon Overhaul - AngEviL
• AutoTrader -Euclid
• Player Jump - Euclid
• Pimp my Ships - Azurgan
• X4-Tracer-World - rjtwins
• Sector Satellites - iforgotmysocks
• Learning All The Things - iforgotmysocks
• Improved Repair Laser - iforgotmysocks
• Recycle Stations - iforgotmysocks
• [MOD] Player Owned Ship Production - Aftokinito(carmaster)
• Custom Icons Starcraft Race Logos (with glow!) - Zonalar
• Mobile Repair Service - Assailer
• Collect Inventory Wares -Tyrant597
• [MOD] Mobile Ship Production - Aftokinito(carmaster)
• Employee Training - Antaran
• Signal reader - Antaran
• Faction Battleships - Blackscorp81
• Mass Move Marines - Tyrant597
• Taranis - sco1981
• Paint Mods for Sale - Glimpse
• Resupplier Class Vessels - Glimpse
• [MOD] Satellite Network by morbideth/silentdeth
• [MOD] Collect Deployables (Satellites, Nav Beacons, Resource Probes, Laser Towers) by morbideth/silentdeth
  [MOD] Show Fight and Trade Ranks by morbideth/silentdeth
• Improved Bombers - RoverTX
• Race Weapons Enabled - RoverTX

• Please submit links to be included in this index by using and adjusting the code line below.

Code: Select all

[url=http://forum.egosoft.com/viewtopic.php?t=xxxxxx]Topic Title[/url] - [i]Author[/i]

[enenra]

Unsure of whether you prefer to have the discussion in a separate topic but FYI for everyone: XR CAT extractors work for X4 files.

[StoneLegionYT]

I think this the master List <3 Of all the topics overtime.

Also this not stickied

[euclid]

.....
Also this not stickied

It is now

Cheers Euclid

[Frstwlfz]

Hi and thanks for this. I suggest adding this one:

[Guide] How to add your own Logo! - Nexuscrawler

[Assailer]

When can we expect Steam Workshop support?

[StopBanningMe7_III]

Sorry if I'm ignorant here; I completely skipped on X Rebirth (haven't even looked at it in the slightest), but I am quite familiar with X3 modding. Is there any kind of proper script editor for the XML files available? There may be one for X Rebirth that I haven't seen, which is why I prefaced this with an apology-in-advance, but it's also possible that none exists. Have things maybe changed so significantly from X3 that there couldn't be such a thing? Has nobody bothered to write one? All the tutorials I've skimmed across seem to be directly editing the XML source, which I consider absurd.

[euclid]

When can we expect Steam Workshop support?

Hi Assailer

The short answer is soon™

Cheers Euclid

[euclid]

........Is there any kind of proper script editor for the XML files available? .....

Hi StopBanningMe7

I'm not entirely sure what you mean by "proper" but if you refer to an in-game script editor then the answer is no.

The beauty of the new X game engine is that you can code scripts outside the game and that you do not need any special editor. Some suggestions and other hints you will find here.

Cheers Euclid

[alt3rn1ty]

Hi Euclid or Alan

A few links to add to the OP - Maybe under Resources ? : Other Supporting Websites ?


Nexusmods now has a specific X4: Foundations site to upload mods to, which will be handy for anyone not using steam workshop (GOG users for example, or Mod Authors who do not agree with Valve T&C's)

https://www.nexusmods.com/x4foundations

Nexusmods forums

https://forums.nexusmods.com/index.php? ... undations/


There is also a thriving X4 Discord going being monitored by Developers

https://discord.gg/J8u6Kdc


Steam forums

https://steamcommunity.com/app/392160/discussions/0/

Steam Depots (For anyone watching out for impending updates / patches)

https://steamdb.info/app/392160/depots/


GOG Forums

https://www.gog.com/forum/x_series#1543565692

[Phinixa]

The discord link doesn't seem to do anything?

[alt3rn1ty]

The discord link doesn't seem to do anything?

My bad, link has been corrected to the invite link. You can make a new username to just have a browse, or if you already have a Discord account, dont enter username, just click the link to "Already have an account", you will then log in and have the channel added to your Discord account ( although dont quote me, I am fairly new to Discord myself so it may not work exactly how I think it should )

[StopBanningMe7_III]

........Is there any kind of proper script editor for the XML files available? .....

Hi StopBanningMe7

I'm not entirely sure what you mean by "proper" but if you refer to an in-game script editor then the answer is no.

The beauty of the new X game engine is that you can code scripts outside the game and that you do not need any special editor. Some suggestions and other hints you will find here.

Cheers Euclid

Sorry, perhaps I ought to be clearer. I meant something more like a translator of sorts that would turn the xml files into some kind of clearer source code, then "compile" the source back into xml later. This existed for X3. If nothing of the sort exists yet, then it looks like I have myself my first X4 project!

[euclid]

....
Sorry, perhaps I ought to be clearer. I meant something more like a translator of sorts that would turn the xml files into some kind of clearer source code, then "compile" the source back into xml later. This existed for X3. If nothing of the sort exists yet, then it looks like I have myself my first X4 project!

No, sorry, such an API does not exist (yet). But maybe someone will code it eventually. However, scripting is not that difficult. For a start there are many useful topics in the XR S&M forum but I'm happy to try to answer any question on MD and XML scripting.

Cheers Euclid

[StopBanningMe7_III]

As I mentioned, I'm going to try to write such a program (if it's even possible...), so I do have a few questions if it's not too much bother.

1. Is there a general reference on the whole of the XML based language somewhere? A list of all commands, keywords, events, etc?
2. Out of curiosity, what does the development team use to edit the scripts? Are the XML files actually edited as such by hand?
3. What does the question mark that often appears in boolean statements imply? It is only used sometimes and I can't work out how it modifies the thing preceding it. Here is an example I found:

   Code: Select all

   <do_elseif value="$timeout and not $time_init?">

4. Similarly, what does the '@' sign that appears before variables in some if statements imply?

Actually, I'm realizing that I have a lot of questions I could ask, but most would be answered by a language reference if one exists, so I won't waste your time typing a bunch out (unless I have to... ).

[euclid]

Hi StopBanningMe7_III

1. Yes, there are. If you have unpacked all game files then check the libraries folder. You'll find there several xsd files. the common.xsd and md.xsd are most important. For XML scripts check the aiscripts.xsd and in the main root of your unpacked file folder also the scriptproperties.html. More info you can find in the XR S&M forum.

2.As I wrote in the sticky here (I know it's potentially invisible ) visual studio is commonly used because it allows XML setup with the under 1. mentioned xsd files in the same location as the to be edited scripts (i.e. the work folder).

3. The ? maps the value to binary, i.e. 0 or 1. if it does not exists or if it does, respectively.

4. The @ maps the value to a Boolean, i.e. false or true, if it does not exists or if it does, respectively.

Cheers Euclid

[Meiyo]

1. Yes, there are. If you have unpacked all game files then check the libraries folder. You'll find there several xsd files. the common.xsd and md.xsd are most important. For XML scripts check the aiscripts.xsd and in the main root of your unpacked file folder also the scriptproperties.html. More info you can find in the XR S&M forum.

Thank's for this... I've dont see these files at the first time... (bad unpack ? only aiscript & assets)

[aftokinito]

I was suggested to ask here so please Euclid, schemas for macros and components:
viewtopic.php?f=181&t=404364

Or if those don't exist internally just answer me this, please:
viewtopic.php?f=181&t=403612&p=4767089#p4767089

[euclid]

Both of your questions have the same answer: This is an internal resource. I can try and see if this can be made available but no promise here as those are XML/C++ parsers and the usage may violate the EULA.

Cheers Euclid

[aftokinito]

We already have XSDs for a lot of stuff like MD, many of the xmls in libraries, etc. Why would the ones for macros and components be different?