Here's an idea for Construct

Discussion and feedback on Construct 2

Post » Sun Jun 28, 2015 8:53 pm

I would like an export function for comments. Where Construct saves all the comments in a text file as documentation. A documentation of what has been done in the event sheet where I can look at the order of events and the flow in an easier way.

What do you guys think, will this be useful for anyone else besides me? Do you feel you're missing this feature?
Last edited by Mr X on Sun Jun 28, 2015 9:12 pm, edited 1 time in total.
B
7
S
1
Posts: 37
Reputation: 509

Post » Sun Jun 28, 2015 9:02 pm

This isn't difficult, as the event sheets are XML, so all you need to do is parse those files and read them in. A small Python script could do it.
My tutorial through development blog is at http://myconstruct2dev.blogspot.co.uk/
B
12
S
3
Posts: 221
Reputation: 1,328

Post » Mon Jun 29, 2015 10:40 am

Only the comments? Would that even make sense if they are taken out of the context of what they are describing?
Scirra Founder
B
398
S
236
G
88
Posts: 24,433
Reputation: 194,635

Post » Mon Jun 29, 2015 11:10 am

The initial idea I had is that I want the events/the game to be documented. What is happening, and when etc. Would it make more sense if you extended the idea and export a flowchart of what's happening in the events together with the comments?

So, an idea of documentation and a good overview, some kind of visual feature showing the logics and flow. I don't know maybe you could just think about it?
B
7
S
1
Posts: 37
Reputation: 509

Post » Mon Jun 29, 2015 11:47 am

this i a great example of documentation generated straight from the sourcecode, and everything interlinks, some of these concepts would be amazing in construct

http://docs.openttd.org/functions_vars_0x65.html#index_e
ImageImage
B
70
S
21
G
7
Posts: 827
Reputation: 10,052

Post » Mon Jun 29, 2015 11:52 am

Very good example. That's one way to do it.
B
7
S
1
Posts: 37
Reputation: 509

Post » Mon Jun 29, 2015 11:55 am

@Ashley, one can comment a few events, or actually make some proper documentation, within the event sheet.

Lots of product requirement specifications and such work with documentation directly derived from commented code.

It is not such a bad idea, as it could add a bit of extra professionalism to those indies wanting to take being a developer another step further. by means of decent documentation and manuals.


The idea of extending it with a flow chart would be bad ass too though.
-If the concept of the written code is too tough for someone to understand, having it represented in a flow chart would definitely help understanding. Teacher and student aspects alike.

-Or representing your creation in a presentation with a team or stakeholders.

-Perhaps the flow chart could also be used as sort of a manual image/pdf export for parts of the event sheets.

For instance:

using a gamepad in the events
You comment several triggers with what that event for the gamepad does,

Then, perhaps have an option in the toolbar to export an event sheet or group.
An image with the game pad is exported with the comments next to the button.

this image/file could be perhaps be called in game run time too, as an layered image, identifying the buttons. (transparent background, controller in the middles, little texts next to the button)


This same file and other comments could perhaps be exported in total too to a pdf with images, which in turn can be used as documentation and or parts of it used in game descriptions, controller information, creation and workings description.


sorry if I rattled on a bit :lol:
Who dares wins
B
57
S
17
G
21
Posts: 1,878
Reputation: 19,572

Post » Mon Jun 29, 2015 11:59 am

Thanks for confirming the need of such features from a user perspective. Keep the ideas coming. :)
B
7
S
1
Posts: 37
Reputation: 509

Post » Mon Jun 29, 2015 12:02 pm

Mr X wrote:Thanks for confirming the need of such features from a user perspective. Keep the ideas coming. :)


Whilst I agree it would be useful, I would hardly say it's 'needed'.
If your vision so exceeds your ability, then look to something closer.
Moderator
B
134
S
30
G
86
Posts: 5,420
Reputation: 59,526

Post » Mon Jun 29, 2015 7:13 pm

I do also believe it's a nice idea but not something needed.

And to be fair, paulscottrobson already said it, the eventsheet files are xml, with clear <comment> tags and attributes, what is actually needed is a parser for those at the moment, not really another exporter.
Doxygen is an old documentation tool that does such a parsing job out of C++ source files. It reads them and due to C++ nature, it spits all the commented lines, with function names according to a specific syntax.

The same kind of tool could be written and parsing current XML files out of the "Event sheets" folder of any C2 project. And I think it would be best to make it a third-part tool rather than asking Ash to spend some time on it.

Flow charts sound badass, but I'm not sure it is absolutely doable. There could be great issues between the required syntax/event placement for it to be documented and the actual event placement for the game's logic to work as intended. This I could understand Ashley spending some time on. Although it's not a critically required feature.
New to Construct ? Where to start

Image Image

Image Image

Please attach a capx to any help request or bug report !
Moderator
B
292
S
115
G
96
Posts: 7,295
Reputation: 70,795

Next

Return to Construct 2 General

Who is online

Users browsing this forum: adelwich and 22 guests