Getting Started

Disclaimer

⚠️ This project is still in Alpha. The resource is not production-ready yet. ⚠️

Installation

• Get the latest version: mta-collectibles/releases/latest
• Extract the contents of the collectibles-version.zip file you just downloaded to your server's resources directory inside a folder called collectibles
• This folder will be the resource
• Use command refresh in your server console to load the resource then start collectibles to start it

Usage

The resource comes with a few demo collectibles that logged in players can interact with.

Picking a collectible is simple, just walk over it.

There are two types (target) of collectibles:

• Client collectibles

  • Good to always have to keep players entertained looking for collectibles
  • Created on the client
  • Can be spawned when the client joins automatically (auto_load)
  • Can be respawned automatically after X amount of time
  • Can be toggled on/off by the client (toggle_command, toggle_keybind)
  • Collection date is stored on the server permanently

• Server collectibles

  • Useful for special server-wide events like Treasure Hunt or Easter-Egg Hunt
  • Created on the server
  • Can be spawned when the resource starts automatically (auto_load)
  • When collected, the pickup is destroyed and other players won't be able to collect it
  • Count is stored on the server temporarily
  • Server admins are responsible for spawning and destroying these collectibles
  • Once all have been collected, server admins are responsible for respawning them (if desired)

The default setup is the following:

• All collectibles are defined in collectibles.xml.
• All customizable texts are defined in strings.json.

The resource comes with some testing features enabled by default.

• Use command /bb to teleport to the center of the map (Blueberry farm) where some demo collectibles are spawned.
• Use command /shop to teleport inside an interior that contains a few more collectibles.

Explore the collectibles editor acessible by admins using /ceditor.

Try the remaining commands and settings defined in settings_server.lua.

The resource comes with a few example scripts which are enabled by default.