What do you want documentation on?

Freeform discussion about anything related to modding Transcendence.
Post Reply
User avatar
Xephyr
Militia Captain
Militia Captain
Posts: 781
Joined: Fri Dec 14, 2007 1:52 am
Location: Orion Arm, Milky Way

What do you want documentation on?

Post by Xephyr » Mon Jan 16, 2017 2:40 am

I've been scouring the engine's source code when I need clarification on something, but I started to notice that there's a ton of things that are in the code but are rarely, if ever, used or explained outside of it.

I'm going to start writing documentation pages on the wiki, so if there's anything you want documented then I'll give that priority.

And before you ask, "Everything" is not a valid (or very informative) answer.
Project Renegade (Beta) : "The Poor Man's Corporate Command!"
"Cowards die many times before their deaths; The valiant never taste of death but once. " -Julius Caesar as written by William Shakespeare, a notorious permadeath player.

User avatar
AssumedPseudonym
Militia Captain
Militia Captain
Posts: 897
Joined: Thu Aug 29, 2013 5:18 am
Location: On the other side of the screen.

Re: What do you want documentation on?

Post by AssumedPseudonym » Mon Jan 16, 2017 2:47 am

 For starters, undocumented XML options and values. We at least have some idea of what to do with most functions, but a lot of the XML side is either outdated or outright undocumented. That would be my suggestion on where to start.
Image

My mods on Xelerus: Click here!

Of all the things I’ve lost in life, I miss my mind the least. (I’m having a lot more fun without it!)

NMS
Militia Commander
Militia Commander
Posts: 345
Joined: Tue Mar 05, 2013 8:26 am

Re: What do you want documentation on?

Post by NMS » Mon Jan 16, 2017 7:20 am

Agreed. There's really no way to figure that stuff out without source diving. I recall George was asked on stream about this and he suggested finding the functions that load types from XML and studying how they work to learn what options are available. I don't know what types to suggest focusing on first, though.

I'm sure we'd all appreciate you sharing what you learn very much. (Which reminds me, I should post some stuff I've learned about communications...)

User avatar
0xABCDEF
Miner
Miner
Posts: 43
Joined: Thu May 19, 2016 12:58 am
Location: Was destroyed by a Phobos-class dreadnought in the Eridani system

Re: What do you want documentation on?

Post by 0xABCDEF » Mon Jan 16, 2017 7:36 am

I've been scouring the engine's source code when I need clarification on something, but I started to notice that there's a ton of things that are in the code but are rarely, if ever, used or explained outside of it.

However, I do not have plans to write documentation because that would mean progress, and documentation hasn't had much progress in years.

Code: Select all

<OnFireWeapon>
	(gamEnd Nil "encountered an unexpected error")
</OnFireWeapon>
-Command Screen Library: RTS in a dockscreen
-Extended Justice: A safer Commonwealth for all
-Playership Bones: Revisit your old ship wrecks!
-Please help out our official Documentarist (me) by editing the wiki

relanat
Militia Commander
Militia Commander
Posts: 328
Joined: Tue Nov 05, 2013 9:56 am

Re: What do you want documentation on?

Post by relanat » Tue Jan 17, 2017 2:06 am

Function explanations like on xelerus, please, for the newer functions that aren't covered there. Including a realistic example would be great too. Some of the existing examples aren't very informative.
The xelerus functionlist is the most useful site related to modding IMO.

Also a condensed index of where and when you can use all the aThings like aOverlayObj, aScreenUNID, aEnemiesDestroyed, etc. There are some explanations scattered through the code of different game versions but nothing that is easy to find.

User avatar
Xephyr
Militia Captain
Militia Captain
Posts: 781
Joined: Fri Dec 14, 2007 1:52 am
Location: Orion Arm, Milky Way

Re: What do you want documentation on?

Post by Xephyr » Tue Jan 17, 2017 2:12 am

relanat wrote:Function explanations like on xelerus, please, for the newer functions that aren't covered there. Including a realistic example would be great too. Some of the existing examples aren't very informative.
The xelerus functionlist is the most useful site related to modding IMO.
I'll be updating the function list first. Unfortunately I can't do it on Xelerus - Adding in new entries apparently deletes older entries (and various other Xelerus related problems). So the documentation will have to be on the wiki, but I'll try and see if we can streamline searching through them a bit better.
Project Renegade (Beta) : "The Poor Man's Corporate Command!"
"Cowards die many times before their deaths; The valiant never taste of death but once. " -Julius Caesar as written by William Shakespeare, a notorious permadeath player.

User avatar
AssumedPseudonym
Militia Captain
Militia Captain
Posts: 897
Joined: Thu Aug 29, 2013 5:18 am
Location: On the other side of the screen.

Re: What do you want documentation on?

Post by AssumedPseudonym » Tue Jan 17, 2017 2:16 am

relanat wrote:Function explanations like on xelerus, please, for the newer functions that aren't covered there. Including a realistic example would be great too. Some of the existing examples aren't very informative.
The xelerus functionlist is the most useful site related to modding IMO.
Xephyr wrote:I'll be updating the function list first. Unfortunately I can't do it on Xelerus - Adding in new entries apparently deletes older entries (and various other Xelerus related problems). So the documentation will have to be on the wiki, but I'll try and see if we can streamline searching through them a bit better.
 We were actually just discussing doing exactly that on IRC about three hours ago or so.
Image

My mods on Xelerus: Click here!

Of all the things I’ve lost in life, I miss my mind the least. (I’m having a lot more fun without it!)

User avatar
digdug
Fleet Admiral
Fleet Admiral
Posts: 2561
Joined: Mon Oct 29, 2007 9:23 pm
Location: Decoding hieroglyphics on Tan-Ru-Dorem

Re: What do you want documentation on?

Post by digdug » Tue Jan 17, 2017 12:39 pm

We might also need a tidy event list with all the populated variables .
And regarding the function list, probably priority should be given to the newish mission msnBbbb functions

User avatar
Shrike
Fleet Admiral
Fleet Admiral
Posts: 2618
Joined: Mon Aug 17, 2009 4:27 am
Location: Scouting the borders of sanity (there's a lovely view of the abyss).

Re: What do you want documentation on?

Post by Shrike » Tue Jan 17, 2017 9:28 pm

Xephyr wrote: And before you ask, "Everything" is not a valid (or very informative) answer.
......Almost everything? :P


Seriously speaking though, an updated function list would be a big one.
Your friendly local genderqueer weapons designer & forum moderator. My pronoun is "They".

Image
Shrike's Mines and Missiles++. Includes parts of the old Auton Overhaul and Allegedly Superior Sounds mods as well as an updated version of the MOTM-winning SM&M! Designed for Version 1.6.3

Post Reply

Who is online

Users browsing this forum: No registered users and 2 guests