Script Documentation
Moderators: Moderators for English X Forum, Scripting / Modding Moderators
Script Documentation
Where can I see script documentation?
-
- Posts: 78
- Joined: Fri, 22. Feb 13, 17:34
Re: Script Documentation
For all the XML based scripting (MD and AI) you can find the documentation in their XSDs.
You can also read this:
https://www.egosoft.com/download/x_rebi ... rGuide.pdf
Re: Script Documentation
Thank you, but this is not a complete guide.
How, for example, to get a list of all the rooms at the station?
How, for example, to get a list of all the rooms at the station?
Re: Script Documentation
There isn't a complete guide, sometimes you just got to do your own research and testing. I know, that's a rare technique in today's youth, but it does work.
Re: Script Documentation
Yup. Unfortunately, modding X4 requires a study of the existing XML scripts.
I also thought, 4 weeks ago, that there'd be a guide similar to Oblivion's and Skyrim's.
That's not a slight to X4, of course. I actually find X4 script engine a lot more robust than Oblivion's and Skyrim's put together. A whole lot more robust.
EDIT: Definitely more rewarding scripting X4.
Mods: RPG: Reputations and Professions, Social Standings and Citizenships, Crime has Consequences, Alternatives to Death. Missions/NPCs: Emergent Missions, NPC Reactions, Mod Parts Trader, High-sec Rooms are Locked, Hacking Outcomes, More Generic Missions, Waypoint Fields for Deployment. Others: Auto-cam, Friendly Fire Tweaks, Teleport From Transporter Room, Wear and Tear. QoL: Trade Analytics, Loot Mining, Ship Scanner, Signal Leak Hunter, Station Scanner, Surface Element Targeting, etc.
Re: Script Documentation
Here's a tip, actually:
After going through the guidelines referred to above by Alberto Rosa,
1. create a folder "extensions/base" in your X4 folder.
2. extract these script folders from the *.dat files into "extensions/base": aiscripts, cutscenes, index, libraries, MD, t, UI
3. browse them with your chosen editor. I use Sublime.
You'll find the actual API docs in various "libraries/*.xsd" files - also mentioned by Alberto.
After going through the guidelines referred to above by Alberto Rosa,
1. create a folder "extensions/base" in your X4 folder.
2. extract these script folders from the *.dat files into "extensions/base": aiscripts, cutscenes, index, libraries, MD, t, UI
3. browse them with your chosen editor. I use Sublime.
You'll find the actual API docs in various "libraries/*.xsd" files - also mentioned by Alberto.
Mods: RPG: Reputations and Professions, Social Standings and Citizenships, Crime has Consequences, Alternatives to Death. Missions/NPCs: Emergent Missions, NPC Reactions, Mod Parts Trader, High-sec Rooms are Locked, Hacking Outcomes, More Generic Missions, Waypoint Fields for Deployment. Others: Auto-cam, Friendly Fire Tweaks, Teleport From Transporter Room, Wear and Tear. QoL: Trade Analytics, Loot Mining, Ship Scanner, Signal Leak Hunter, Station Scanner, Surface Element Targeting, etc.