UFSVoteRewards - Config pack
============================

This folder contains premade configs for the UFSVoteRewards ARK ASE plugin.
The plugin only loads ONE file on the server:

  ArkApi/Plugins/UFSVoteRewards/config.json

Pick a language pack (or the English default), copy/rename it to config.json,
set ClientId + Secret, then place it next to UFSVoteRewards.dll.


------------------------------------------------------------------------------
FILE LIST
------------------------------------------------------------------------------

readme.txt
  This file (stays in the plugin root).

PluginInfo.json
  Required by Ark Server API. Copy next to the DLL (do not rename).

config.json
  English production template (valid JSON, no comments).
  This is the format the plugin expects when named config.json on the server.

config_commented.json
  English reference with inline comments explaining every option.
  Do NOT use this as the live config (comments are not valid JSON).
  Use it to understand settings, then apply values to config.json.

lang\
  Localized premade configs (Portuguese / Spanish).

  lang\config.pt-BR.json
    Portuguese (Brazil) premade config.

  lang\config_commented.pt-BR.json
    Portuguese (Brazil) commented reference. Documentation only.

  lang\config.es.json
    Spanish premade config.

  lang\config_commented.es.json
    Spanish commented reference. Documentation only.


------------------------------------------------------------------------------
HOW TO INSTALL THE PLUGIN
------------------------------------------------------------------------------

1. Build or download:
     UFSVoteRewards.dll

2. On the ARK server, create:
     ShooterGame/Binaries/Win64/ArkApi/Plugins/UFSVoteRewards/

3. Copy into that folder:
     UFSVoteRewards.dll
     PluginInfo.json
     config.json
     readme.txt   (optional)

4. Edit config.json:
     - Set ClientId (get yours at https://unofficial-servers.com/profile)
     - Set Secret (get yours at https://unofficial-servers.com/profile)
     - Optional: set Port (> 0) to override the game command-line port
     - Optional: set TestMode to true to claim rewards without the vote API (turn off on live servers)
     - Adjust rewards (points / Items / Dinos / Commands) and Messages

5. Make sure the server is CLAIMED on https://unofficial-servers.com by the same account that owns the ClientId/Secret.

6. Restart the server or load the plugin.

7. In-game:
     /vote     show vote URL
     /claim    check vote and deliver rewards
     /vrreload reload config (admin)
     /vrtest   test rewards without API (admin)

   Console / RCON:
     UFSVoteRewards.Reload


------------------------------------------------------------------------------
HOW TO GET ClientId AND Secret
------------------------------------------------------------------------------

ClientId and Secret belong to your unofficial-servers.com USER account
(not to a single server key).

1. Open https://unofficial-servers.com and log in (Steam and/or Discord).

2. Open your Profile page: https://unofficial-servers.com/profile

3. Find the Integrations / API credentials section.

   You will see:
     - ClientId
     - Secret

4. Copy both into config.json:
     "ClientId": "123456789012345678",
     "Secret": "your_secret_here"

5. Claim your ARK server on the site (if not already claimed) with that same account. The vote API matches:
     - ClientId + Secret  -> your user
     - Caller IP + Port   -> your claimed server

------------------------------------------------------------------------------
QUICK LANGUAGE SETUP
------------------------------------------------------------------------------

English:
  copy config.json  ->  keep as config.json next to the DLL

Portuguese (Brazil):
  copy "lang\config.pt-BR.json"  ->  rename to config.json next to the DLL
  Commands: /votar  and  /recompensa

Spanish:
  copy "lang\config.es.json"  ->  rename to config.json next to the DLL
  Commands: /vote  and  /claim

Always set ClientId and Secret after copying.


------------------------------------------------------------------------------
NOTES
------------------------------------------------------------------------------

- Port = 0 means auto-detect from ARK (?Port= / -Port=).
- ArkShop is optional; points rewards need ArkShop loaded.
- You can set up points for other shops using Commands.
- Items / Dinos: each entry rolls with RewardChance (independent).
- ItemPools / DinoPools: always pick "Pick" entries by Weight (exactly N from the list).
- Commands placeholders: {steamid}, {playerid}, {tribeid}, {playername}
  Example: Broadcast {playername} just got a vote reward!
- Keep Secret private. Do not share config.json publicly.
- Command / claim activity is written to:
    ArkApi/Plugins/UFSVoteRewards/UFSVoteRewards.log

