Thread: EverythingRS Voting Donate Hiscores Heatmaps Installation & More [ANY BASE]

EverythingRS - Free Donation Installation

EverythingRS is a free API system. Here's a quick tutorial on how to get started with donations.

Support Discord

If you need more help or for some reason cannot understand the tutorial. You can post a comment on this thread or reach us at our support Discord.

https://discord.gg/rGN8zCV

Getting started

• First off download our everythingrs-api.jar from here and include it into your project.

Registration and secret key

• After adding the everything-rs.jar into your project the next step is to create an account at https://everythingrs.com, once the account is created you must register onto the toplist as we use the toplist data in many of our api's.
• Now go to your dashboard and you should see your secret key

Setting up your donation with Paypal

In order for the donation script to work, you must set it up with your Paypal.

• To set up your donation script to receive Paypal payments, go to your settings here
• Input your Paypal email and hit submit

Adding and removing items

Adding and removing items from your Auto Donate is simple.

• Go to your Auto Donate dashboard here
• Under "Add new product", fill out the form information, then hit submit
• To remove an item just click "Remove" next to the item that you are trying to remove

(Optional) Creating a Sale

We promote sales on our front page. This is a good way for new players to find deals on servers before joining, and for servers to earn new customers.

• To create a sale go to your Sales dashboard here
• Choose the item that you want to put on sale
• Set the expiration date, and what % off you want to make the item
• Read our notification and confirm that you commit to the sale.

Lets take a look at your new donation page

You can find your donation script at: yoursubdomain.everythingrs.com/services/store


Making the auto donate work with your server

This part of the tutorial is for PI & Ruse, but can easily be changed to work with any server. If you want me to add a snippet on the thread so it can work with your framework leave a comment with the server base you want the snippet for.

• Add the code below into Commands.java and you're all done!

For PI

Spoiler for :

Code:

			if (playerCommand.equalsIgnoreCase("claim")) {
				new java.lang.Thread() {
					public void run() {
						try {
							com.everythingrs.donate.Donation[] donations = com.everythingrs.donate.Donation.donations("secret_key", 
									c.playerName);
							if (donations.length == 0) {
								c.sendMessage("You currently don't have any items waiting. You must donate first!");
								return;
							}
							if (donations[0].message != null) {
								c.sendMessage(donations[0].message);
								return;
							}
							for (com.everythingrs.donate.Donation donate : donations) {
								c.getItems().addItem(donate.product_id, donate.product_amount);
							}
							c.sendMessage("Thank you for donating!");
						} catch (Exception e) {
							c.sendMessage("Api Services are currently offline. Please check back shortly");
							e.printStackTrace();
						}	
					}
				}.start();
			}

For Vencillio

Spoiler for :

In PlayerCommand.java under

Code:

