Nation Guide

From Fantasy RP
Jump to navigation Jump to search

The Nation plugin is an integral part of the server, it hooks together multiple things - such as land claiming, wars, and overall organization of groups on the server. ​

This plugin has an abundance of commands and features - but one of the key aspects of the plugin and its ensuing systems is that everything can easily be accessed through a clean and easy to use Menu / GUI. There are command variations for everything, which can act as shortcuts for people more familiar with the plugin, but the GUI should serve as the main tool to utilize the plugins' features


Relevant commands:​

  • /nation


Joining & Leaving a Nation

When you join a nation, the soul you join it on is thereon bound to that nation until you leave. You can be in a maximum of one nation per-soul. You can only join a nation once you have been invited to it. ​

Similarly, you can leave a nation once you are in one on your soul. ​

Relevant commands:​

  • /nation invite [player_name]​
  • /nation join [nation_name]​
  • /nation leave​


How To

Firstly, to invite a member to your nation you would type the command /nation invite [player_name]. If successful, this will send the following message

NationsInvite.png


The player who receives the invite will have the option to accept this - if they are not in a nation then they will join and this will announce they are joining the nation.​

NationsInvite2.png

NationsJoin.png


If a player no longer desires to be in the nation, they simply type /nation leave. This will exit them from the nation their soul is currently in.

NationsLeave.png

Nation Roles

Within the nation, there can be an infinite possibility of roles. These can be created by anyone with permission to do so. Similarly, an infinite number of roles can be applied to any member of the nation. ​ ' There is a complete customization of these nation roles - there are three main options when editing a role, being Priority, Manage Permissions, and Role Color.

Priority:​

  • This decides what ranks take priority over the other, for example, if you have permission to kick members from the nation - you may only kick people that have a higher priority than yourself. E.X. If you're rank is priority 3 with kick permissions, you can only kick people with priority 4 or above.

Manage Permissions:​

  • There are over 20+ permissions related to the nations plugin, almost anything can have its permission granted or revoked for each part of the plugin. You may only do certain actions if your rank has the permission to do so.​

Role Color:​

  • Wherever the color is used, for text - or buttons, it will take the role color assigned to it. For aesthetic purposes only.

Alongside this, roles have additional features; you can add a role or the nation in its entirety to LWC locks. Allowing anyone with that specific role within your nation to access the lock.

What is an LWC lock?

  • LWC Locks is the plugin that we utilize for player-protections on their chests - typically you can add players on to it to give them permission to your locked chests, but now you can add nations and nation roles on to these chests too.

Relevant commands:​

  • /nation createrole [name]​
  • /nation deleterole [name]​
  • /nation roles​
  • /nation role [role]​
  • /nation role list​
  • /nation role [role] permission​
  • /nation lock​
  • /nation lock menu


How To

The first step to creating a role is using the command /nation createrole. For example, if I wished to make a citizen role then I could /nation createrole Citizen. Following this, I could navigate to the role list menu, or use the shortcut of /nation roles.

NationsCreateRole.png

NationRoles.png

NationCitizen.png

This as you can see above, brings up a list of all the roles in the nation currently. If I click on this, then it will give me the options to edit one of the three options of priority, color, or permissions.

NationsChangeColour.png

NationsManagePerms.png

NationsSetRank.png

If I want to edit the color, I can click one of the following buttons

NationsColour.png

If I want to edit the permissions, I can tick/untick any of the permissions (Green means it has the permission, red means it does not)​

NationsPerms.png

If I want to edit the priority, I can choose a priority between one and thirteen. The lower the number, the greater priority it has over other roles.

NationsPriority.png

Then, if I wish to add this role to a lock then I would type /nation lock menu. From here, I can pick the role I wish to add to the lock and then add it.

RoleLock.png

Lastly, I wish to check the permissions the role has - I can view the permissions it has from the GUI, or I can use a short-cut command /nation role Citizen permission.​

NationsViewRoles.png

