New Category

You want to create a new category? mm, 'kay

Open the folder with VSCode. Inside the folder sidebar, open jsons/packs. Create a new file called <category>.json. Inside it, add the necessary keys

JSON Format

{
  "$schema": "https://becomtweaks.github.io/schema/packs.json",
  "topic": "<category name>",
  "subcategory_of": "<category name>",
  "location": "<category location>",
  "packs": []
}

The required keys are topic and packs while $schema helps for autocomplete (important!)

Topic

• The name of the category. Used to identify the category as well in the backend and frontend.

• Must be a non-empty string.

Subcategory of

• The name of the parent category. No use in backend, shows up only in the frontend.

• Must be a non-empty string, but can be left out.

Location

• The location where the category is located at. Used by backend to find where the packs are located at.

• Must be a non-empty string, but can be left out. Defaults to the topic key in all lowercase

Packs

• The list of dictionaries, referencing to each pack

After making the category, head over to /packs then create a new folder either called <topic in lowercase> or <key location>. Continue with creating the new packs using https://github.com/BEComTweaks/docs/blob/main/gitbook/creating-a/creating-a/new-pack.md

Final Setup

There are a two extra files you need to change before you are done.

• jsons/pack_order_list.txt

  Insert the category's json file name somewhere in that file. When making the website, it goes top down, with indentation for subcategories.

• webUI/app.js

  Add the following wherever you want in the categoryDicts constant.

  "<key topic">: [],

Now run

python pys/pre_commit.py --format --no-stash

And it should be reflected inside webUI/index.html. Open it up with any browser and you should see the new category!

Now follow Checks for creating a new Pull Request