> ## Documentation Index
> Fetch the complete documentation index at: https://docs-beta.new-host.net/llms.txt
> Use this file to discover all available pages before exploring further.

# txAdmin - Recipe System

> Automatyczna instalacja frameworków

# Recipe System - Automatyczna Instalacja

Recipe automatyzuje instalację popularnych frameworków FiveM w mniej niż 60 sekund.

## Czym są Recipes?

Recipe to pliki YAML opisujące jak wdrożyć serwer FiveM - od pobrania zasobów po konfigurację server.cfg. Recipe automatycznie:

* Pobiera podstawowe zasoby z GitHub
* Tworzy strukturę folderów
* Generuje server.cfg
* Importuje bazę danych
* Konfiguruje wszystkie zasoby

<Info>
  Zamiast ręcznej konfiguracji przez godziny, recipe wdroży podstawowy serwer w 30-60 sekund
</Info>

## Dostępne Recipes

### ESX Legacy

Podstawowa instalacja najpopularniejszego frameworka roleplay:

**Co zawiera recipe:**

* es\_extended (rdzeń frameworka)
* esx\_multicharacter (wybór postaci)
* esx\_identity (tworzenie postaci)
* esx\_menu\_default, esx\_menu\_list, esx\_menu\_dialog (systemy menu)
* Podstawowa struktura bazy danych
* Gotowy server.cfg

**Rozmiar:** \~100-300 MB (tylko core)

**Zasoby Core:**
Recipe instaluje tylko niezbędne minimum do uruchomienia ESX - resztę musisz doinstalować ręcznie z GitHub.

### QBCore Framework

Podstawowa instalacja nowoczesnego frameworka:

**Co zawiera recipe:**

* qb-core (rdzeń frameworka)
* qb-multicharacter (wybór postaci)
* qb-spawn (system spawnu)
* qb-inventory (podstawowy inwentarz)
* qb-menu (system menu)
* qb-smallresources (małe zasoby pomocnicze)
* Podstawowa struktura bazy danych
* Gotowy server.cfg

**Rozmiar:** \~100-200 MB (tylko core)

**Zasoby Core:**
Recipe instaluje minimalną wersję QBCore wystarczającą do uruchomienia - dodatkowe zasoby pobierasz osobno.

### CFX Default / Vanilla FiveM

Czysty serwer bez frameworków:

**Funkcje:**

* Minimalna konfiguracja
* Podstawowe zasoby FiveM
* Najlepsza wydajność
* Pełna kontrola nad customizacją

**Rozmiar:** \~50-100 MB

**Zasoby:**

* mapmanager
* spawnmanager
* sessionmanager
* chat
* basic-gamemode

## Instalacja Recipe

