> For the complete documentation index, see [llms.txt](https://docs.gkshop.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gkshop.org/other-products/gkscraft/installation.md).

# Installation

{% hint style="danger" %}
If you are transferring files using FTP transfer your files using [winscp ](https://winscp.net/eng/download.php)program. Filezilla transfers files as corrupted.
{% endhint %}

**1.** Unzip the `gkscraft.zip` folder and place this folder in your servers resource folder.

**2.** Add the resource to your server start config: `ensure gkscraft`  (It is better to start at the bottom.)

**3.** You must import the SQL file to your database. (You will find the sql file `gkscraft/gkscraftsql.sql`)

4\. [Polyzone](https://github.com/mkafrin/PolyZone) is required as requirement.

5\. **The most important sections are the options at the top of** `config.lua.` **Everything else is optional.**

### Craft pictures

You can add craft images to gkscraft/images folder

If there are craft images in a different file, you can change the path ( For qb-core inventory, simply replace "**Itemimages**" on line 4 in `gkscraft/language.json` file to "<https://cfx-nui-qb-inventory/html/images/>" like this )

**Image names should be item codes and the file type should be png.**

### Language options

* Language options on the UI side you can make changes in `gkscraft/langueage.json`
* In order to use other language options in language.json, you should fix the "**Locale**" option in which language you will use. ( Simply type one of the language options in the **Locales** line you need to type. )&#x20;
* If you want to change the language options in other files, review the `gkscraft/locale.lua` file
* Don't forget to set the language you will use via config.lua

### Notification system

If you want to change the notification location, use one of the following options in the "**CraftPosition**" part in the 3. line of the `gkscraft/langueage.json` file

* bottom-right
* top-right
* top-center
* top-left
* bottom-left
* bottom-center


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.gkshop.org/other-products/gkscraft/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.