If I later decide, I do not want this role anymore - then I can delete it via the command /nation deleterole citizen.​

NationsDeleteRole.png

User Management

Managing users has been made as simple as possible. There are options to select a user specifically via a command - or to bring up a menu where all are listed and can be selected. From here, clicking on a user's head will bring up the user’s member menu. Here it is you can click on informative buttons in the menu GUI to assign roles, remove roles, or even kick the user from the nation. ​

Relevant commands:​

  • /nation member [name]​
  • /nation member


How To

Firstly, to access a member I can view the member list through the nation menu - or I can use the shortcut /nation member [name]. ​

NationListMembers.png

NationMembers.png

Once I am on this menu, I can select a user - from here it brings up an interface from here there are several buttons that I can use.

NationAssignRole.png

NationRemoveRole.png

NationKickMember.png

I can assign an assortment of roles, a player may hold an infinite amount of roles

NationAssignRoleMenu.png

I can remove any roles they possess

NationRemoveRoleMenu.png

I can kick the member from the nation, which I will have an additional prompt to confirm this decision.

NationConfirmDecision.png

Nation Treasury

Each nation has a treasury to store the nation's funds. This fund can be easily withdrawn or deposited from through the GUI. As previously mentioned, roles can be given permissions, so a nation leader can easily decide who can withdraw, deposit, or even view the treasury.​

Relevant commands:​

  • /nation treasury


How To

To use the nation treasury, it is pretty straight forward. All you need to do is access the treasury section from the main nation menu. From here, you have three buttons available to you.

NationTreasuryMainMenu.png

One allows you to deposit 10 coins, clicking this will deposit 10 coins into the treasury.

NationDeposit10.png

One allows you to withdraw 10 coins, clicking this will withdraw 10 coins from the treasury.

NationWithdraw10.png

The middle shows the current counter of the amount of coins present in the nation's treasury.

NationBalance.png

Permissions for roles can be assigned in the nation role section, as explained earlier, to decide who can view the treasury, deposit into it or withdraw from it.

Nation Management

There are a lot of miscellaneous features that the plugin entails that nation leaders have access to. The Nation Color, which is the color that will be used among a majority of the nation’s menus, can be selected through the nation options menu. ​

As well as this, there is the ability to set the title of the nation leader, an introductory information message to the nation - as well as assign the forum link to your nation. This will all show in the nation list, as well as be hooked into the forums to be displayed on a nation map. ​

Relevant commands:​

  • /nation leadertitle​
  • /nation setinfo​
  • /nation setlink​
  • /nation list


How To

Going through each part individually, to set the leader title you use the command listed above. If the leader of my nation is referred to as a King, then I would do /nation leadertitle King. This will change the displays in several parts of the menu from the default "Leader" to King.

NationLeaderTitle.png

Using /nation setinfo, I can set information about my nation. For example, I could use the command /nation setinfo Westholm is a human-based nation that offers its homes to those of varying classes, with its culture rich with traders and artisans from all over Enarion.

NationInfomationMessage.png

The "setlink" command is used to link to the section you have on the forums. This allows players to easily navigate to your forum section.

NationSetForumLink.png

All of this information is used in varying parts of the plugin, though most importantly this information will hook up to the information broadcasted to the website under the nation map. On top of this, it is listed in the /nation list. Clicking these nations, or hovering over them, will present nation information.​

Nations2NewNations.png

NationViewInfo.png

Nation Logs

With such a feature-rich plugin, and the ability for players other than the nation leader to be assigned permissions to access the features - the plugin comes with a logging system. This can be accessed in-game or on discord. To access it in-game, there are simple commands to be used to locate your logs which can be displayed in chronological order, by player or by action. ​

If the plugin is hooked into your discord via the use of a webhook - then every action will be logged through the webhook straight into the discord channel of your choice.

Relevant commands:​

  • /nation log search​
  • /nation log searchplayer [player]​
  • /nation log searchaction [action]​
  • /nation webhook [webhook_url]​
  • /nation avatar [avatar_url]​


