DestinationSol icon indicating copy to clipboard operation
DestinationSol copied to clipboard

Better Documentation

Open vampcat opened this issue 7 years ago • 10 comments

The DestSol wiki is pretty bare right now. Instead of a giant "Creating Content" page, we need specialized, detailed pages for the following:

  • ~General info~ Adrijaned
  • Asset System (general principles, explaining things like module:assetName)
  • Factions
  • ~Ships~ TheGhostInTheMachine
  • Guns
  • ~Projectiles~ digitalripperynr
  • Engines
  • ~Particle Emitters~ NicholasBatesNZ
  • ~Other helpful links (where we can link things like guides to json)~ Adrijaned

If anyone wants to help out, just mention in the comments what you are working on, I'll update this post accordingly.

vampcat avatar Jan 15 '18 19:01 vampcat

I'll try to document projectiles. Do I need to include clips in the same page or create another one ? So the basic idea would be : projectileconfig and textures making clips for projectiles to be use with guns(link to guns section) various properties of projectiles and clips

I'll try to include as many images as possible :)

arpitkamboj avatar Jan 18 '18 13:01 arpitkamboj

Probably do clips in the same page because they're pretty tightly coupled.

Steampunkery avatar Jan 18 '18 16:01 Steampunkery

Yup ! I'll combine those then.

arpitkamboj avatar Jan 18 '18 16:01 arpitkamboj

Added Getting started, which should supplement the Helpful links, since I was not capable of finding any good JSON tutorial. Also, includes some info about licensing and links to several interesting sites/tools

Adrijaned avatar Jan 19 '18 09:01 Adrijaned

I'll take ships. I just wrote a script to convert a box-2d json to a destsol json so I'll include a DL link to that.

Steampunkery avatar Jan 20 '18 18:01 Steampunkery

Hey, can we implement this? It allows for custom sidebar order, which would be nice.

Steampunkery avatar Jan 20 '18 18:01 Steampunkery

GH already allows for a custom sidebar - even TS uses one. Just click on the "custom sidebar" or whatever button, and it'll bring up an md for you to edit.

vampcat avatar Jan 21 '18 00:01 vampcat

@vampcat Take a look at the "Creating a Ship" page as well as the "Abilities" page. I also modified the "Creating Content" page.

Steampunkery avatar Jan 22 '18 04:01 Steampunkery

Projectiles and Clips page is complete. I'll start with guns when I get time.

arpitkamboj avatar Jan 22 '18 12:01 arpitkamboj

@vampcat Particle Emitters has been done

NicholasBatesNZ avatar Jan 25 '18 23:01 NicholasBatesNZ