# PickletGo

## Requirements

* Framework: QBox
* oxmysql  (required dependancy)
* [mPhone 2.0](https://codem.tebex.io/package/6372523)  (required dependancy)

## Installation

{% stepper %}
{% step %}

###  Database

Run or Import the `rs-pickletgo/sql/install.sql` file in your database
{% endstep %}

{% step %}

### Install Resource

1. Place `rs-pickletgo` folder in your servers `resources/` directory
2. Add resource to your `server.cfg`

```
ensure ox_lib
ensure qbx_core
ensure ox_target
ensure [ox]

ensure YourPhoneResource 

ensure rs-pickletgo
```

Make sure `rs-pickletgo` is started AFTER your phone resource and framework
{% endstep %}

{% step %}

### Verify

1. Restart your server
2. Check console for `[RawScripts] PickletGo successfully started.`
3. Open your phone in-game, PickletGo should be listed in your app store
4. Download and open PickletGo and get hunting
   {% endstep %}
   {% endstepper %}

## Configuration

Editable files are located under `rs-pickletgo/shared`

* config.lua - General settings, rarity values, daily rewards
* badges.lua - Pretty straight forward, badge colours, names ect
* items.lua - Item names and general item effects
* quests.lua - Daily and Weekly quests, add, edit or remove quests and rewards
* spawns.lua - Spawn settings, rules and definitions
* species.lua - Main housing for Picklets, add edit or remove
* phone.lua - Don't recommend touching this

## Custom Picklets

Adding your own Picklets is really easy and automatically gets counted towards your collection badge, may need to edit the previous badge goals though

1. Add a new entry to `rs-pickletgo/shared/species.lu`a with your Picklets id, name, rarity, spawn areas, goofy tempter and image name
2. Place your monster images in `rs-pickletgo/ui/assets/monsters` and make sure the image name is exactly the same as it is in the species.lua file
3. Restart the resource

```
{ id = 'example', name = 'Example', rarity = 'common', biomes = { 'suburb', 'highland' }, temper = 'Strange', image = monsterPath .. 'example.png' },
```


---

# 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://rawscripts.gitbook.io/rawscripts-docs/pickletgo.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.