From 991e50d79c642ead3415c058e1ec6263d5880b4e Mon Sep 17 00:00:00 2001 From: Unstable Kitsune Date: Fri, 5 Sep 2025 03:59:00 -0400 Subject: [PATCH] docs: Introduce 9tailedKitsune documentation files Adds introduction to folder structures, keywords, comments, numbers, operators, and delimiters Includes detailed comment syntax and usage examples for various types Introduces logging documentation framework --- 9tK-Comments.md | 51 +++++++++++++++ 9tK-Logging.md | 2 + 9tailedKitsune-Introduction.md | 112 +++++++++++++++++++++++++++++++++ 3 files changed, 165 insertions(+) create mode 100644 9tK-Comments.md create mode 100644 9tK-Logging.md create mode 100644 9tailedKitsune-Introduction.md diff --git a/9tK-Comments.md b/9tK-Comments.md new file mode 100644 index 0000000..40bf725 --- /dev/null +++ b/9tK-Comments.md @@ -0,0 +1,51 @@ +9tK-Comments.md + +9tailedKitsune comes with 3 types of comments that will found through out. +All comment types will have a __**Hashtag**__ followed by another unique symbol at the beginning, +Each comment type has its own color, making it easier to tell which comment is which. +The 3 types of comments are as follows... +## Comment Index +- **Major Issues**, + - Color: RED + -# For Major System Breaking Issues & Comments. + - Open: `.#` + - Close: `#.` +- **Minor Issues**(y), + - Color: YELLOW + -# For Minor System Non Breaking Issues & Comments. + - Open: `#?` + - Close: `?#` +- **Green Light**(g) + - Color: Green + -# For Mostly Informational Needs or No issues + - Open: `#+` + - Close: `+#` + +## Usage Example + +### Major Issues -or- Comments +``` +.# Comment test #. +.# this is an example #. +.# of how to use Minor #. +.# comments in 9tK! #. +``` +### Minor Issues -or- Comments +``` +#? +Comment test +this is +an example +of how to +use Minor +comments +in 9tK! +?# +``` +### Non Issue -or- Comments +``` +#+ Comment test +# +#+ this is an example +# +#+ of how to use Minor +# +#+ comments in 9tK! +# +``` \ No newline at end of file diff --git a/9tK-Logging.md b/9tK-Logging.md new file mode 100644 index 0000000..af1ebdb --- /dev/null +++ b/9tK-Logging.md @@ -0,0 +1,2 @@ +9tK-logging.md + diff --git a/9tailedKitsune-Introduction.md b/9tailedKitsune-Introduction.md new file mode 100644 index 0000000..e5edd0f --- /dev/null +++ b/9tailedKitsune-Introduction.md @@ -0,0 +1,112 @@ +# FOLDER & DEFAULT + + ## Folding in Code 1: `#DDFF00` + - Open: - `+<` + - Middle: + - Close: - `-> ` + + ## Folding in Code 2: `#DDFF00` + - Open: + - `:if` + - `` + + ## Folding in Comment: GREY + - Open: + - `#+.` + - Middle: + - Close: + - `#-.` + +# KEYWORDS LISTS + + ## Prefix_Mode: ( + Keywords 1: true + Keywords 2: true + Keywords 3: true + Keywords 4: true + Keywords 5: true + Keywords 6: true + Keywords 7: false + Keywords 8: false + ) + - Gold -or- Neutral Group 1: < + - set fix while return call log function spawn execute define const get find > + - Green -or- Positive Group 2: < + - pull sync include loop print display true write create draw play emit cast attack update > + - Red -or- Negitive Group 3: < + - drop part exclude loopd hide unsync false erase clear delete remove downgrade > + - Blue -or- Variables Group 4: < + - var opt string number boolean array object null target > + - Orange -or- Foundry API Group 5: < + - actor token race class item feat skill spell effect droll sroll vroll journalEntry compendium rollTable > + - Yellow -or- Foundry Character Group 6: < + - name gender level strength dexterity constitution intelligence wisdom charisma ac hp defense initiative > + - Purple -or- Foundry Char Effect Group 7: < + - grapple stun paralyze blind deaf bless bane rage haste slow burn froze toxic wet > + - Hyperlink Blue Foundry Links Group 8: < + - `@UUID[]{} @Compenium[]{} @JournalEntry[]{} :// http:// ftp:// https:// ftps:// mailto:// steam:// 9tK:// kit:// kitsune:// sune://` > + +# COMMENT & NUMBER + + - Comment Line: RED + - Open: `` + + - Comment: GREEN + - Open: `#/` + - Close: `/#` + + - Number: + - Prefix 1: + - Extras 1: + - Suffix 1: , + - Range: + - Prefix 2: + - Extras 2: + - Suffix 2: , + - Decimal: Both + +# OPERATORS & DELIMITERS> + + - Operator 1: GOLD + - Args: `@ : ;` + - Operator 2: + - Args: and or not is was equal before after now to from as in + - Delimiter 1: SKYBLUE + - Open: ' + - Escape: + - Close: ' + - Delimiter 2: YELLOW + - Open: <# + - Escape: + - Close: #> + - Delimiter 3: + - Open: + - Escape: + - Close: + - Delimiter 4: + - Open: + - Escape: + - Close: + - Delimiter 5: + - Open: + - Escape: + - Close: + - Delimiter 6: + - Open: + - Escape: + - Close: + - Delimiter 7: + - Open: + - Escape: + - Close: + - Delimiter 8: + - Open: + - Escape: + - Close: \ No newline at end of file