This plugin will not be updated until the whole legal investigation of Bukkit is fully complete.
- Overview
- Features
- Installation
- Configuration
- Configuration codes
- Player logging
- Permissions
- Auto-Updating
- Commands
- Classes
- Factions
- How to update
- To-do
- Links
McRPG is a plugin that will make your whole server into a new role playing game! With weapons, armor and items inspired by the enormous RPG World of Warcraft your server will draw forth players who will stay for a long while when enjoying this game-transforming plugin. What this plugin basically does is creating and renaming several items, with new enchantments and recipes with inspiration from World of Warcraft.
- New items - Inspired from World of Warcraft, craftable and obtainable.
- Private whispers - You can send player private whispers, only visible to the sender and receiver.
- Classes - With different classes, you can choose what your character will become and what powers you will possess
- Factions - With 2 different factions to choose, you can either become one of the fierce bad guys, or the team playing good guys!
- Gold - Add a currency to your server, used to buy items and sell items to your dearest players!
- Achievements - Earn custom achievements provided by McRPG, with them you earn gold and items.
More features will be added as we implement them into the plugin
It's very simple! You simply click Download ZIP file on the right side of the project and drag the McRPG-master\plugins folder into your server root and merge the plugins-folder with the one in your root.
This is how the configuration-file looks like:
# Default configuration for McRPG
# Read through and change what's needed before publicing on your server for other players!
# To disable something, change the 'enable' to 'disable' vice versa.
# AUTO-UPDATE
# Do you want the plugin to update automatically if there's an update available everytime you reload?
# auto = Will download the latest update if you're running a outdated one automatically.
# notify = Will not download anything, but will tell you if there's a new version available.
# disable = Will not do anything.
auto_update: notify
# STAT-MONITOR
# Here you can configure 2 rows of text on the scoreboard.
# You can leave it by default or just change it to whatever you want!
# Max text-length is 16 characters.
# Use '&' and a color code to change the color.
first_title: '&6&lServer:'
first_text: 'ServerName'
second_title: '&d&lWebsite:'
second_text: 'bit.ly1gR7UqV'
# Send the player a welcome-message when joining?
# If enable it will send the player a message
welcome_msg: true
# If welcome_msg is 'enable', then what should the message be?
# %player% is playername.
# To use colors, type & and then the COLOR CODE. Find all at: http://minecraft.gamepedia.com/Formatting_codes#Color_codes
MOTD: '&6&oDarion whispers: Welcome to the server, %player%.'
# Enable stat-monitor?
# true = yes
# false = no
stat_monitor: true
##################################
# CHAT #
##################################
# This is for enabling or disabling the colors in chat, for instance if someone types &2Hello it will show the message in green.
# Disabling this will NOT disable the colors for other messages, such as MOTD or other plugin messages. Only player-sent messages.
chat_colors: true
# Make the /y <message> command only availible to players with admin permission? (mcrpg.admin)
admin_yell: false
# This will set how the chat is displayed. You can set where the username is supposed to be and in what color anything should be in.
# Below are some variables that might help you formatting the chat.
# %player% = Playername
# %message% = The message itself
# %faction% = The player's faction
# %class% = The player's class
# %op% = OP-prefix. (Only shows if player is OP).
chat_formatting: '%op% %faction% &a%class%§r[%player%] says: %message%'
And it is fairly simple to set it up.
It also gives a fair explanation of everything inside the config!
But basically theadmin_yell: is a control to set if only admins are allowed to use the command /y which is a server-wide message that will be sent, or if everyone can use it. If admin_yell: 'disable' then it will make it so everyone can use it. If enabled, only admins can use it. Simple isn't it?
Moving on to welcome_msg:, which asks you if you want to have MOTD (Message Of The Day) enabled. This will send a message to the player when he/she logs in to the server. If welcome_msg: 'disable' it will not send a welcome message when logging in, but if it's welcome_msg: 'enable' it will send.
The MOTD: is setting what it should say. Default is:
MOTD: '&6&oDarion whispers: Welcome back, %player%.'
and it's OK to keep it, but if you'd like to, you can easily change it to whatever you want!
There's a few codes added into the configuration to make it much more cooler! (Like it's possible, eh?)
%player% gets the player name.
&<color> makes the following a certain color. All color codes are found at the Minecraft Gamepedia
The plugin logs players when they choose factions and classes. This is logged in 2 separate files. Classes are logged in the plugins\McRPG\PlayerClasses.yml file and factions in the plugins\McRPG\PlayerFactions.yml.
This is the plugins\McRPG\PlayerClasses.yml
# You can edit this, simply delete users that you want to be able to choose class again!
mages: []
paladins: []
warriors: []
classed_players: []
It tells you the players that have chosen classes and what classes they chose. So for example, if I did /class warrior, it would change into:
# You can edit this, simply delete users that you want to be able to choose class again!
mages: []
paladins: []
warriors:
- Condolent
classed_players:
- Condolent
It's fairly easy to remove a player that's been logged.
This is the plugins\McRPG\PlayerFactions.yml
# You can edit this, simply delete users that you want to be able to choose factions again!
# Players are no longer logged with their names, because of the new name change feature Mojang added to Minecraft.
# Therefor players' UUID are logged instead, because of that it's not change-able.
Horde: []
Alliance: []
Registered_Players: []
| Node | Gives |
|---|---|
| mcrpg.admin | Access to admin-related commands |
| mcrpg.moderator | Access to moderator-related commands |
Auto updating is when the plugin is automatically dowmloading a new update if there is one on BukkitDev. This is disabled by default, but can easily be changed in the config-file.
If it remains disabled, it will still send a message to server operators when logging in that there's a new update available and send a link. It also says that in the console on start-up.
If enabled, it will download when starting up the server. Remember to reload the server after the automatic-update is finished!
All commands are also listed by doing /rpg help
- /w - Sends a whisper to selected player
- /y - Sends out a server-wide yell
- /supply - Give the specified player a item. (Only items that McRPG implements)
- /heal - Heals specified player, just typing /heal will automatically set you as target.
- /class <mage/paladin/warrior> - Selects your class.
- /ci - Clears inventory of selected player.
- /gm <0/1/survival/creative> - Sets players gamemode.
- /setspawn - Sets server-spawn.
- /spawn - Teleports you to spawn.
- /faction <Horde/Alliance> - Choose which faction you want to fight for!
- /faction deluser - Remove a player from the faction-log, making it possible to re-choose faction.
- /class deluser - Remove a player from the class-log, making it possible to re-choose class.
- /vanish - Toggles invisibility for you.
- /balance - Shows your current gold-balance.
- /achievement - Opens up the achievement-list.
Here's all available classes listed:
- Warrior - Fight as a warrior and slay your enemies with no mercy!
- Mage - Play as a Mage, a wise wizard with magical powers.
- Paladin - Follow the light's guidance and fight off your enemies with the power of the light!
- Horde - Fight with brutality for the horde, for the magestive warchief Orgrim Doomhammer
- Alliance - Fight honorably for the allmighty king Varian Wrynn
This is the best way to update, follow these steps to update the plugin:
- Download the latest .jar file
- Copy everything inside your config.yml
- Place the new .jar file inside your //<server-folder\plugins// folder and replace the old one
- Delete the current config.yml file
- Run the server (the plugin will now generate a new config-file that's up to date)
- Paste the copied (old) config.yml into a new notepad file
- Change the settings that's in the old to the new config file.
Q: Why is it so complicated?
A: Well since the plugin is still in development, we add a bunch of new things to the config-file almost after every update. The config file doesn't automatically update when the plugin does, therefor these steps are required to maintain the plugin in full capabilitiy
- Powers for classes (Perhaps)