How To

There are two main ways to view logs within your nation - any action within the nation is logged. This allows a nation leader to know exactly who has been doing what in regards to their nation. The first way to see the logs in game, is to type the command /nation log search. ​

The logs brought up can be categorized by actions, or players or a general search like the one below. Hovering over these logs will provide additional information to the log (the specifics of how exactly the action occurred).​

NationsGeneralSearch.png

Next, you can hook the plugin in to your discord so it will post logs there too. This is done by setting a webhook URL with /nation webhook [webhook].

NationWebhook.png

You can further customize this webhook by adding an URL to the webhook, to make it more aesthetic to your nation this can be done by /nation avatar [avatarurl].

NationAvatar.png

Diplomacy

There are some diplomatic options that can be managed and handled through the plugin. These are ones that have an impact on wars. Any specific terms, or special clauses can be made through any pacts naturally via RP. However, for certain pacts - if they would impact a war- then they have to be handled through the plugin too. ​

There is a clean GUI that will list all of the available plugin diplomatic pacts:​ Non Aggression, Trade, Defensive, Alliance, Vassalage & War. ​

These all, also, have specific costs associated with them.

Relevant commands:​

  • /nation diplomacy​
  • /nation diplomacy list
How To

The nation diplomacy menu can quickly be brought up with /nation diplomacy, or you can navigate to the diplomacy menu the following route

NationLeaderMenu.png

NationOptions.png

Once here, it will show all the different types of diplomacy available and the descriptions to each

AtionNonAggressionPacts.png

NationTradePacts.png

NationDefensivePacts.png

NationAlliancePacts.png

NationVassalPacts.png

NationAtWar.png

If I wish to sign a non-aggression pact with another nation - I would click the non-aggression pact button and this will open a new menu of a list of all nations (excluding my own) that I can manage pacts with.​

ManageNonAggressionPacts.png

If I click this nation, a new menu will be brought up that has the following buttons​

The request button, this is where I can request the pact

RequestNonAggressionPact.png

The remove button, I have no current non-aggression pact with this nation so there is nothing to remove

RemoveNonAggressionPact.png

Then the final button shows a list of other pacts that I currently hold with this nation, in this example I have no other.

NationPacts.png

Once I have submitted this request, the other nation has to navigate to this same menu and then a confirm button will show.

NationConfirmNonAggressionPact.png

Once they click this confirm button, provided both nations meet the requirements the pact is signed. If either nation wishes to remove that pact at a later date they must return to the menu and click the remove pact button.

NationSuccessfulPact.png

If you cannot sign a pact with a nation, for a multitude of reasons - it will also let you know on the menu showing a button like this​

NationConflictingPact.png

Nation Imperium

Nation Imperium is the level, or tier, that the nation is. The larger the nation, the higher Imperium level it is. These levels range from 0 (lowest) → 5 (highest). The determinant for the nation “size” is the total activity weekly activity for all members of the nation.​

A larger Imperium value will result in greater nation perks - such as more Influence gained per week, and larger land sizes. ​

Influence is a nation currency that is spent on any costs related to the nation - such as wars, diplomacy or even nation benefits. ​

The menu for this can be navigated through in the nation options menu, which will display the Imperium, Influence and Land information.​

For more specific information to Influence & Imperium - check this post.

How To

Viewing the menu that hosts all of the above information is simple to navigate to, you click your nation options menu and then your Imperium one.

NationLeaderMenu.png

NationOptionsNationImperium.png

Once here, there are three different buttons that all show different amounts of information related to your nation.

NationImperiumInfluence.png

NationImperium.png

NationLand.png

Additional Notes

There are other, smaller, features listed in the plugin that can be found by browsing the menus or viewing the help commands. ​

For a more in-detail guide on Diplomacy, Influence & Imperium then check this post. This goes into detail about the costs, the wars and any many other features regarding this.