Welcome on the main page of the RedShop's wiki! Plugin is made for economy servers that want something new and creative!
RedShop offers your players to sell redstone signal for money! Do you want to sell activation of your machine to toher[注1] players? You can sell it. Do you have some in-game gamble machine? You can sell it's activaiton. All you need is sign!
We also support multiple currencies! If you can't see your own in the config file, tell us on Discord.

1. Stop your server
2. Put RedShop.jar into your plugins folder
3. Start your server
4. Edit your configuration (see Configuration section)
5. Restart your server
6. Done!

You can edit the messages file using this setting in your config file. Plugin supports english by default, but you can add your custom language by adding messages_<tag>.yml file.

When user buys something using FrameShop, the sign can contain date of the purchase. You can edit the display format of the date using following setting. Full list of supported date formats is here: https://docs.oracle.com/javase/7 ... mpleDateFormat.html

We wanted to provide support for multiple price display formats. You can use following.

We provide support for many currency plugins. You can also use multiple at once - it's just up to you.

You can enable only one of the module! Just enable/disable them.

In currencies section you can configure what currencies can players use in this module.

Default currency is used when players don't fill last (currency) line. The selected currency must be enabled and added to currencies list above.

Discord logger is useful for monitoring activity of the players. You can setup custom webhook which will be used to send information about new shops etc.

ExampleCurrency.java                                                  JAVA
/**
*  Your currency object needs to extend SupportedCurrency abstract class
*/
public class ExampleCurrency extends SupportedCurrency {

    //Your economy class
    private ExampleEconomy myEconomy;

    /**
     *  Currency constructor. You can use your own variables if needed.
     *
     *  Fun-fact: Check config.yml - you can see we use the same system for pre-defined currencies
     */
    public ExampleCurrency() {
        //Calling abstract class constructor - REQUIRED!
        super(
            "ExampleDollars", //used as display name on signs, MUST BE UNIQUE!
            true, //if the currency is available (enabled)
            "$", //symbol used as suffix in messages, MUST BE UNIQUE!
            Arrays.asList("dol", "doll"), //list of aliases players can use instead of fullname, MUST BE UNIQUE!
            false, //if the currency/economy can handle offline player transactions - if not, we'll use pending.yml file to store the pending payments until player joins
            "ExampleCurrency" //system name of the currency (usually name of the plugin), MUST BE UNIQUE!
        );

        if (enabled) {
            //Setup your economy
            myEconomy = MyPlugin.getMyEconomy();
            if (myEconomy == null) {
                enabled = false;
            }
        }
    }

    /**
     *   Shall the currency use double or integer?
     *
     *   true = allows prices with decimal (e.g. 15.56)
     *   false = allows only integer prices (e.g. 15)
     */
    @Override
    public boolean useDoubleValues() {
        return true;
    }

    @Override
    public double getAmount(OfflinePlayer offlinePlayer) {
        if (!enabled) {
            return 0;
        }
        //Plugin checks balance of only online players, so we can cast it to Player
        return myEconomy.getBalance((Player) offlinePlayer);
    }

    @Override
    public boolean giveAmount(OfflinePlayer offlinePlayer, double amount) {
        if (!enabled) {
            return false;
        }
        //If the seller is offline and currency cannot pay offlinePlayer, we need to handle it
        if (!offlinePlayer().isOnline() && !offlineReady()) {
            //API method saves the amount to pending.yml and auto-pays the amount when the player joins
            return giveOffline(offlinePlayer, amount);
        }

        //Otherwise, OfflinePlayer is online, so we can cast it to Player
        return myEconomy.depositPlayer(offlinePlayer.getPlayer(), amount).transactionSuccess();
    }

    @Override
    public boolean takeAmount(OfflinePlayer offlinePlayer, double amount) {
        if (!enabled) {
            return false;
        }
        //Plugin takes money only from online players, so we can cast it to Player
        return myEconomy.withdrawPlayer((Player) offlinePlayer, amount).transactionSuccess();
    }

}

Main.java                                               JAVA
@Override
public void onEnable() {
    //... Your stuff ...
    if (setupCurrency()) {
        this.getServer().getConsoleSender().sendMessage("Custom RedShop currency successfully registered!");
    } else {
        this.getServer().getConsoleSender().sendMessage("Custom RedShop currency registration failed!");
    }
    //... Your other stuff ...
}

/**
*   setupCurrency method registers your currency to RedShop
*
*   Choose ONE of the method below - both does the same thing
*/
private boolean setupCurrency() {
    /* METHOD ONE */
    ExampleCurrency customCurrency = new ExampleCurrency();
    return customCurrency.register();

    /* METHOD TWO */
    RedShop redShopAPI = this.getServer().getPluginManager().getPlugin("RedShop");
    if (redShopAPI == null || redShopAPI.isEnabled()) {
        //RedShop is not installed OR is disabled
        return false;
    }
    return redShopAPI.registerCurrency(new ExampleCurrency());
}