Update TOC (#140)

* Update the table of contents * Update the table of contents * Update VS_linter.md * Update Generator_toc.yml * Update Professions_catalogue.md * Update Installation_guide.md * Update Installation_Times_for_Gun_Mods.md * Update Learning_Code.md * Update Override_a_variable.md * Update Updating_Legacy_JSON.md * Update VS_linter.md * Update Generator_toc.yml * Update Professions_catalogue.md * Update Generator_toc.yml * Update Professions_catalogue.md * Update Generator_toc.yml * Update .typo-ci.yml Update TOC (#138) * Update the table of contents * Update the table of contents * Update VS_linter.md * Update Generator_toc.yml * Update Professions_catalogue.md * Update Installation_guide.md * Update Installation_Times_for_Gun_Mods.md * Update Learning_Code.md * Update Override_a_variable.md * Update Updating_Legacy_JSON.md * Update VS_linter.md * Update Generator_toc.yml * Update Professions_catalogue.md * Update Generator_toc.yml * Update Professions_catalogue.md * Update Generator_toc.yml * Update .typo-ci.yml * Update TOC * remove generated with in mds * remove generated with in mds Update TOC (#139) * Update TOC * remove generated with from md Update TOC (#140) Co-Authored-By: TheGoatGod <TheGoatGod@users.noreply.github.com> Co-Authored-By: TheGoatGod <xXMartinDXx@gmail.com> Co-Authored-By: TheGoatGod <56883303+TheGoatGod@users.noreply.github.com>
GMC-Modding-Team · Aug 4, 2021 · c1ff5f2 · c1ff5f2
1 parent 6647b3a
commit c1ff5f2
Show file tree

Hide file tree

Showing 107 changed files with 1,285 additions and 35 deletions.
diff --git a/.github/workflows/Generator_toc.yml b/.github/workflows/Generator_toc.yml
@@ -3,7 +3,14 @@ on:
     branches:
     - master
     paths:
+    - '*.md'
     - '**/*.md'
+    - '**/*/*.md'
+  pull_request:
+    paths:
+    - '*.md'
+    - '**/*.md'
+    - '**/*/*.md'
 
 name: Generator - TOC
 jobs:
@@ -17,10 +24,10 @@ jobs:
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v3
         with:
-          commit-message: Update the table of contents
+          commit-message: Update TOC
           branch: Update-toc
-          title: Update the table of contents in documents
+          title: [GitHub] Update TOC
           body: |
-            ```sh
-            npx doctoc **/*.md --github
+            ```md
+            - [x] Update TOC
             ```
diff --git a/.typo-ci.yml b/.typo-ci.yml
@@ -205,3 +205,4 @@ excluded_words:
   - Whatelys
   - Cecaelian
   - alc
+  - edit-playernpcs
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,18 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Changelog](#changelog)
+  - [Unreleased](#unreleased)
+  - [v0.2.0-beta-experimental (2021-07-19)](#v020-beta-experimental-2021-07-19)
+  - [V0.1.9 (2021-05-14)](#v019-2021-05-14)
+  - [V0.1.8 (2021-04-15)](#v018-2021-04-15)
+  - [0.1.8 (2021-04-03)](#018-2021-04-03)
+  - [V0.1.7 (2021-03-07)](#v017-2021-03-07)
+  - [v0.1.6 (2021-02-18)](#v016-2021-02-18)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Changelog
 
 ## [Unreleased](https://github.com/GMC-Modding-Team/Community-Mod-Compilation-redux/tree/HEAD)

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,3 +1,17 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct)
+  - [Our Pledge](#our-pledge)
+  - [Our Standards](#our-standards)
+  - [Our Responsibilities](#our-responsibilities)
+  - [Scope](#scope)
+  - [Enforcement](#enforcement)
+  - [Attribution](#attribution)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 - [Description](#description)
 - [Road map](#road-map)
-  - [Goats - Dark Days](#goats---dark-days)
+  - [Cataclysm: Goats Dark Horizons](#cataclysm-goats-dark-horizons)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 [![Build_Number](https://img.shields.io/badge/CDDA_Build%3A-%2311458-blue)](https://github.com/CleverRaven/Cataclysm-DDA)

diff --git a/data/Legacy_mods/mods/bio_mod/README.md b/data/Legacy_mods/mods/bio_mod/README.md
@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [BioCo](#bioco)
+- [Getting Started](#getting-started)
+- [The Assembly Machine](#the-assembly-machine)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # BioCo
 
 BioCo is a mod created for Cataclysm; Dark Days ahead with the goal of reintroducing CBM creation and manipulation, along with new tools/machinery to accomplish this.

diff --git a/data/Mainline_mods/Mods/Aftershock/README.md b/data/Mainline_mods/Mods/Aftershock/README.md
@@ -1,3 +1,24 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Design Document](#design-document)
+    - [Areas seeking contributors](#areas-seeking-contributors)
+- [Here be dragons!](#here-be-dragons)
+    - [itemgroups](#itemgroups)
+    - [items](#items)
+    - [maps](#maps)
+    - [mobs](#mobs)
+    - [monsterdrops](#monsterdrops)
+    - [mutations](#mutations)
+    - [player](#player)
+    - [recipes](#recipes)
+    - [vehicles](#vehicles)
+    - [npcs](#npcs)
+    - [spells](#spells)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Design Document
 * Aftershock is being developed into a full conversion mod set in a mostly-abandoned extrasolar colony named Salus IV.  The player has arrived on Salus for various reasons (depending on their profession).  Eventually, we hope to have multiple potential end game situations, ranging from finding what you came here for and leaving the planet with enough money to retire, to more-secret endings.  There will no longer be zombies; instead, there are a variety of alien and human-based enemies.  Toe-to-toe combat will likely be more deadly in Aftershock, with more emphasis on picking your battles and only fighting when absolutely necessary.  Special locations may have a different combat aesthetic; for example, you may enter a dungeon-like zone with hordes of small weak enemies that can't be avoided.  As part of this concept, in which different situations require different solutions, we have implemented bionic slots but made the process of changing out CBMs much easier with less chance of failure.  This is to encourage players to change their loadout based on where they are going and what they are doing.
 * As it becomes a total conversion mod, it will look very different from the base game of Cataclysm: Dark Days Ahead and may not interact kindly with other mods.  If you've been away for a while, you may wonder where some parts of Aftershock have gone.  In the process of becoming a total conversion mod, we are eliminating items that no longer fit the theme.  For example, all the Mad Max aesthetics have been removed.  Any additions must either fit the general theme or have story-driven reasons for the divergence, such as NPC quests to special locations.

diff --git a/data/Mainline_mods/Mods/Aftershock/crafting_system.md b/data/Mainline_mods/Mods/Aftershock/crafting_system.md
@@ -1,3 +1,19 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Scrap Crafting System](#scrap-crafting-system)
+  - [Overview](#overview)
+    - [Current Scrap Categories](#current-scrap-categories)
+  - [Scrap Tiers Briefly Explained](#scrap-tiers-briefly-explained)
+    - [Tier 1](#tier-1)
+    - [Tier 2](#tier-2)
+    - [Tier 3](#tier-3)
+    - [Tier 4](#tier-4)
+    - [Tier 5](#tier-5)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Scrap Crafting System
 
 ## Overview

diff --git a/data/Mainline_mods/Mods/CRT_EXPANSION/readme/README.md b/data/Mainline_mods/Mods/CRT_EXPANSION/readme/README.md
@@ -1,3 +1,14 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [C.R.T Expansion mod pack](#crt-expansion-mod-pack)
+- [Extended Techniques](#extended-techniques)
+- [For those curious about stat scaling:](#for-those-curious-about-stat-scaling)
+- [Dead Space](#dead-space)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # C.R.T Expansion mod pack
 The core mod of the CRT Expansion mod pack, it currently adds an armor set, mildly OP gas mask and transforming vest, some gun mods, a new melee/tool and a new material. The items also use a lot of higher end materials such as superalloy, rubber (the "new" material), the lesser used hardsteel and also neoprene.
 

diff --git a/data/Mainline_mods/Mods/Dark-Skies-Above/DESIGN.md b/data/Mainline_mods/Mods/Dark-Skies-Above/DESIGN.md
@@ -1,3 +1,21 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Dark Skies Above](#dark-skies-above)
+- [Summary of Intent and Content](#summary-of-intent-and-content)
+- [Contributing](#contributing)
+- [Content](#content)
+  - [The World](#the-world)
+  - [The Arrival and The Aliens](#the-arrival-and-the-aliens)
+  - [Other Aliens](#other-aliens)
+  - [Alien Technology](#alien-technology)
+  - [The Player](#the-player)
+  - [The Resistance and the Narrative](#the-resistance-and-the-narrative)
+  - [Other NPCs](#other-npcs)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Dark Skies Above
 
 This document is intended to not only guide new potential contributors, but also help get my own thoughts on how the game will progress in text. Assume spoilers beyond this point!

diff --git a/data/Mainline_mods/Mods/Dark-Skies-Above/README.md b/data/Mainline_mods/Mods/Dark-Skies-Above/README.md
@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Dark Skies Above](#dark-skies-above)
+- [Takeaway Features](#takeaway-features)
+- [Meta](#meta)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Dark Skies Above
 A partial conversion mod for Cataclysm: DDA, taking inspiration from XCOM 2, Half Life 2, and similar 'alien invasion' media to present a game of survival against an alien occupation force. WIP, but will feature new quests, NPCs, locations, and enemies.
 

diff --git a/data/Mainline_mods/Mods/Dark-Skies-Above/TODO.md b/data/Mainline_mods/Mods/Dark-Skies-Above/TODO.md
@@ -1,3 +1,14 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [List of Short Term Tasks](#list-of-short-term-tasks)
+  - [JSON](#json)
+  - [Code](#code)
+- [Mid Term Ideas](#mid-term-ideas)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # List of Short Term Tasks
 
 In order to keep Dark Skies Above moving and to not get overwhelmed, I'm creating lists of achievable, short term tasks that need to done.  These lists should be periodically updated as items are completed.

diff --git a/data/Mainline_mods/Mods/DinoMod/DESIGN.md b/data/Mainline_mods/Mods/DinoMod/DESIGN.md
@@ -1,3 +1,17 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Design Document SPOILERS AHEAD](#design-document-spoilers-ahead)
+- [What belongs in DinoMod?](#what-belongs-in-dinomod)
+- [Realism vs. Fun](#realism-vs-fun)
+- [Adding, replacing, removing](#adding-replacing-removing)
+- [How to contribute](#how-to-contribute)
+- [Where should new dinosaurs spawn?](#where-should-new-dinosaurs-spawn)
+- [How to add a dinosaur](#how-to-add-a-dinosaur)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Design Document SPOILERS AHEAD
 The core idea of DinoMod is this: https://tvtropes.org/pmwiki/pmwiki.php/Main/EverythingsBetterWithDinosaurs
 The purpose of this mod is to make Cataclysm a more fun game to play and develop for, showing off new mechanics and bringing life to parts of the game that aren't as well-developed.

diff --git a/data/Mainline_mods/Mods/DinoMod/README.md b/data/Mainline_mods/Mods/DinoMod/README.md
@@ -1,3 +1,12 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [DinoMod](#dinomod)
+- [Takeaway Features](#takeaway-features)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # DinoMod
 A content addition mod for Cataclysm: DDA, adds dinosaurs to fight, befriend or just to add something fun and new. Intended to work with all other vanilla-DDA based mods, but probably not total conversions.
 

diff --git a/data/Mainline_mods/Mods/Magiclysm/lore.md b/data/Mainline_mods/Mods/Magiclysm/lore.md
@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [History](#history)
+- [Classes](#classes)
+    - [Class Characteristics](#class-characteristics)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # History
 Magic is a rather spiritually draining experience.
 It's just not very comfortable using your mana pool.

diff --git a/data/Mainline_mods/Mods/Magiclysm/magic_balance.md b/data/Mainline_mods/Mods/Magiclysm/magic_balance.md
@@ -1,3 +1,26 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Spells](#spells)
+    - [Difficulty](#difficulty)
+    - [Max Level](#max-level)
+    - [Attack Stats](#attack-stats)
+    - [Effect](#effect)
+    - [Energy Source](#energy-source)
+    - [Casting Time](#casting-time)
+    - [Energy Cost](#energy-cost)
+    - [Fields](#fields)
+    - [Damage Type](#damage-type)
+    - [Valid targets](#valid-targets)
+  - [Tier Examples:](#tier-examples)
+    - [Tier 0](#tier-0)
+    - [Tier 1](#tier-1)
+    - [Tier 2](#tier-2)
+    - [Tier 3](#tier-3)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Spells
 Spells are incredibly versatile, and can range wildly depending on the JSON values that are assigned to them. As such, spells can be said to reside in various "tiers" that are based on their stats. The tier of spell is not listed in game, but can be derived based on several factors.
 

diff --git a/data/Maintained_mods/mods/CulinaryDaysAhead/README.md b/data/Maintained_mods/mods/CulinaryDaysAhead/README.md
@@ -1,3 +1,12 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Culinary Days Ahead](#culinary-days-ahead)
+  - [Recipes](#recipes)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Culinary Days Ahead
 
 ## Recipes

diff --git a/data/Maintained_mods/mods/Locked_and_Loaded/README.md b/data/Maintained_mods/mods/Locked_and_Loaded/README.md
@@ -1,3 +1,11 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Locked and Loaded](#locked-and-loaded)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Locked and Loaded
 Adds more guns and ammo types for those gun nuts.
 

diff --git a/data/Maintained_mods/mods/More_Survivors_Stories/README.md b/data/Maintained_mods/mods/More_Survivors_Stories/README.md
@@ -1,3 +1,12 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Not everyone turned into zombies. Some still struggling to live...](#not-everyone-turned-into-zombies-some-still-struggling-to-live)
+  - [How to get to Hell's Raiders story line:](#how-to-get-to-hells-raiders-story-line)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Not everyone turned into zombies. Some still struggling to live...
 
 Adds 5 new side stories (1 WIP), 1 mission for random NPCs and a story line for Hell's Raiders faction (in early stage of development, fully playable, currently have a decent amount of content).

diff --git a/data/Maintained_mods/mods/No_Hope_Night_Pryanik/README.md b/data/Maintained_mods/mods/No_Hope_Night_Pryanik/README.md
@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [No-Hope](#no-hope)
+- [List of features](#list-of-features)
+- [Translation](#translation)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # No-Hope
 
 The mod is based on the old lore where there was a full-scale war with China with many months of preceding marauding and civil disorder. Thus the world with the mod will be much more damaged overall, there will be much less loot etc.

diff --git a/data/Maintained_mods/mods/Nocts_cata_mod/README_DDA.md b/data/Maintained_mods/mods/Nocts_cata_mod/README_DDA.md
@@ -1,3 +1,23 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [Expansion mod for Cataclysm, Dark Days Ahead version](#expansion-mod-for-cataclysm-dark-days-ahead-version)
+  - [Special Thanks](#special-thanks)
+  - [Frequently Asked Questions](#frequently-asked-questions)
+      - ["The zombie super scout (insert event where it killed your char)!"](#the-zombie-super-scout-insert-event-where-it-killed-your-char)
+      - [Why do you have books that level you up from 0-10? Isn't that a bit broken?](#why-do-you-have-books-that-level-you-up-from-0-10-isnt-that-a-bit-broken)
+  - [Here is my github for this project](#here-is-my-github-for-this-project)
+  - [Contributing](#contributing)
+      - [Suggestions](#suggestions)
+      - [Reporting bugs](#reporting-bugs)
+      - [Modifying the code](#modifying-the-code)
+      - [Github Rules](#github-rules)
+- [Warning: Spoilers Ahead!](#warning-spoilers-ahead)
+      - [To do](#to-do)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Expansion mod for Cataclysm, Dark Days Ahead version
 
 The version of this mod in this folder is is for Cataclysm: Dark Days Ahead. Copy the folder containing this content into data/mods if you are using that version of Cataclysm. Use the other folder, nocts_cata_mod_BN if you are playing with Cataclysm: Bright Nights.

diff --git a/data/No_mods/Mods/No_Freeze/README.md b/data/No_mods/Mods/No_Freeze/README.md
@@ -1,3 +1,13 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [No Freeze](#no-freeze)
+- [Version 1.6](#version-16)
+- [Version 1.5](#version-15)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # No Freeze
 
 Whatcha see is whatcha get. No frills, no decor, no excess. All food items (including water!) have their freezing point lowered to -1000f.

diff --git a/data/No_mods/Mods/No_Makeshift_Firearms/README.md b/data/No_mods/Mods/No_Makeshift_Firearms/README.md
@@ -1,3 +1,11 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [No-Makeshift-Firearms-Mod](#no-makeshift-firearms-mod)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # No-Makeshift-Firearms-Mod
 A small exclusion mod that removes crafted pipe and scrap metal firearms that fire conventional cartridges from Cataclysm-DDA.
 

diff --git a/data/No_mods/NO! mod starter kit.md b/data/No_mods/NO! mod starter kit.md
@@ -1,3 +1,11 @@
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  
+
+- [NO! Mod Starter Kit](#no-mod-starter-kit)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # NO! Mod Starter Kit
 Have something you want to remove from the game? Perhaps the katana feels particularly overpowered, or the acid zombies just don't sit right with you. And, of course, you can't just settle for one of the already created mods. They don't have the right combination of features, remove too much, remove too little, and just generally are a nuisance to maintain. So, you want to create your own.