> For the complete documentation index, see [llms.txt](https://portis-store.gitbook.io/portis-store-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://portis-store.gitbook.io/portis-store-docs/pixelhunters.md).

# PixelHunters

Installation

## Requirements

* **FiveM Server** with OneSync enabled
* **oxmysql** (required dependency)
* **ox\_lib** (required dependency)
* **Phone**: One of the following:
  * [lb-phone](https://lbphone.com/) (v1.8+)
  * [GKSPHONE v2](https://gkshop.org/)
  * [ySeries](https://www.yflip-phone.com/)
  * [lb-tablet](https://lbscripts.com/)
  * [17mov\_Phone](https://17movement.net/products/17mov_phone)
* **Framework** (optional): ESX, QBCore, or standalone

## Installation

{% stepper %}
{% step %}

### Step 1 — Database

Run the `sql/install.sql` file in your database using [HeidiSQL](https://www.heidisql.com/).
{% endstep %}

{% step %}

### Step 2 — Install Resource

1. Place the `portis-pixelhunters` folder in your server's `resources/` directory.
2. Add to your `server.cfg`:

```cfg
ensure oxmysql
ensure ox_lib
ensure lb-phone
ensure portis-pixelhunters
```

Make sure `portis-pixelhunters` starts **after** your phone resource and framework.
{% endstep %}

{% step %}

### Verify

1. Start your server
2. Check console for: `[PixelHunters] Resource started successfully`
3. Open your phone in-game — PixelHunters should appear in the app list
4. Open the app — after \~30 seconds, nearby spawns should appear
   {% endstep %}
   {% endstepper %}

## Configuration <a href="#step-5--configuration" id="step-5--configuration"></a>

Edit files in the `config/` folder to customize:

* `config.lua` — General settings, rate limits, economy
* `species.lua` — Creature definitions, stats, evolution chains
* `items.lua` — Net types, bait, prices
* `spawns.lua` — Spawn zones, biome weights, timings
* `badges.lua` — Achievement definitions
* `quests.lua` — Daily & weekly contract definitions

## Custom Creatures

You can add your own creatures or modify existing ones:

1. Add a new entry to `config/species.lua` with your creature's name, type, stats, and evolution chain
2. Drop an SVG file into `ui/public/img/species/` matching the `sprite` field
3. Restart the resource

```lua
-- Example entry in config/species.lua
[46] = {
    name          = 'MyCreature',
    type          = 'fire',
    rarity        = 'common',
    baseCatchRate = 0.60,
    fleeRate      = 0.20,
    candyToEvolve = 25,
    evolvesTo     = nil,
    xpReward      = 100,
    candyPerCatch     = 3,
    candyPerDuplicate = 1,
    sprite        = 'mycreature.svg',
},
```