# Getting Started

Oh, so you want to start? Make sure you have the following on your machine

Terminal

* Most important! You can use the bare minimum, but it can break the colourful texts that Python's rich module uses

[Python 3](https://www.python.org/downloads/):

* Used for pre-commit 'hook'

[NodeJS](https://nodejs.org/en/download):

* Required if you are working on [BEComTweaks/server-backend](https://github.com/becomtweaks/server-backend)

[pnpm](https://pnpm.io/installation) with npm:

* Required for prettier in pre-commit 'hook' and installing NodeJS modules

Code Editor:

* Preferably VSCode, as JSON schemas are auto-filled in, but you can choose to use Notepad++ or Neovim/Vim

[Git](https://git-scm.com/downloads):

* Required to push and pull changes

Once you know you have the above tools, you can continue now!

### Forking the Repo

Head over to the repo you want

<figure><img src="https://2366158047-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIvu2VTNnSMlASsMTkD8J%2Fuploads%2F5pM8w9t1o0TjA4lf9iEL%2Fimage.png?alt=media&#x26;token=59c5cc61-3b1f-4a64-9a40-b77dea7b456f" alt=""><figcaption><p>E.g.: Using BEComTweaks/resource-packs</p></figcaption></figure>

Press the `Fork` button

![](https://2366158047-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIvu2VTNnSMlASsMTkD8J%2Fuploads%2FeBwBo4DnsaMAyhP8CfYK%2Fimage.png?alt=media\&token=14df8cb3-c49d-4333-8328-7edcbad51700)

Name the repository anything you want, along with the description for it

Afterwards, copy the link for the forked repository. It should look like

`https://github.com/username/repo`

Head back to your Terminal

Now run `git clone <paste from clipboard>`

You should now see a new directory with the name you set.

### Setting up the modules

`cd` into the directory

Create a new python environment using either python's `venv` module by running

{% code overflow="wrap" lineNumbers="true" fullWidth="true" %}

```sh
python -m venv venv
venv/Scripts/activate
python -m pip install -r requirements.txt
```

{% endcode %}

or using [uv](https://docs.astral.sh/uv/getting-started/installation/#highlights)

{% code overflow="wrap" lineNumbers="true" %}

```sh
uv venv venv
venv/Scripts/active
uv pip sync requirements.txt
```

{% endcode %}

If you are working on server-backend or want the formatter, make sure to run

{% code overflow="wrap" fullWidth="true" %}

```sh
pnpm install
```

{% endcode %}

That's it! You have setup the repository for editing!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://becomtweaks.gitbook.io/docs/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.