Jump to content

Improving the documentation for modding


Recommended Posts

I think we can do some better work on our modding documentation. Here are some things that ought be done IMO:

  • Improve the wiki. This is a major thing and where I think the community (y'all) can help out most. We have some resources, but it's not very up-to-date or exhaustive, unfortunately.
  • Better C++/JS interface documentation:
    • Some of it can be on the wiki: How to use the range manager? How to use the Modifiers manager? & all other system/C++ components.
    • Some of it should probably go into improving docs.wildfiregames.com
    • Maybe we ought to auto-generate a list of 'Engine.XX' functions, too. Or at least document what exists now.
  • We could definitely use a list of messages somewhere.

Some of this only developers will be able to do. Some of this you can help with (mostly the Wiki). I think it'd be great if people added their own frustration to this list, so that we can have a good idea what ought to be added.

  • Like 7
Link to post
Share on other sites
4 hours ago, wraitii said:

I think it'd be great if people added their own frustration to this list

It would be nice if there would be a guide in editing xml files aswell (if there is one, i havent found it). They aren't hard to mod but it is hard to know what elements/attributes can or cannot be used inside them, and strolling past each file to find something you can use (which may not even exist) is a pain in the ass tbh. So im basically suggesting for a reference list on what is possible inside xml files. On top of that, a tutorial to incorperate new elements inside xml to work with your js code.

just my 2 cents.

Link to post
Share on other sites
52 minutes ago, Grapjas said:

It would be nice if there would be a guide in editing xml files aswell (if there is one, i havent found it). They aren't hard to mod but it is hard to know what elements/attributes can or cannot be used inside them, and strolling past each file to find something you can use (which may not even exist) is a pain in the ass tbh. So im basically suggesting for a reference list on what is possible inside xml files. On top of that, a tutorial to incorperate new elements inside xml to work with your js code.

just my 2 cents.

http://docs.wildfiregames.com/entity-docs/trunk.html

  • Thanks 1
Link to post
Share on other sites

A syntax highlighting text editor is also useful for creating/editing those XML files that would be notepad++ on Windows(also json files) on Linux all of the default text editors have it not being a OSX user not sure of what is available just pick the right language for each file first.

Enjoy the Choice :) 

Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.

×
×
  • Create New...