Skip to content

swiftly-solution/vip-core

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SwiftlyLogo

[Swiftly] VIP Core

A plugin for VIP Core.

Downloads Contributors Issues License


Installation 👀

  1. Download the newest release.
  2. Everything is drag & drop, so i think you can do it!
  3. Setup database connection in addons/swiftly/configs/databases.json with the key swiftly_vipcore like in the following example:
{
    "swiftly_vipcore": {
        "hostname": "...",
        "username": "...",
        "password": "...",
        "database": "...",
        "port": 3306
    }
}

Warning

Don't forget to replace the ... with the actual values !!

Configuring the plugin 🧐

  • After installing the plugin, you need to change the prefix from addons/swiftly/configs/plugins (optional) and if you want, you can change the messages from addons/swiftly/translations.

Adding VIP ⚙️

  • To add a VIP Player on server, you need can use the sw_addvip command in Server Console.

  • Or, you can use sw_adminvip to open the Admin Menu and select Add VIP.

VIP Core Exports 🛠️

The following exports are available:

Name Arguments Description
HasFeature playerid, feature Checks if a player has the specified feature. It returns a boolean.
GetFeatureValue playerid, feature Returns the value of the feature from the configuration file
IsFeatureEnabled playerid, feature Checks if the feature is enabled or disabled. It returns a boolean.
RegisterFeature feature, feature_title_translation_key Registers a feature in VIP Core.
UnregisterFeature feature Unregisters a feature from VIP Core.
IsVip playerid Checks if the player is a VIP. It returns a boolean.

VIP Core Commnads 💬

  • Commnads provided by this plugin:
Command Description
!vip Opens the VIP Menu.
!adminvip Opens the VIP Admin Menu.

Adding a VIP Group ⚙️

You just need to add another entry in groups list from addons/swiftly/configs/plugins/vips.json with the following properties:

* id => String (Internal identifier)
* display_name => String (Display name for VIP Group)
* features => Object (The key-value pairs for features)

And that's it, you've succesfully added a new VIP Group on server.

Creating A Pull Request 😃

  1. Fork the Project
  2. Create your Feature Branch
  3. Commit your Changes
  4. Push to the Branch
  5. Open a Pull Request

Have ideas/Found bugs? 💡

Join Swiftly Discord Server and send a message in the topic from 📕╎plugins-sharing of this plugin!


About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages