gabber235/TypeWriter

Rewrite Facts Documentation

Closed this issue · 6 comments

gabber235 commented

Description

Looking at the facts documentation page it is very outdated and needs to be rewritten.

Thinks to rework:

  • Add section on why you would want to use facts/why are they useful.
  • Explain the two base types of facts, Readable and Writable. Some fact types are both, others are read-only. Readable facts can be used in the criteria of an entry. Writable can be used in the modifiers.
  • List various possibilities to use facts and explain which one could be used.
    • An example of this could be. Gathering items quest where a player taks to an npc and needs to gather items. This would include the Inventory Item Count Fact when the user talks to the npc
    • Another example could be to use a Permanent Fact for keeping track of progression. Like (0 is not started) (1 is talked to an npc) (2 is done some action) (3 is finished quest). Make a little story with this to make it specific to a situation.
    • Include at least 3 more, preferably 5.
  • From the previous list give a step by step instruction on how to set up for only 1 (though somewhat complex)

Any additional additions are more than welcome!

Required

  • Some git experience to clone the repo, make the changes and create a pull request.

I want to help

Great! Reply with I want to claim this bounty!. Only claim if you have time. We want to get this bounty out of the way as quickly as possible!

Then fork the repository and switch to the feature/documentation branch.

Gc-network commented

I want to claim this bounty!

  • 👍1
vignan37 commented

I want to claim this bounty!

gabber235 commented

@vignan37

I want to claim this bounty!

@Gc-network was quicker so I'll give him the bounty. That said, I see you can code. Could you help me out with #99? If so leave a comment there!

vignan37 commented

@gabber235 This was my first bounty tast 🥲! But thats fine. Anyway I would love to help, and one question, can I get bounty for #99?

gabber235 commented

@Gc-network This was my first bounty tast 🥲! But thats fine. Do I get bounty for #99?

Yea @vignan37 will work together on it. When completed I'll give you the bounty hunter role :)

Bdw keep the pr for this open, when @Gc-network has done his part. I will likely combine them to get the best of both.

  • 👍1
vignan37 commented

Sure @gabber235 🍻