Author Topic: does OXC has autogenerated offline ufopedia from mod content ?  (Read 7865 times)

Offline bladum

  • Colonel
  • ****
  • Posts: 213
  • Bladum
    • View Profile
does OXC has autogenerated offline ufopedia from mod content ?
« on: September 15, 2016, 09:42:03 am »
hello

Does OXC has any kind of automatic documentation / offline ufopedia generator ?

I am thinking about script that would search thru all content like items / armors / crafts / aliens etc and then put text and image together into one page for example html file. Something like https://canadianbeaver.github.io/AwesomeGuns/ but much simpler and made automatically.

Thanks
Tom

Offline Meridian

  • Global Moderator
  • Commander
  • *****
  • Posts: 8595
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #1 on: September 15, 2016, 10:04:59 am »
OXCE+ has a built-in Tech Tree Viewer: https://openxcom.org/forum/index.php/topic,4697.msg66743.html#msg66743

And I am working also on the "Ruleset Visualizer" with export to text file possibility: https://openxcom.org/forum/index.php/topic,4850.0.html
(one of the uses would be to make the work of people maintaining Piratez wiki easier... I think that might be what you're looking for)

Offline ohartenstein23

  • Commander
  • *****
  • Posts: 1931
  • Flamethrowers fry cyberdisk circuits
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #2 on: September 15, 2016, 02:46:55 pm »
To help me and IvanDogovich do the wiki editing for Piratez, I wrote a series of bash and Octave scripts to do just that - the ranged weapons article was generated with them, save for the text at the top.  If I was more comfortable with C++, I'd write something similar that could be more portable, but until that or Meridian's viewer happens, you'll have to either ruleset dive or code something up.  If you want to learn programming, it's a good starting project!

If you really want, I can send you my tools, but they need Linux and Octave, plus some editing, to do what you're looking for.

Edit: By the way, with Meridian's OXCE+, you can use the New Battle function to start a battle where you have all the techs unlocked, then middle-click any item to pull up the ufopaedia from the battlescape, letting you access all the mod's articles on items.
« Last Edit: September 15, 2016, 03:22:44 pm by ohartenstein23 »

Offline bladum

  • Colonel
  • ****
  • Posts: 213
  • Bladum
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #3 on: September 15, 2016, 05:55:20 pm »
Any chance to integrate ufopedia into vanilla ?

Btw i was rather thinking about something offline that could generate documentation like the one created for Piratez. Thanks.

Offline Meridian

  • Global Moderator
  • Commander
  • *****
  • Posts: 8595
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #4 on: September 15, 2016, 06:35:17 pm »
Any chance to integrate ufopedia into vanilla ?

What do you mean? Ufopedia is part of vanilla.

Btw i was rather thinking about something offline that could generate documentation like the one created for Piratez. Thanks.

My change is in-game and will be able to generate output offline.

Offline bladum

  • Colonel
  • ****
  • Posts: 213
  • Bladum
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #5 on: September 15, 2016, 10:35:26 pm »
Thanks Meridan,

I was think about inbuilt option to check stuff during game by entering ufopedia for a moment by middle click.

Tom

Offline Meridian

  • Global Moderator
  • Commander
  • *****
  • Posts: 8595
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #6 on: September 15, 2016, 11:09:52 pm »
Thanks Meridan,
I was think about inbuilt option to check stuff during game by entering ufopedia for a moment by middle click.
Tom

Yes, that is actually very easy to integrate.
It's just a few lines of code.
If DEVs show interest, I will prepare a PR.

Offline Stoddard

  • Colonel
  • ****
  • Posts: 485
  • in a fey mood
    • View Profile
    • Linux builds & stuff
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #7 on: September 16, 2016, 09:35:26 am »
There's also the https://github.com/StoddardOXC/minicom/blob/master/modloader.py

It reads up enabled mods' rulesets and merges the data so you end up with a giant python dict contating all the rules (and also a translation).

After that, generating reports is quite trivial. 


Offline oftcrash

  • Sergeant
  • **
  • Posts: 22
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #8 on: October 14, 2016, 05:27:37 pm »
Wow, glad I found this. I was just starting to work on something a bit like this. Has anyone done anything with D3.js or similar for visualization outside the game?

Offline Meridian

  • Global Moderator
  • Commander
  • *****
  • Posts: 8595
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #9 on: October 14, 2016, 05:34:05 pm »
Wow, glad I found this. I was just starting to work on something a bit like this. Has anyone done anything with D3.js or similar for visualization outside the game?

https://techtreeviewer.byethost9.com/

Offline hellrazor

  • Commander
  • *****
  • Posts: 2013
  • Deep Ruleset Digger & Bughunter
    • View Profile
    • Github Account
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #10 on: October 14, 2016, 07:03:41 pm »
https://techtreeviewer.byethost9.com/

Is it possible to actually load that page without cookies?
Since it need to approve cookies manually.

Ok figured it out. But it does not work..

Needs to many cookies and javascript anyway...
« Last Edit: October 14, 2016, 07:06:17 pm by hellrazor »

Offline oftcrash

  • Sergeant
  • **
  • Posts: 22
    • View Profile
Re: does OXC has autogenerated offline ufopedia from mod content ?
« Reply #11 on: October 14, 2016, 07:29:47 pm »
Is it possible to actually load that page without cookies?
Since it need to approve cookies manually.

Ok figured it out. But it does not work..

Needs to many cookies and javascript anyway...

I must still be missing something. I'm getting:
Quote
Failed to parse SourceMap: https://techtreeviewer.byethost9.com/lib/backbone-min.map
I'm using Chrome on Mac. I haven't delved into the source yet, in case there's a simple solution that I'm just missing.