MovingBlocks

Improve wiki page for DS json details

Improve wiki page for DS json details

Destination Sol uses some JSON files to configure how the different solar systems work, what kinds of equipment ships start with, what loot drops, and so on. The current wiki documentation doesn't quite cover everything, so this task is meant to go over it and cover any missing details.

For instance in systemConfig.json there are lines like the following: "items": "core:fixedGun 0.5|core:lightArmor 0.75|core:smallShield+core:shield" - what is the meaning of the | and + ? Find out and document it somewhere! Same for anything else you can find that isn't currently covered in the wiki

Definition of 'Done'

  • You've identified and fixed several omissions in the DestSol wiki and edited them into existing or new pages (such as what the + means)
  • Supply a link to a page you've changed and explain what

Where to start

  • Study the existing wiki, such as the JSON Tutorial and the Creating a Ship page
  • Look at some of the JSON files like systemConfig - look for interesting stuff that doesn't seem obvious. Is it described anywhere in the wiki?
  • Edit the file and see if you can figure out what happens! Then document it
  • The core module is a fantastic resource, and much of the documentation you'll write can be derived from the json configuration files in it.

See also

Task tags

  • json
  • documentation
  • configuration
  • conventions

Students who completed this task

Phoenix909

Task type

  • chrome_reader_mode Documentation / Training
  • assessment Outreach / Research
close

2018