switch (parser.getCommand()) {

Add

Code:

case "claim":
			new java.lang.Thread() {
				public void run() {
					try {
						com.everythingrs.donate.Donation[] donations = com.everythingrs.donate.Donation.donations("secret_key", 
								player.getUsername());
						if (donations.length == 0) {
							player.send(new SendMessage("You currently don't have any items waiting. You must donate first!"));
							return;
						}
						if (donations[0].message != null) {
							player.send(new SendMessage(donations[0].message));
							return;
						}
						for (com.everythingrs.donate.Donation donate : donations) {
							player.getInventory().add(new Item(donate.product_id, donate.product_amount));
						}
						player.send(new SendMessage("Thank you for donating!"));
					} catch (Exception e) {
						player.send(new SendMessage("Api Services are currently offline. Please check back shortly"));
						e.printStackTrace();
					}	
				}
			}.start();
			return true;

For Ethos / Exotic

Spoiler for :

In ethos/model/players/packets/commands/all

Open or create (if it does not exist) Claim.java

and replace the entire file with this

Code:

package ethos.model.players.packets.commands.all;

import ethos.model.players.Player;
import ethos.model.players.packets.commands.Command;

/**
 * Auto Donation System / https://EverythingRS.com
 * @author Genesis
 *
 */

public class Claim extends Command {

	@Override
	public void execute(Player player, String input) {
		new java.lang.Thread() {
			public void run() {
				try {
					com.everythingrs.donate.Donation[] donations = com.everythingrs.donate.Donation
							.donations("secret_key", player.playerName);
					if (donations.length == 0) {
						player.sendMessage("You currently don't have any items waiting. You must donate first!");
						return;
					}
					if (donations[0].message != null) {
						player.sendMessage(donations[0].message);
						return;
					}
					for (com.everythingrs.donate.Donation donate : donations) {
						player.getItems().addItem(donate.product_id, donate.product_amount);
					}
					player.sendMessage("Thank you for donating!");
				} catch (Exception e) {
					player.sendMessage("Api Services are currently offline. Please check back shortly");
					e.printStackTrace();
				}
			}
		}.start();
	}

}

For Ruse

Spoiler for :

Code:

if (command[0].equalsIgnoreCase("claim")) {
			new java.lang.Thread() {
				public void run() {
					try {
						com.everythingrs.donate.Donation[] donations = com.everythingrs.donate.Donation.donations("secret_key", 
								player.getUsername());
						if (donations.length == 0) {
							player.getPacketSender().sendMessage("You currently don't have any items waiting. You must donate first!");
							return;
						}
						if (donations[0].message != null) {
							player.getPacketSender().sendMessage(donations[0].message);
							return;
						}
						for (com.everythingrs.donate.Donation donate : donations) {
							player.getInventory().add(new Item(donate.product_id, donate.product_amount));
						}
						player.getPacketSender().sendMessage("Thank you for donating!");
					} catch (Exception e) {
						player.getPacketSender().sendMessage("Api Services are currently offline. Please check back shortly");
						e.printStackTrace();
					}	
				}
			}.start();
		}

Fin

You are now finished adding the auto donation script to your website and server. If you have any suggestions for features, leave a comment and let me know.

EverythingRS - Free Hiscores Installation

EverythingRS is a free API system. Here's a quick tutorial on how to get started with voting.

Support Discord

If you need more help or for some reason cannot understand the tutorial. You can post a comment on this thread or reach us at our support Discord.

https://discord.gg/rGN8zCV

Getting started

• First off download our everythingrs-api.jar from here and include it into your project.
  

Registration and secret key

• After adding the everything-rs.jar into your project create an account at https://everythingrs.com, once the account is created you must register onto the toplist as we use the toplist data in many of our api's.
• Now go to your dashboard and you should see your secret key

Your Hiscores subdomain!

• Go to your main panel at https://everythingrs.com/account . You should now see your voting URL in the "Your API Pages" section
• (OPTIONAL) If you wish to embed the script on your website you can add the code below directly onto your website. Change "yoursubdomain" to the one that was provided to you

Spoiler for (optional) embed onto your website:

Code:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
    <title>Hiscores</title>
    <style type="text/css">
        body,
        html {
            margin: 0;
            padding: 0;
            height: 100%;
            overflow: hidden;
        }
        
        #content {
            position: absolute;
            left: 0;
            right: 0;
            bottom: 0;
            top: 0px;
        }
    </style>
</head>

<body>
    <div id="content">
        <iframe width="100%" height="100%" frameborder="0" src="https://yoursubdomain.everythingrs.com/services/hiscores/" />
    </div>
</body>

</html>

Making the Hiscores work with your server

This part of the tutorial is for PI, but can easily be changed to work with any server. If you want me to add a snippet on the thread so it can work with your framework leave a comment with the server base you want the snippet for.

In Client.java under

Code:

public void destruct() {

Add this

Code:

boolean debugMessage = false;
com.everythingrs.hiscores.Hiscores.update("secret_key",  "Normal Mode", this.playerName, this.playerRights, this.playerXP, debugMessage);

Be sure to change "secret_key" to the secret key on your ERS account.

Fin

You now have a working Hiscores on your server! If you have any suggestions or need help please leave a comment.

Lets take a look at your new Hiscores





Hiscores Dashboard

You can remove members and add new modes from your Hiscores Dashboard

EverythingRS - Realtime Heatmaps Tutorial

EverythingRS is a free API system. Here's a quick tutorial on how to get started with adding Heatmaps.

Support Discord

If you need more help or for some reason cannot understand the tutorial. You can post a comment on this thread or reach us at our support Discord.

https://discord.gg/rGN8zCV

Getting started

• First off download our everythingrs-api.jar from here and include it into your project.

Registration and secret key

• After adding the everything-rs.jar into your project create an account at https://everythingrs.com, once the account is created you must register onto the toplist as we use the toplist data in many of our api's.
• Now go to your dashboard and you should see your secret key

What you are adding

Heatmaps can be used to view hotspots in the game, you can view where the wilderness hotspots are, alternatively you can view non-wilderness hotspots. Either can be disabled, so if you only want to show the wilderness hotspot you can do this.

• Red = Wilderness Hotspots
• Blue = Non Wilderness Hotspots

Making the Heatmaps work with your server

This part of the tutorial is for PI & Ruse, but can easily be changed to work with any server. If you want me to add a snippet on the thread so it can work with your framework leave a comment with the server base you want the snippet for.

Spoiler for For PI:

In your server startup (Server.java) under

Code:

public static void main(

Add this and change your secret key to the one on your account

Code:

		com.everythingrs.service.Service.scheduledService.scheduleAtFixedRate(new Runnable() {
			@Override
			public void run() {
				com.everythingrs.heatmaps.Heatmap.getMap().clear();
				for (Player player : PlayerHandler.players) {
					if (player != null) {
						com.everythingrs.heatmaps.Heatmap.getMap().put(player.getUsername(),
								new com.everythingrs.heatmaps.Heatmap(player.getUsername(), player.absX, player.absY,
										player.height));
					}
				}
				com.everythingrs.heatmaps.Heatmap.update("secret_key");
			}
		}, 0, 5, java.util.concurrent.TimeUnit.SECONDS);

Spoiler for For Ruse:

In GameServer.java under

Code:

public static void main(

Add

Code:

		com.everythingrs.service.Service.scheduledService.scheduleAtFixedRate(new Runnable() {
			@Override
			public void run() {
				com.everythingrs.heatmaps.Heatmap.getMap().clear();
				for (Player player : World.getPlayers()) {
					if (player != null) {
						com.everythingrs.heatmaps.Heatmap.getMap().put(player.getUsername(),
								new com.everythingrs.heatmaps.Heatmap(player.getUsername(), player.getPosition().getX(),
										player.getPosition().getY(), player.getPosition().getZ()));
					}
				}
				com.everythingrs.heatmaps.Heatmap.update("secret_key");
			}
		}, 0, 5, java.util.concurrent.TimeUnit.SECONDS);

Fin

You are finished with the tutorial and can now view your heatmaps on your subdomain page

EverythingRS - Players Online Tutorial

EverythingRS is a free API system. Here's a quick tutorial on how to get started with adding Players Online.

Support Discord

If you need more help or for some reason cannot understand the tutorial. You can post a comment on this thread or reach us at our support Discord.

https://discord.gg/rGN8zCV

Getting started

• First off download our everythingrs-api.jar from here and include it into your project.
• Also register an account at EverythingRS
• Remember your secret key as you will be using it in the next section

Making the Players Online work with your server

This part of the tutorial is for PI, but can easily be changed to work with any server. If you want me to add a snippet on the thread so it can work with your framework leave a comment with the server base you want the snippet for.

In your server startup (Server.java) under

Code:

public static void main(

Add this and change your secret key to the one on your account

Code:

			com.everythingrs.playersonline.PlayersOnline.service.scheduleAtFixedRate(new Runnable() {
				@Override
				public void run() {
					int online = 0;
					for (Player player : PlayerHandler.players) {
						if (player != null) {
							online += 1;
						}
					}
					com.everythingrs.playersonline.PlayersOnline.insert("secret_key", online, false);
				}
			}, 0, 30, TimeUnit.SECONDS);

Displaying your player count on your website

In your index.php place this where ever you wish to display your player count. Remember to change the secret key.

Code:

<?php

$secret = "change_this_to_your_secret_key";
$playersOnline = @file_get_contents("https://everythingrs.com/api/playersonline/get/".$secret);
echo "There are currently ".$playersOnline." players online";

?>

Fin

You are finished with the tutorial and can now view your player count on your site

Info and some documentation

Player count will update every 30 seconds. If you wish to make calls every 30 minutes just change the 5 to 30 (or to whichever number you wish) and TimeUnit.SECONDS to TimeUnit.MINUTES in the startup code. If you wish to make direct changes to the way the code works, this section will help out.

To fetch the current players online you can use this code

Code:

com.everythingrs.playersonline.PlayersOnline.get();

To set the count to whatever you wish use this code

Code:

com.everythingrs.playersonline.PlayersOnline.set(value);

To add to the playercount use this

Code:

com.everythingrs.playersonline.PlayersOnline.increment(value);

To subtract from the playercount use this

Code:

com.everythingrs.playersonline.PlayersOnline.decrement(value);

Support - Below are some snippets on how to convert the code to other bases

Converting to Ruse

Originally Posted by Prestigious

For Ruse all you have to do is change

Code:

PlayerHandler.Players

to

Code:

World.getPlayers()

EverythingRS - Free Market/Trade API Installation

EverythingRS is a free API system. Here's a quick tutorial on how to get started with voting.

Support Discord

If you need more help or for some reason cannot understand the tutorial. You can post a comment on this thread or reach us at our support Discord.

https://discord.gg/rGN8zCV

Getting started

• First off download our everythingrs-api.jar from here and include it into your project.

Registration and secret key

• After adding the everything-rs.jar into your project create an account at https://everythingrs.com, once the account is created you must register onto the toplist as we use the toplist data in many of our api's.
• Now go to your dashboard and you should see your secret key

Your market subdomain!

• Go to your main panel at https://everythingrs.com/account . You should now see your market URL in the "Your API Pages" section
• (OPTIONAL) If you wish to embed the script on your website you can add the code below directly onto your website. Change "yoursubdomain" to the one that was provided to you

Spoiler for (optional) embed onto your website:

Code:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head>
    <title>Market</title>
    <style type="text/css">
        body,
        html {
            margin: 0;
            padding: 0;
            height: 100%;
            overflow: hidden;
        }
        
        #content {
            position: absolute;
            left: 0;
            right: 0;
            bottom: 0;
            top: 0px;
        }
    </style>
</head>

<body>
    <div id="content">
        <iframe width="100%" height="100%" frameborder="0" src="https://yoursubdomain.everythingrs.com/services/market/" />
    </div>
</body>

</html>

Making the Market/Trade api work with your server

This part is for PI and Ruse but can easily be changed to work with any server. If you have a request for a specific server let me know and I can add it to the tutorial.

Spoiler for For PI:

In TradeAndDuel.java under

Code:

 public void giveItems() {

Look for

Code:

for (GameItem item : o.getTradeAndDuel().offeredItems) {

Above that put this and remember to also edit the secret_key to your API secret key.

Code:

                com.everythingrs.marketplace.Trade trade = new com.everythingrs.marketplace.Trade();
        	trade.setUsername(o.getUsername());
        	trade.setTradeWith(c.getUsername());
        	for (GameItem item : o.getTradeAndDuel().offeredItems) {
        		if (item.id > 0) {
        			String itemName = ItemDefinitions.getDefinitions()[item.id].getitemName();
        			trade.push(new com.everythingrs.marketplace.Item(item.id, item.amount, itemName));
        		}
        	}
        	trade.update("secret_key");

Spoiler for For Ruse:

Originally Posted by Altar

For those needing help with Ruse based server:


Go to Trading.java

Code:

public void giveItems() {

Look for

Code:

			for (Item item : player.getTrading().offeredItems) {
				PlayerLogs.log(player.getUsername(), "Gave item in trade to "+player2.getUsername()+". Id: "+item.getId()+", amount: "+item.getAmount());
			}
			for (Item item : player2.getTrading().offeredItems) {
				PlayerLogs.log(player.getUsername(), "Receiving item from trade with "+player2.getUsername()+" Id: "+item.getId()+", amount: "+item.getAmount());
			}

Add this underneath it

Code:

            com.everythingrs.marketplace.Trade trade = new com.everythingrs.marketplace.Trade();
    	trade.setUsername(player2.getUsername());
    	trade.setTradeWith(player.getUsername());
    	for (Item item : player2.getTrading().offeredItems) {
    		if (item.getId() > 0) {
    			String itemName = ItemDefinition.getDefinitions()[item.getId()].getName();
    			trade.push(new com.everythingrs.marketplace.Item(item.getId(), item.getAmount(), itemName));
    		}
    	}
    	trade.update("your_secret_key");

For Other Servers

The script is compatible with any base, if you however need help adding it to a specific one, leave a link to the base and I'll add it to the tutorial.


Fin

You are now finished adding the market onto your server. . This will be extremely useful for players that are looking for price guides and want to check what items are currently going for, etc.

EverythingRS - Commands Installation

EverythingRS is a free API system. Here's a quick tutorial on how to get started with commands.

Support Discord

If you need more help or for some reason cannot understand the tutorial. You can post a comment on this thread or reach us at our support Discord.

https://discord.gg/rGN8zCV

Things Included with the Commands API

At the moment we provide 5 different commands related to search which give you quicker access to our Tools page.

• :: sitem which is short for "searchitem" will give you results for RS2 items.
• :: ositem short for "Old School Item" will give you results for OSRS items.
• :: snpc short for "Search NPC" will give you results for RS2 NPCs.
• :: osnpc short for "Old School NPC" will give you results for OSRS NPCs
• :: osobject short for "Old School Object" will give you results for OSRS Objects

Getting started

• First off download our everythingrs-api.jar from here and include it into your project.
• Also register an account at EverythingRS
• Remember your secret key as you will be using it in the next section

Making the commands work with your server

This part of the tutorial is for PI & Ruse, but can easily be changed to work with any server. If you want me to add a snippet on the thread so it can work with your framework leave a comment with the server base you want the snippet for.

Spoiler for For PI:

• Add the code below into Commands.java and you're all done!

Code:

			if (playerCommand.startsWith("sitem") || playerCommand.startsWith("snpc")
					|| playerCommand.startsWith("ositem") || playerCommand.startsWith("osnpc")
					|| playerCommand.startsWith("osobject")) {
				String[] args = playerCommand.split(" ");
				final String command = playerCommand;
				new Thread() {
					public void run() {
						synchronized (c) {
							try {
								String query = args[1];
								com.everythingrs.commands.Search[] searchResults = com.everythingrs.commands.Search
										.searches("secret_key", command, query);
								if (searchResults.length > 0)
									if (searchResults[0].message != null) {
										c.sendMessage(searchResults[0].message);
										return;
									}
								c.sendMessage("-------------------");
								for (com.everythingrs.commands.Search search : searchResults) {
									c.sendMessage(search.name + ":" + search.id);
								}
								c.sendMessage("Finished search with " + searchResults.length + " results");
								c.sendMessage("-------------------");
							} catch (Exception e) {
								c.sendMessage("Api Services are currently offline. Please check back shortly");
								e.printStackTrace();
							}
						}
					}
				}.start();
			}

Spoiler for For Ruse:

In CommandPacketListener

under

Code:

public static void playerCommands(

Add

Code:

			if (command[0].equalsIgnoreCase("sitem") || command[0].equalsIgnoreCase("snpc")
					|| command[0].equalsIgnoreCase("ositem") || command[0].equalsIgnoreCase("osnpc")
					|| command[0].equalsIgnoreCase("osobject")) {

				new Thread() {
					public void run() {
						synchronized (c) {
							try {

								String query = command[1];
								com.everythingrs.commands.Search[] searchResults = com.everythingrs.commands.Search
										.searches("secret_key", command[0], query);
								if (searchResults.length > 0)
									if (searchResults[0].message != null) {
										player.getPacketSender().sendMessage(searchResults[0].message);
										return;
									}
								player.getPacketSender().sendMessage("-------------------");
								for (com.everythingrs.commands.Search search : searchResults) {
									player.getPacketSender().sendMessage(search.name + ":" + search.id);
								}
								player.getPacketSender()
										.sendMessage("Finished search with " + searchResults.length + " results");
								player.getPacketSender().sendMessage("-------------------");
							} catch (Exception e) {
								player.getPacketSender()
										.sendMessage("Api Services are currently offline. Please check back shortly");
								e.printStackTrace();
							}
						}
					}
				}.start();
			}

Fin

You are finished with the tutorial and can now search for any osrs item, rs2 item, osrs npc, rs2 npcs, or osrs object quickly. If you have any suggestions for more commands be sure to let me know

EverythingRS - Automated Backups with optional Dropbox Integration


EverythingRS is a free API system. Here's a quick tutorial on how to get started with adding automated backups to your server.

Getting started

• First off download our everythingrs-api.jar from here and include it into your project.

Adding automated backups to your server

Once the .jar is included in your project all you have to do is add this code to your server startup. On PI it is in Server.java, look for

Code:

public class main(String args[]) {

and under it add

Code:

                com.everythingrs.backup.EverythingRSBackups backups = new com.everythingrs.backup.EverythingRSBackups();
		backups.setSource("C:\\Users\\YourName\\Desktop\\server");
		backups.setOutput("C:\\Users\\YourName\\Desktop\\server\\backups");
		//Every minute = 60
		//Every hour = 60 * 60
		//Every day  = 60 * 60 * 24
		//Default backups every 3 hours
		backups.setTime(60 * 60 * 3);
		backups.setMaxBackups(20);
		//backups.enableDropbox("auth_key");
		backups.init();

• Change the file location of backups.setSource to the folder you are trying to backup.
• Change the file location of backups.setOutput to the folder you want your backups to be placed in. It is recommended that you create a empty folder for your backups as it will make the backups finish faster.
• This can be used to backup anything . Server, Saved Games, Configs, etc.

Fin

You now have a backup system on your server, follow the next steps if you also want to add Dropbox integration to automatically upload your backups to Dropbox.

Integrating the Backup system with Dropbox

First you need to create a Dropbox account, if you don't already have one you can create one here.

After creating a Dropbox account go to https://www.dropbox.com/developers/apps. Click on "Create app"



Choose these settings, also name your app (it has to be a unique name, if you try putting something simple it might be taken already)



The next step is to generate an access token. This token will give your server access to your Dropbox. Click "generate access token" and then copy the token.



Paste that token into the "enableDropbox" code and also uncomment the code so it should look something like this after you're finished. (But with your access token)

Code:

backups.enableDropbox("0tlOkHrjmIAAAAAAAAAAJOuMwmGhDae9oqrpy0F4lum-KcLpttiMYD6ZaeHvmJyG");

Done

And you're done with the Dropbox integration. , after the backup is made, it will automatically upload it to your Dropbox account. By default the folder will backup every 3 hours & on server launch, the 3 hours can easily be changed to anything by editing

Code:

backups.setTime(60 * 60 * 3);

By default the max backup is set to 20, this is so if you're not just backing up smaller things like saves, but bigger servers that are 100MB, you don't shrink your hard drive space by having 1,000 backups. The way it works is, once you reach 20 backups, it will start deleting the oldest backup, this way you always have recent backups.

You can increase and decrease maxbackups by editing this code

Code:

backups.setMaxBackups(20);

Finally!

Thank you for the release

Originally Posted by _Jason

Finally!

Thank you for the release

Ofc if you need help setting it up let me know