<Steps>
  <Step title="txAdmin Setup">
    Przy pierwszym uruchomieniu txAdmin wybierz **"Popular Recipes"**
  </Step>

  <Step title="Wybierz Framework">
    Dostępne opcje: CFX Default, ESX Legacy, QBCore Framework, Qbox Framework
  </Step>

  <Step title="Step 1: Review Recipe">
    txAdmin pokaże listę zadań do wykonania: pobieranie z GitHub, usuwanie ścieżek, pobieranie plików, rozpakowywanie, łączenie z bazą, zapytania SQL itp.

    Kliknij **"Next"** aby przejść dalej
  </Step>

  <Step title="Step 2: Input Parameters">
    Wprowadź wymagane parametry:

    **Server Registration Key** - Wklej klucz licencyjny z [Cfx.re Portal](https://keymaster.fivem.net/):

    ```
    cfxk_xxxxxxxxxxxxxxxxxxxxxxxxxxxxx_xxxxx
    ```

    **Opcje bazy danych (zaawansowane)**:

    Kliknij **"Show/Hide Database options (advanced)"** jeśli chcesz dostosować parametry MySQL:

    * **Database Host** - Adres hosta bazy danych (np. `localhost` lub IP z panelu)
    * **Database Port** - Port MySQL (zazwyczaj `3306`)
    * **Database Username** - Nazwa użytkownika bazy danych
    * **Database Password** - Hasło do bazy danych
    * **Database Name** - Nazwa bazy danych
    * **Delete Database** - Przełącznik OFF/ON - usuwa istniejącą bazę o tej samej nazwie
  </Step>

  <Step title="Run Recipe">
    Kliknij **"Run Recipe"** i poczekaj - deployment zajmuje mniej niż 60 sekund
  </Step>
</Steps>

<Warning>
  Włączenie **"Delete Database"** usunie wszystkie dane z istniejącej bazy o podanej nazwie! Używaj tylko przy pierwszej instalacji.
</Warning>

## Proces Instalacji

### Step 1: Review Recipe

txAdmin wyświetla pełną listę zadań recipe, które zostaną wykonane podczas instalacji. Zobaczysz:

```
Step 1: Review Recipe ✓
Step 2: Input Parameters ✓
Step 3: Run Recipe
```

Przejrzyj wszystkie zadania recipe i kliknij **"Next"** przy **"Step 1: Review Recipe ✓"** aby przejść dalej.

### Step 2: Input Parameters

Wprowadź wymagane parametry konfiguracyjne:

**Server Registration Key** - Klucz licencyjny z Cfx.re Portal

**Opcje bazy danych (zaawansowane)** - Kliknij **"Show/Hide Database options (advanced)"** aby dostosować:

* Database Host
* Database Port
* Database Username
* Database Password
* Database Name
* Delete Database (OFF/ON)

Kliknij **"Run Recipe"** aby rozpocząć instalację.

### Step 3: Run Recipe - Automatyczne Wykonywanie Zadań

txAdmin automatycznie wykonuje wszystkie zadania z recipe. Zobaczysz komunikaty w czasie rzeczywistym:

**FiveM Basic Server (przykład):**

```
Your recipe is being executed, the server will be deployed to:
/home/container/txData/default.base/

[17:05:13] Starting deployment of FiveM Basic Server.
[17:05:13] Running [task1:download_github]... ✓
[17:05:14] Running [task2:remove_path]... ✓
[17:05:14] Running [task3:download_file]... ✓
[17:05:14] All tasks completed.
[17:05:14] Replacing all vars in server.cfg... ✓
[17:05:14] Deploy finished and folder validated. All done!
```

**ESX Legacy (przykład):**

```
Your recipe is being executed, the server will be deployed to:
/home/container/txData/esxlegacy_ejifan.base/

[17:13:26] Starting deployment of ESX Legacy.
[17:13:26] Running [task1:download_github]... ✓
[17:13:27] Running [task2:remove_path]... ✓
[17:13:27] Running [task3:download_github]... ✓
[17:13:28] Running [task4:move_path]... ✓
[17:13:28] Running [task5:move_path]... ✓
[17:13:28] Running [task6:connect_database]... ✓
[17:13:28] Running [task7:download_github]... ✓
[17:13:30] Running [task8:query_database]... ✓
[17:13:31] Running [task9:download_github]... ✓
[17:13:34] Running [task10:move_path]... ✓
[17:13:34] Running [task11:move_path]... ✓
[17:13:34] Running [task12:download_github]... ✓
[17:13:35] Running [task13:download_github]... ✓
[17:13:36] Running [task14:download_file]... ✓
[17:13:37] Running [task15:unzip]... ✓
[17:13:37] Running [task16:remove_path]... ✓
[17:13:37] All tasks completed.
[17:13:37] Replacing all vars in server.cfg... ✓
[17:13:37] Deploy finished and folder validated. All done!
```

**Co się dzieje podczas instalacji:**

1. **Pobieranie zasobów** - Recipe pobiera pliki z GitHub (download\_github)
2. **Czyszczenie ścieżek** - Usuwa stare ścieżki jeśli istnieją (remove\_path)
3. **Pobieranie dodatkowych plików** - Pobiera pliki bezpośrednio (download\_file)
4. **Przenoszenie plików** - Organizuje strukturę folderów (move\_path)
5. **Rozpakowywanie** - Rozpakowuje archiwa ZIP (unzip)
6. **Konfiguracja bazy** - Łączy się z MySQL (connect\_database)
7. **Import SQL** - Tworzy tabele i dane (query\_database)
8. **Generowanie server.cfg** - Zastępuje wszystkie placeholdery (Replacing all vars)
9. **Walidacja** - Sprawdza poprawność instalacji

<Info>
  Instalacja zajmuje od 30 sekund (FiveM Basic) do 5 minut (ESX Legacy, QBCore) w zależności od recipe
</Info>

Po zakończeniu instalacji zobaczysz:

* Pasek postępu **"DONE"**
* Komunikat **"Deploy finished and folder validated. All done!"**
* Przycisk **"Next"** do przejścia dalej

### Step 3: Configure server.cfg (Opcjonalnie)

Po zakończeniu recipe możesz przejrzeć i edytować wygenerowany `server.cfg` bezpośrednio w txAdmin, ale zazwyczaj nie jest to konieczne - serwer jest gotowy do uruchomienia.

Kliknij **"Save & Run Server"** lub **"Next"** aby zakończyć setup i przejść do dashboardu.

## Rozbudowa Po Instalacji

### ESX Legacy

Recipe instaluje tylko core - resztę musisz pobrać z GitHub:

**Podstawowe dodatki do pobrania:**

```
cd resources

# Całe repozytorium dodatków
git clone https://github.com/esx-framework/ESX-Legacy-Addons [esx_addons]
```

Repozytorium ESX-Legacy-Addons zawiera zintegrowane dodatki takie jak prace (policja, ambulans, mechanik), sklepy, garaże i nieruchomości.

**Edytuj Konfiguracje:**

```
-- resources/[esx]/es_extended/config.lua
Config.Multichar = true
Config.MaxWeight = 24
Config.PaycheckInterval = 7 * 60000
Config.EnableDebug = false
```

### QBCore

Recipe instaluje tylko core - dodatkowe skrypty pobierz z GitHub:

**Podstawowe dodatki do pobrania:**

```
cd resources/[qb]

# Prace
git clone https://github.com/qbcore-framework/qb-policejob
git clone https://github.com/qbcore-framework/qb-ambulancejob
git clone https://github.com/qbcore-framework/qb-mechanic

# Banking i ATM
git clone https://github.com/qbcore-framework/qb-banking
git clone https://github.com/qbcore-framework/qb-atms

# Nieruchomości
git clone https://github.com/qbcore-framework/qb-houses
git clone https://github.com/qbcore-framework/qb-garages

# Dodatki
git clone https://github.com/qbcore-framework/qb-drugs
git clone https://github.com/qbcore-framework/qb-racing
```

**Edytuj Konfiguracje:**

```
-- resources/[qb]/qb-core/config.lua
QBConfig.MaxPlayers = 32
QBConfig.Money.PayCheckTimeOut = 10 * 60000
QBConfig.Server.Closed = false
QBConfig.DefaultSpawn = vector4(-1035.71, -2731.87, 12.86, 0.0)
```

## Custom Recipe

Możesz stworzyć własny recipe:

### recipe.yaml

```
$engine: 3
name: Mój Custom Recipe
version: 1.0.0
author: Twoja Nazwa
description: Własny framework

tasks:
  - action: download_github
    src: [https://github.com/user/repo](https://github.com/user/repo)
    dest: ./resources/[custom]

  - action: query_database
    file: ./database.sql

  - action: write_file
    file: server.cfg
    append: |
      ensure my_resource

      set mysql_connection_string "{{dbConnectionString}}"

      sv_maxclients {{maxClients}}
      sv_licenseKey {{svLicense}}
      {{addPrincipalsMaster}}
      {{serverEndpoints}}

  - action: replace_string
    mode: all_files
    search: 'database_name'
    replace: '{{dbName}}'
```

### Wymagania Custom Recipe

Recipe MUSI zawierać placeholdery w server.cfg:

* `{{maxClients}}` - limit graczy
* `{{addPrincipalsMaster}}` - master permissions
* `{{serverEndpoints}}` - endpointy serwera
* `{{svLicense}}` - klucz licencyjny
* `{{dbConnectionString}}` - połączenie z bazą
* `{{dbName}}` - nazwa bazy

### Użycie

W txAdmin wybierz **"Custom Template"** i podaj URL do repozytorium z `recipe.yaml` lub wklej bezpośrednio plik YAML.

## Porównanie Frameworków

| Feature             | ESX Legacy    | QBCore        | Vanilla         |
| ------------------- | ------------- | ------------- | --------------- |
| **Rozmiar (core)**  | \~100-300 MB  | \~100-200 MB  | \~50-100 MB     |
| **Wydajność**       | Średnia       | Wysoka        | Najwyższa       |
| **Łatwość użycia**  | Średnia       | Łatwa         | Zaawansowana    |
| **Społeczność**     | Największa    | Duża, rosnąca | Mała            |
| **Dostępne zasoby** | Tysiące       | Setki         | Podstawowe      |
| **Customizacja**    | Bardzo wysoka | Wysoka        | Pełna kontrola  |
| **Aktualizacje**    | Regularne     | Częste        | Podstawowe      |
| **Focus RP**        | Wysoki        | Średni        | Dowolny         |
| **Modularność**     | Średnia       | Wysoka        | N/A             |
| **Najlepsze dla**   | Serwery RP    | Uniwersalne   | Custom projekty |

## Częste Problemy

<AccordionGroup>
  <Accordion title="Recipe deployment failed">
    **Przyczyny**:

    * Problem z połączeniem GitHub
    * Timeout połączenia
    * Błędny connection string do bazy

    **Rozwiązanie**:

    * Sprawdź logi w Live Console txAdmin
    * Spróbuj ponownie za 10-15 minut
    * Sprawdź dostęp do internetu serwera
    * Zweryfikuj MySQL connection string
  </Accordion>

  <Accordion title="Database import failed">
    **Przyczyna**: Nieprawidłowy connection string lub brak uprawnień

    **Rozwiązanie**:

    * Sprawdź connection string w panelu hostingu
    * Upewnij się że baza danych istnieje
    * Sprawdź poprawność hasła i nazwy użytkownika
    * Sprawdź czy użytkownik ma uprawnienia CREATE i INSERT
  </Accordion>

  <Accordion title="Serwer nie startuje po recipe">
    **Rozwiązanie**:

    * Sprawdź logi w txAdmin Live Console
    * Zweryfikuj license key w server.cfg
    * Sprawdź czy sv\_maxclients nie przekracza 48
    * Upewnij się że wszystkie placeholdery zostały zastąpione
  </Accordion>

  <Accordion title="Brakuje mi skryptów prac/domów/garażów">
    **To nie jest błąd** - recipe instaluje tylko core framework. Dodatkowe zasoby musisz pobrać ręcznie z GitHub esx-framework lub qbcore-framework.
  </Accordion>
</AccordionGroup>

## Następne Kroki

<CardGroup cols={2}>
  <Card title="Zarządzaj Zasobami" icon="box" href="/fivem/txadmin/resources">
    Instaluj dodatkowe skrypty i rozszerzenia
  </Card>

  <Card title="Baza Danych" icon="database" href="/fivem/database">
    Zarządzaj MySQL i strukturą danych
  </Card>
</CardGroup>