# Welcome to Realms Reward, energize and unify your community {% hint style="success" %} We are developing our next version of Realms. Get on the waitlist and be notified when its ready: {% endhint %} ## What is Realms? Realms is a Discord bot that gives you an easy, fun and fair way to manage your community. Get the tools you need to reward, motivate and recognize your community members by creating exclusive and independent realms that you govern. {% embed url="" %} # Why Realms? Make your community fun and productive with less work! ## :thinking: The Problem Online communities can be a lot of work to manage, and harder still to harness in productive ways. Without good dedicated people and ways to compensate and recognize hard work, it may be impossible to achieve your vision of what your community could be. This is why we built Realms. We think communities should be fun, and make complex goals easy to achieve. Realms mixes some familiar concepts with new ideas to allow you to guide the community with as much or as little control you want! ## đź’° Reward You need a way to reward your community. Realms offers a very simple way to spin up a new coin whenever you need it. These coins can be initially controlled by administrators, and given away manually by minting them to community members as a reward for doing productive things. Once your realm gets established, allow others to give rewards as well! ## :zap: Energize Give your community a fun way to engage with each other. Empower your community by turning on our unique automatic coin distributions, which gives all coin holders the ability to "like" others. These likes turn into coins at the end of the distribution, which creates a fun way for community to give gratitude to others, while organizing and reinforcing good behavior without direct management by admins. ## :handshake: Unify Come to group decisions easier, faster and fairer. Once your community holds coins, group decisions become simple. With our built in voting system a realm can come to consensus on important decisions quickly and easily. Votes can be configured to reward participants, restrict who can participate, or even put participants coins at risk of loss! Choose the kind of vote that best fits the type of decision at stake. ## :scientist: Specialize Organize your community into specialized groups. Naturally as a community grows, so does the need for specialized roles. Spin up a new realm whenever and wherever you need it, and give it its own unique mission. Take your hands off the wheel and let your specialists harness all the same features as your main realm to organize and incentivize their own work in private. ## :trophy: Recognize Recognize and celebrate your hardest working members. Don't let people fall through the cracks and go unnoticed! Realms aren't games in the traditional sense, but the coins you collect require strategy and thought to earn. These coins will build your influence and reputation within the realm. Once earned, our reporting features can help you discover exceptional members, unlock privilege's, reward or give recognition to individuals within the community. ## :crown: Govern Lead your community however you think is best. Realms can be managed in almost any way you want. We support your option to be completely in control of the realm, to relinquish total control to your community, or any level in between. We just provide the framework and the basic tools: coins and voting, along with some carefully designed mechanisms we think can get you started on the right track to find your own management style and organizational structure. # Try Realms Now Play with the live demo If you think Realms sounds like it could work for your community, we have a sandbox setup to let you play with features in our Discord server. Click the link below! {% embed url="" %} Join our server to try Realms now! {% endembed %} {% embed url="" %} # Install Realms Add the Realms Bot to your server {% hint style="success" %} We are deprecating this version of Realms and developing a new version. Get on the waitlist and you will be notified when its ready! {% endhint %} ## Install {% embed url="" %} ## Discord Required Currently Realms only supports Discord, you must have a Discord Guild with more than 1 member for the best experience. Other than that we suggest browsing the docs to know what to expect and how to use our bot. If you don't know what Discord is, read more here: {% content-ref url="/pages/7CV9B65WkckqvibFZ8ni" %} [Understand Discord](/more/understand-discord) {% endcontent-ref %} ## Add to Your Discord Guild You can add the Realms Bot to your Guild by [clicking here ](https://discord.com/oauth2/authorize?client_id=1219689829336485968)and following the directions to allow the bot to join your discord server. ## Verifying Installation Once the bot has been added you should see it in your users:
You are now ready to start using Realms! # Installation Issues Common issues and fixes when using Realms Some guilds have complex permissions, or moderation tools that may interfere with normal operation of Realms. If you need some help on configuring the correct permissions on the Realms Bot, see [Discord Permissions](/overview/discord-permissions). ### Wick Bot Realms will often notify channels during distribution rounds, and show a list of users participating. This can cause mass mentions, which is automatically blocked by Wick, we suggest whitelisting the Realms bot so that these announcements will work. ### Direct Messages The Realms Bot sends a lot of direct messages to users to notify them of balance changes or other activities in the realms they are a part of. Users often have direct messages disabled. If you want to receive these updates we suggest you enable "allow direct messages from server members" in the "Privacy Settings". Go to the top of your server on the left hand side, press the “V” next to the server name to open the drop down menu.

Top left server dropdown settings

Allow direct messages

# Discord Permissions How to permission Realms in your Discord server ## Discord Docs Discord has an overview of how permissioning works. This will control who has access to channels, as well as who can interact with bot commands and in what channels. Overall Permissions - Command Specific Permissions - ## Restricting Realms By default when you add the Realms bot, its available to everyone and all public channels. In some servers, you may want to isolate Realms to a few channels and not expose commands to all your users. This will walk you through the basics of accomplishing that. Go to the top of your server on the left hand side, press the “V” next to the server name to open the drop down menu.

Server Settings

Go to Server Settings > Integrations, scroll down to “Bots and Apps” and select the Realms app from the list by clicking on the tile.
This will display all the permissions currently granted to the bot. Restricting permissions to tags and channels After reviewing the bot permissions as described above, scroll up the page to the heading “/ Command Permissions ”.
Here you find the “Roles & Members” as well as the “Channels” section. To enable realms in only specific channels or roles, remove the @everyone and # All channels by pressing the red X next to each. Click on “Add roles or members” or “Add channels”. Select the desired roles, members or channels, respectively, tick the box to the left, press “Add” at the bottom or “Cancel” if you change your mind. ## Restricting Commands Once you set up a realm in a designated channel you may want to restrict the Realms commands viewable by users to the one required: /realms. You can achieve this by setting up override commands. Access the bot settings as described in the chapter "[Restricting Realms](#restricting-realms)". If you user private channels you will want to toggle of the @everyone and # All channels.

Command permission section

Head down to the "Commands" section and click on the /realms command field to open and the override section.

Commands overview

Add the role, member and/or channels you want to limit to the /realms command, then save.

/realms override screen

The /realms command is now accessible to users in the respective channel. The override setting is highlighted in the respective command line.

/realms in Commands

Do not forget to add the Realms bot roles tag to the channel if you use private channel settings. For the Realms bot to function activate the /view channel permission. ## Conclusion Hopefully this guide gives you enough information to configure and customize access to Realms as much as you need for your community. # For Admins Get started with Realms as a Discord Admin ## Prerequisites Ensure Realms is installed in your server [Install Realms](/overview/install-realms) and you are an admin of the Discord server. ## Permissions We have a dedicated section to Discord permissioning: [Discord Permissions](/overview/discord-permissions). ## Create Your First Realm `/realm create` When you are ready to begin, find or create a channel you want to designate for your first realm and type `/realm create` and hit enter. This will create a realm inside the channel. To interact with this realm, all commands must be issued here. [More information on Discord commands.](/more/understand-discord/discord-command-tutorial) ## Add Realm Admins `/realm add_admin` Realm admins have complete control of the realm and are meant to be trusted actors. When a realm is created, it automatically finds Discord admins and adds them as admins of the realm. You can also add other admins. These admins have power to do anything within the realm, such as minting currency, burning currency, creating votes and distribution rounds. If there are any non Discord admins you want to add as admins of the realm use `/realm add_admin` and search for the user you want to add. ## Minting Currency `/mint` Each realm has a currency which you have full control over by using the \`/mint\` and \`/burn\` commands. Users need to have been minted some currency to be able to interact with the realm. To start, lets give admins some currency. Do a "/mint admin 10" to give 10 units of currency to all admins in the realm. ## Currency Statistics `/realm leaders` At any time you can see the top currency holders in the realm using `/realm leaders`. This acts somewhat like a leaderboard to see who are the most influential people in the realm. ## Create a Vote `/vote create` You can now create a vote and have any currency holders participate. Type `/vote create `. Where description is the text users will see when they are voting, and option 1 and 2 are the options they can vote on. Once the vote is created, its only visible to you, but a few buttons should be available. ## Open the Vote `/vote open` When a vote is created, its not public yet. This allows you to stage multiple hidden votes until you are ready to reveal them. Press the "Start Voting" button, this will open it up to all currency holders. Alternatively you can use the `/vote open ` command. ## See Vote Status `/vote about` Vote progress is visible by using the `/vote about ` command. You must search through all votes to find the particular vote you are interested in. Vote status will tell you how much currency has been used to vote, and how many people voted. This will let you judge if there has been enough participation before closing the vote. ## Close the Vote `/vote close` End the vote and finalize the results by using `/vote close ` or by scrolling to find the "Close Vote" button in the chat window. Closing the vote prevents any more votes from coming in, and shows you a summary of the results, which you can also check with `/vote about `. ## Reward Voters `/mint vote` Realms has the option to retroactively reward vote participants using the `/mint vote ` command. This allows you to give active and participating users a way to earn more currency. Use this command, and select the vote you want to reward. Inputting an amount is optional, so you can omit it to give all vote participants 1 unit of currency. ## Distribute More Currency `/inflation start` Realms has a feature to allow holders to mint new currency in a controlled way using [Currency Inflation](/explore-features/currency-inflation). Only admins can configure inflation using `/inflation update `. The amount here will be the maximum amount of currency minted by the community per time period. Try creating a round with 10 units per minute. Once created, you can do `/inflation start` or `/inflation stop`. ## Liking Peers Once inflation starts, each holder gets an allowance to mint new currency by liking their peers using emojis :thumbsup:. Unlike the mint command, which mints currency instantly, inflation only mints when someone expresses a reaction. Use the :thumbsup:reaction to any messages in the realms channel, this will mint the author half a unit (.5) and mint you half a unit immediately, as well as give both of you a notification. Suggest that people in the channel send messages and react to them using :thumbsup:. ## Inflation Progress `/inflation about` Anyone can see general statistics about the inflation. This includes who is the most liked, who has liked other the most, and who has the most likes left to give. See this using "/inflation about". ## End Inflation `/inflation stop` Ending inflation effectively stops the distributing new currency to mint. Use `/inflation stop` to stop it. It can be resumed at any time with start. ## Changing Reaction Emojis and Values `/realm emoji_add` By default inflation rounds use the thumbs up emoji :thumbsup:reaction to messages, to signal that the reactor wants to give a like to the author. This can be customized for all realms by using `/realm emoji_add`. If you want to remove this default, use `/realm emoji_remove` :thumbsup: If you want to add a new one, you use the same command and set any emoji you like. ## Conclusion This hopefully gives you a basic overview of how to use Realms features and what they do. There are more options to explore, and its up to you to decide how best to apply these tool to your community. If you have any questions, problems, or even requests for new features head to our contacts page and let us know: [Contact](/more/contact). # For Users Getting started with Realms as a user ## Overview If Realms is installed on a Discord guild you are in, then it may have a realm running in various channels, then this tutorial will help you get the most out of it. ## Using the Dashboard `/realms` Realms now has a dashboard you can access all features you need as a user by starting with `/realms` This shows information about your status in the realm, and gives you access to other features.

Example Dashboard

## Understanding the Dashboard The dashboard shows you what realm you are in and the current mission in the first two lines. * `CHAMP` is the realms currency name. * `0 CHAMP` is how many coins are in the wallet. * `0 Likes to Give` is how many likes you have earned through inflation to mint new coins. * `0 Likes Earned` is how many likes people have given to you. * `0 Likes Given` is how many likes you have given away. * `Notifications are disabled` You have the option to enable notifications which will let you know when people like you or your coin balance changes. This is done through direct message from the Realms bot. Enable notifications with the `Enable Notifications` button. * `Currency inflation is disabled` Administrators can enable or disable inflation, which is what allows you to earn and give likes to others through the emoji system. You can see more about inflation with the `Earn Coins` button. * `Faucet is disabled` The faucet allows you to claim free coins or likes to give. You can claim this with the `Claim Coins` button. * `Leaderboard` Lets you see the top coin holders in the realm. * `Show all realms in Guild` - Gives you a list of all the realms and channels you can find them in. ## Find a Realm Click the "Show all realms in Guild" button to list all realms in the current guild, as well as any channels they are connected to.

Example Realms

If you can see these commands, you are good to go, if not, talk to an admin to fix the permissions for access to Realms commands. ## Voting Admins can create new votes. To participate in votes you must hold some coins. Keep an eye out in the channel for new votes that look like this:

A Realms vote

From here just click on the option you want to vote for and enter an amount of coins to weight your selection. An admin will determine when the vote will end and rewards given to voters. ## Currency Inflation Inflation is a way to distribute new coins in a peer to peer way. Once enabled by an admin, you have an opportunity to earn more coins and mint more coins. Learn more about the mechanics here: [#currency-inflation](#currency-inflation "mention"). Understand that during the round, you may be given "likes". Check your balance with `/realms` this will show you how many likes you have earned, and how many you can give away. ## Liking Others During inflation you earn the ability to give likes to users by reacting to their messages with a :thumbsup:. When you like others, both you and the person you liked earn half a coin. This increases the supply of coins, so be strategic around who you like. ## Earning Likes You do not need to hold any coins to be liked. Generally you earn likes by participating in discussions in the realm channel according to the realms mission. This gives others the opportunity to like you. Look at the most influential users in the round with "/currency inflation about", and see who has the most likes to give out. You can also talk to your admin to figure out the best way to earn likes. ## Conclusion Your job as a realm citizen is to try to earn as many coins as you can by participating in the realm activities. Use these coins to influence decisions through voting, and the power structure through distribution rounds. Look to your admins for guidance on what the realm is trying to accomplish. Become and admin of your own realm by starting a new Discord guild and installing Realms! [Install Realms](/overview/install-realms) # Realm ## What is a Realm? A realm is a place that you govern to organize your community and achieve objectives. Each realm has a unique currency that serves as an integral component of governance. Currency enables your realm to come to consensus on important decisions using a wide variety of voting methods. Realms are designed to work with your existing Discord channels and are meant to be as independent or as interconnected as your community needs. # Realm Tutorial Spin up your first Realm The Realms Bot is controlled by Discord chat commands, these will start with slash: `/`.
Navigate to a channel you would like to bind to a realm and use `/realm create` in the chat, and hit enter. You have now created your first realm.
This realm is bound to the channel you created it in, and won't be available anywhere else. In order to do anything with the realm, you must be in the channel that is linked to a realm. `/realm about` will tell you if the current channel you are in is bound to a realm.
### Deleting the Realm {% hint style="danger" %} Deleting a realm is permanent and not recoverable, use at your own risk. {% endhint %} Its as easy to delete the realm as it is to make it. If you need to start over for whatever reason, make sure you are in the channel bound to the realm you want to delete, and type `/realm delete`. # Expanding the Realm Link existing realms to new channels to get more involvement ## Linking Realm to Many Channels If you created a realm in one channel, you can share it across many other channels if you want. This isn't a requirement, but it may be convenient if you want the same realm available in multiple places. Navigate to a Discord channel you want to connect to an existing realm and use `/realm link`
Hit enter, and this command will search through your realms and let you select the one you want to link to the channel. Use the arrow keys, or tab, to go through the options, and once selected, hit enter to lock in selection, enter again to link the channel.
You can just as easily unlink the realm by using `/realm unlink`. # Cloning a Realm Making a copy of an existing realm and cloning its respective settings saves time Unlike using the same realm in different channels by linking, cloning a realm creates a new realm with the settings of the original, thus saving time. Navigate to the Discord channel in which your wish to establish the new, cloned realm and use `/realm clone`. Select the realm to be cloned from the menu.
You are offered the option to clone balances of the original realm members' **coins** as well as **likes** that were minted when inflation was enabled, into your new realm. If you wish to do so select the respective option and enter "True". If a balance is not required, you can skip the respective option since the default setting is "False".
Once you hit enter your new realm is established. You can edit its settings using the settings commands.
# All Realm Commands Full specification for the /realm command {% hint style="info" %} This command is currently in flux as we develop and modify Realms code. Documentation may differ from the current app. {% endhint %} The realm commands let you manage and view information relating directly to the realm. Bring up realm commands with `/realm`
# Realm Roles Understand the various roles in the realm ## Realm Owner Each realm has an owner, this is usually bound to the Discord Guild owner. An owner can nominate or remove administrators ( including themselves ). Owners can also pass ownership to someone else in the Guild. Only owners can delete the realm. ## Realm Admin Admins have control over the currency distribution, creating distribution rounds, and votes. guild members can be given admin rights by the realm owner. Admins can add new admins to the realm. Admins can also remove other admins who were promoted after them. ## Citizens Realms have citizens, these are defined by anyone who holds currency of the realm. This allows them participation in any of the realms governance features, including votes and fair distributions. Entry into the realm is as simple as giving someone a coin! Citizens can be a part of as many realms as they hold a balance for. Citizens will need access to any channels required for them to participate in realm activities. # Currency Learn about coins and how to use them ## What is Currency? Every realm comes with its own currency. Currencies are an accounting unit that is under control of the realm admins. They have no monetary value, Its simply a unit that can mean whatever the realm wants it to mean. Currency can be distributed within your Guild by anyone with admins rights. They have utility when combined with voting; they are used to influence the outcome. The more currency you own the more influence you tend to have in the realm. Looking at currency balances enables you to discover exceptional members or members whos contributions may have otherwise gone unnoticed. # All Currency Commands Full specification for the \`/currency\` command
## currency about See top holders. ## currency balance Check your balance or the balances of other citizens. ## currency export Exports all balances to a CSV file for importing into other applications. Discord names in both formats follow the users unique and permanent discord name. See how to format your CSV file in the [Balance File Format](/explore-features/import-files/balance-file-format) ## currency import Import a valid balance file. This file must be first uploaded to the Realms bot. See [Import Files](/explore-features/import-files) for more information on how to import balances. ## currency reset Resets all coin balances to 0. This is not reversible, unless you export coin balances first. # Currency Mint Create and distribute new coins to your community As a realm owner or admin, control how much currency is in existence, as well as who gets new ones, through the /mint command. # All Mint Commands Mint new currency to individuals or groups
## mint vote
## mint vote\_option
## mint channel
## mint user
## mint users
## mint thread
## mint admin
## mint role
## mint treasury Mint currency to another realms treasury. You cannot mint to your own treasury. Treasuries are an advanced concept that you can read about more here: [Treasury](/explore-features/treasury)
# Currency Burn Remove currency out of circulation or from any holders As a realm owner or admin, control how much currency is in existence, you have the power to take them away using the /burn command. This can apply to individuals and groups. # All Burn Commands Burn coins from individuals or groups of coin holders
## burn admin
## burn channel
## burn role
## burn thread
## burn user
## burn users
## burn vote Use this to undo accidental mints to participants in a vote.
## burn vote\_option Use this to burn coins from people who participated in the vote, but did not vote for the "correct" option.
## burn treasury
Remove your realms coins from another realms treasury. Treasuries are an advanced concept, learn more here [Treasury](/explore-features/treasury). # Currency Inflation Allow your community to distribute currency in a fun and fair way that generates activity and good will between members. Our inflation system aligns individual and group incentives, ultimately letting reputation evolve organically and dynamically giving you a metric to measure each member in your community. ## How does inflation Work? By default inflation is not enabled in the realm, its up to an admin to set the rate of inflation. Once enabled, currency that should be minted is periodically entered into a lottery. Citizens (anyone with a currency balance) have a chance to win the ability to mint a coin. The winner expresses their desire to mint by using an emoji reaction (default :thumbsup:) to an authors message in Discord. This automatically mints 1 unit of currency which gets split between the giver and receiver, earning them half a unit of currency each. ## Who is chosen to mint? Every time there is currency available to mint, the ability is granted through a lottery system. The lottery is weighted by each members relative currency balances. The higher ones holdings ( relative to everyone else) the higher ones chances of being chosen to mint the currency. As long as one is holding any currency, one has a chance to win. ## Why does inflation work this way? The idea behind this form of inflation is to allow a fair, dynamic and unbiased way to distribute the realms currency. With inflation, full distribution of currency is handled by the community based on their preferences. Members that have earned more are assumed to have higher weighted judgement, and therefore earn and distribute more often. ## Why is the coin split? When someone mints a unit of currency to someone else, they are expressing a preference that someone deserves more influence in the realm. With inflation, that unit is split to reward both parties. Imagine if the currency was not split. There would be no reason for anyone to mint, as it would require them being economically altruistic, since they would be elevating someones relative influence above their own. By splitting the reward not only are you rewarding the act of expressing preference through minting, but the relative relationship between the giver and receiver stays roughly the same. ## Why use inflation? 1. Distributing currency among a large community is time consuming for an individual or small group, save time by delegating this process amongst all your citizens. 2. Realms administrators may not see all important contributions, this allows the wisdom of the crowd to participate in recognizing these contributors that might be otherwise missed. 3. Giving the community the ability to "mint" to others makes it more fun and engaging and helps build relationships and ensure citizen retention. 4. Ensure you never miss important contributions because inflation runs all the time, until explicitly stopped by an admin. 5. Inflation promote interaction, feedback and value creation between community members because "minting" is a subjective and interpersonal process. # All Currency Inflation Commands Full specification for /inflation
## inflation update Use update to set the configuration of the inflation at any time. This will need to be configured at least once before starting.
* **type -** Choose how inflation distributes likes, where the amount is split across the whole population proportional to coin holdings, or the amount is given to each coin holder equally. This will have dramatic effects on the rate of coin inflation, one is overall, the other is each citizen. For instance if you specify a rate of 100 per day, when "give equally" is selected, this means every day each coin holder will earn 100 likes to give out. If "proportional" is selected, those 100 likes are split pro-rata across the entire realm
* **amount** - This is the amount of "likes" that can be given away by your community. Every time a "like" is given, it turns into a coin, split between the giver and the receiver. By default this amount is the total amount minted for the realm * **per** - When specifying an inflation rate, you are asked to choose a time period. You cannot choose a combination that calculates to more than coin per second. Realms allow new coins to be minted at the rate you specify as soon as a coin is available. For instance if you specified 60 coins per hour, realms would not give 60 mints every hour, but once every minute.
* **max\_unused** - This command allows to limit the amount of likes members of the realm can accumulate once inflation is activated. The default setting is unlimited. A limit is set by adding a desired maximum number.
* **reward\_split\_percent** - By default any like given leads the underlying coin amount to be split equally amongst giver and receiver. E.g., if one like was set as one coin, then giver and receiver each receive half a coin. This command allows to change this ratio, with either party receiving up to 100% of the coin. If you only want the receiver to receive the coin, enter 100, if you only want the giver to receive the coin, enter 0. Other ratio values can be set, respectively.
* **max\_message\_age\_hours** - By default likes can be withdrawn which removes a coin share given and adds the available like back to the givers balance. The above command reverses this ability by adding the amount of hours within which such a like withdrawal is possible. To revert back to unlimited default setting, add a 0.
* **prevent\_self\_reaction** - The inflation mechanism allows users to add a like- emoji to their own message to entice a reaction by fellow members, e.g. in a gaming environment. **Such self-reaction does, however, not generate any coin distribution.** To disable a self-reaction, resolve to "True".
* **auto\_seed\_reactions** - Disabled by default, this setting enables to automatically add those like-emojis to a user generated message embedded in the realm.

To activate, resolve to "True", to resume to default setting, resolve to "False".

* **prevent\_reactions\_without\_likes** - The only way for a users to know they have run out of likes is by not receiving a realm notification, if enabled, or by regularly checking their balance using /realms. Admins have additional commands. The setting, once enabled, automtically removes a like-emoji given if a user's balance is depleted.
* **prevent\_non\_inflation\_rections** - This setting, enabled if resolved to "True", prevents the use of any other emoji in the channle apart from those embeded as like-emojis in the realm. Once enabled, resolve to "False" to deactivate.
## inflation start Begin inflation at any point. ## inflation stop Stop automatic inflation at any time, use /inflation start to resume it. ## inflation about See if inflation is enabled and if so see details about it. Shows information similar to this:
# Vote ## What is Voting Voting is a powerful tool allowing the entire realm to participate in decision making. You have the ability to hold traditional votes, where you pose a question with possible responses. Additionally there is a wide array of currency based options, which create different incentives for participants depending on the type of decision. For more details take a look at the options described below. ## Vote Options Our voting system is extremely flexible and has some unique modes not found anywhere else. Voting is based on currency, but you have control over how much influence it can have on the vote. Each one of these modes can be mixed and matched based on the needs of your specific decision. ### No Limit Allow voters to stake as much as they want when they vote. This gives large coin holders higher influence in the outcome. This is the default vote setting. ### Limit Set a maximum limit which can be used to weigh a vote. This keeps votes a bit fairer to those that don't hold as many coins. ### Restricted Set a minimum number required to vote. Use this when you want the opinion of older more established members. ### Traditional Limit votes to a single unit per person, as long as you have a balance you can participate. ### Combat A unique mechanism that requires users to wager their coins along with their vote. The more contentious the vote, the more coins will be permanently lost. Use this to incentivize more thoughtful participation and debate before votes are cast. See [Combat Vote](/explore-features/vote/combat-vote). ### Quiz A trivia style vote where you create options and a correct answer. Participants can earn or lose balance depending on how they answer. See [Quiz](/explore-features/quiz). # Basic Voting Tutorial Create consensus for decisions within the realm Voting is very simple within realms. First go to a discord channel that currently has a realm enabled, and type `/vote create`. ## Creating a vote
You can see here you must provide more information. The description is the prompt you want your realm to see in order to know how to vote, and you must have at least 2 options which people can choose from.
This is all you need to begin a vote! Hit enter and the vote will be staged for you to manage. At this point no-one else can see it yet, until you hit start.
Hit "start voting" and the vote will go public. At any time you want to end the vote, hit "close vote". If you want to avoid any effects of the vote ending, hit cancel, and the outcome of the vote wont be published any noone will gain or lose coins.

What an active vote looks like

Once the vote is running, you can vote on each option. Theres no restriction preventing users from voting on multiple options, as long as they have the coins, and there are no limits on the vote. To vote, click on an option, and you will be prompted to stake some coins.

Casting a ballot requires staking coins, current balance is 1 coin

A window pops up asking to stake coins, and shows our current balance. Since i have 1 coin, i will stake it on option 1. The bot will confirm my selection.
From here you are in charge of ending the vote whenver you feel there has been enough participation. When ending the final results of the vote are tallied and displayed for everyone. Type /vote close, and select the active vote to close, or hit the close button on the vote management widget. The bot should show the results of the vote.

Vote ended

Thats the basics of voting, there are many other options to explore, so check out [All Vote Commands](/explore-features/vote/all-vote-commands). # Combat Vote Learn about the advanced voting features ## What is Combat? Combat allows you to pit your coins against others during a vote. Coins which are staked on opposing options get burned out of existence. This differs from other voting options because it enables the possibility of coin loss. Combat is an experimental mode meant to be enabled for only the highest stakes votes. Tell us what you think about combat in [our Discord server](https://discord.gg/KFhY3JgtPU). ## How does it work? 1. Administrator creates a new vote with the `maxlosspercent` option set to any number between 0 (disabled) and 100 (maximum possible loss). This represents the maximum percentage an individual could lose of their staked coins. 2. Administrator opens the vote to citizens. 3. Citizens vote by staking coins on one or more options. 4. Administrator ends the vote and the combat algorithm calculates the losses. 1. If vote is unanimous, all coins are returned to participants unaffected. 2. If all options received the same amount of votes ( tie ), a percent of coins are burned according to `maxlosspercent` for each option. Any remaining coins are returned relative to their initial stake. 3. If vote is contentious but has a winner, the combat algorithm burns a percent of coins according to `maxlosspercent` for 2nd, 3rd and following places. For example, if set to 100%, all coins from 2nd place down are burned completely. 4. For first place, we burn the same amount of absolute coins that 2nd place lost. For example, if second place has 10 coins burned, first place also burns 10 coins, irrespective of proportion. 5. If any coins remain, they are returned to all participants, proportional to their original stake. If `maxlosspercent` was set to 100%, only 1st place participants will receive any coins back. The outcome of this vote effectively means that everyone loses something if the vote is not unanimous, and it can be made more severe by increasing the `maxlosspercent.` ## Why Use Combat? Regular voting is great when you want an answer from the crowd, but sometimes you need something that lets people put their money where their mouth is. Combat adds risk to voting, and therefore creates a different incentive to participation. 1. Combat makes participants think more carefully about voting. There is an economic consideration that increases the sophistication and education around the issue. 2. Combat filters out those who have no stake in the outcome of the vote. This is because if you have no stake in the outcome, there's no reason to risk any coins, naturally creating both an incentive and disincentive for participation. 3. Combat means potential voters may want to better understand and negotiate with parties who disagree with their opinion before committing, in order to minimize losses. 4. Combat adds finality to contentious votes. By effectively burning opposing coins out of existence, the ability for continued dissent through voting is limited. 5. Combat adds a novel twist to voting that requires strategic thinking which may get your community more engaged in both decision making and community building. # All Vote Commands Full specification for the /vote command Vote commands control new and active votes.
During creation of a vote there are many options. You can have up to 5 options for people to vote on, at least 2 are required. The rest of the options are optional, but allow you to configure the behavior of the vote. ## vote create After creating a vote, the vote stays hidden until you open it.
#### vote open
#### vote about
vote show
vote close
# Quiz Test your community's knowledge and earn coins! Engage your community with multiple choice style questions, where the correct answer can earn you a coin, or potentially lose a coin for answering wrong! Quizzes are type of vote that allow you to pose a question with up to 10 possible answers, and only one correct one. **All options are automatically randomized before presenting to your users**. Earn coins for correct answers, lose coins for wrong answers all within a time limit you decide. Setup all your quiz questions ahead of time and use our built in commands to easily share them with your community. Quizzes require staking coins on answers to participate! # All Quiz Commands See all quiz commands ## quiz create Create a new quiz with up to 10 options. Specify a correct option. All options are randomized before presenting to user. Created quizzes are not shown to users until they are opened.
## quiz import Create quizzes in bulk from a CSV file. You must first create the file and upload it to the Realms bot. See [Quiz File Format](/explore-features/import-files/quiz-file-format) for more information. **Options will be randomized before quiz creation, and correct answer will not always be the first one.** After importing, all quizzes in the file will be in the "created" state, at which you control opening them individually. You can also specify a custom delimiter if your file is not using commas as separators, if not specified, commas will be used. This is sometimes useful to change if you have values in your quiz which requires commas.
## quiz open Open a currently created quiz. Use this after creating a new quiz. This makes it visible to everyone and allows answering to begin.
## quiz about Select a past quiz to see details on it. Only you will see the result.
## quiz close Close an open quiz preventing from further answers and calculate the final results.
## quiz show Show the state of the quiz to the entire channel. Only available to admins.
# Role Promotions Automate role promotions with our optional Realms Role bot {% hint style="info" %} Automated role promotions are accessed through a separate bot that requires permission to manage your Discord guild roles. You must have both Realms bot and Realms Roles bot installed in your guild for automatic role promotion to work. It can be installed [here](https://discord.com/oauth2/authorize?client_id=1234595216288120863). {% endhint %} Enhance your users experience by allowing users to automatically earn Discord roles defined by your realm admins. Create a journey for your users and unlock privilege's within your server for each individual based on the coins they hold. {% hint style="warning" %} In Discord, roles have an order of precedence. Ensure the "Realms Roles" role is placed higher than any roles you want it to manage. This can be found in your server settings -> roles. {% endhint %} #### Installation For automated role promotions to work you must install an additional bot. [**Install now!**](https://discord.com/oauth2/authorize?client_id=1234595216288120863)
# All Role Promotion Commands Manage your automatic role promotions
## promotion create Create a new auto promotion rule in a realm where you specify the minimum amount of coins a user must hold to earn the role, as well as if the role can be lost if balance goes under that limit. Once created promotions are announced in the channel they were created in. Promotions only look at the coins of the realm they were created in, and only 1 role can have a promotion rule at a time. Demotions will remove a role if coin balances fall under the limit.
## promotions edit Change an existing promotion, including changing what channel promotions get announced in. Be careful with enabling demotions, as this will remove roles people have earned if their balances no longer meet minimum requirements.
## promotions about Discover all running promotions in the realm and in other realms in the guild.
## promotions delete Delete a running promotion. It can always be created again. This does not affect any roles earned, only prevents automatic promotions from happening in the future.
## promotions pause\_role If you don't want to delete the promotion, you can pause it and resume it at any time. Pausing just prevents the system from automatically giving out the role.
## promotions resume\_role Resume a previously paused role.
## promotions pause\_all Pause all promotions in one command. Does not affect existing roles.
## promotion resume\_all Resume all promotions in one command.
# Faucet Allow your community to claim coins for themselves Need an automatic way to allow new community members to earn your realms currency? The faucet gives you full control over how much and how often your members can claim free coins, letting them participate in activities right away. The faucet feature can be configured by an admin to give away currency directly, or to give away likes, which allow people to mint currency through the inflation system. # All Faucet Commands Control the faucet
## faucet set\_claim\_amount
# Import Files Import data into Realms from an external source ## About Files Files are a convenient way for you to import data from systems external to Realms, for example you want to seed your realm with balances from another reputational system or cryptocurrency, or you want to manage complex quizzes and votes within a spreadsheet. Realms uses [comma separated value ( CSV ) files](https://www.shopping-cart-migration.com/must-know-tips/5985-csv-what-why-and-how) in order to understand the data you want to import. CSV's are great for representing tabular data, data that is commonly found in spreadsheets like Excel or Google Sheets. CSV's are just plain text data where each line represents a new row, and each column is separated by a comma (,) in each line. Files are only temporary and are subject to the same terms and conditions as Discord file uploads. ## Support Data Types Realms makes it convenient to import data from other systems, by first creating a CSV file and uploading it through discord to the Realms bot. [Quiz File Format](/explore-features/import-files/quiz-file-format) - Generate quiz files to quickly create bulk quizzes! [Balance File Format](/explore-features/import-files/balance-file-format) - Import balances from another system! # All File Commands Manage your file uploads
## file upload Gives you instructions on how to upload your file. You can only have a maximum of 10 files uploaded. ## file delete Delete a file you previously uploaded. ## file download Download a file you previously uploaded. ## file list List all files you have uploaded. # Quiz File Format Generate quizzes in a spreadsheet to import into Realms ## Example Format Copy this example into a file, save it, and you will be able to upload this to the Realms bot as well as import and create 2 new quizzes: ``` Which element on the periodic table is represented by the symbol 'K'?,30,true,true,Potassium,Iron,Helium,Carbon,Neon,Silicon,Nitrogen,Oxygen,Hydrogen,Calcium What is the capital city of Australia?,,,,Canberra,Sydney,Melbourne,Brisbane,Perth,Adelaide ``` In this example we create two quizzes: 1. Which element on the periodic table is represented by the symbol 'K'? * Timer - This has a timer of 30 seconds, which the quiz will automatically close * Punish - It has punish set to true, which will cause wrong answer to lose one point * Reward - It has reward set to true which will cause right answer to gain a point * Correct - The correct answer is Potassium, which is first in the list of options * Options - There are 9 other wrong options which will be randomized on quiz creation 2. What is the capital city of Australia? * Timer - This has a blank spot for timer, which means an admin must close this quiz manually * Punish - It has a blank spot for punish, which defaults to false * Reward - It has a blank spot for reward, which defaults to true * Correct - The correct answer is Canberra * Options - It has 5 more incorrect options, which are randomized on quiz creation ## Quiz CSV Specification If your description or options contain commas, this will cause a problem for importing the file, unfortunately you will need to remove any commas not representing a break in columns. Heading lines will be ignored, but are not necessary to include. To omit an cell, use an empty comma. Realms will do its best to import and create as many quizzes as it can from the file. NOTE: All options will be randomized on quiz creation and will not be presented in the same order as the CSV file | Column Name | Function | Column Type | Required | Default | | ---------------- | ---------------------------------------------------------------------------------- | ------------- | -------- | --------- | | Question | Quiz question | text | True | N/A | | Timer in Seconds | Seconds to run before auto close. If omitted quiz is closed manually. | whole number | False | undefined | | Punish | Remove one coin from wrong answers. If omitted, wrong answers do not remove coins. | true or false | False | False | | Reward | Add one coin from correct answers. If omitted coins are earned for right answers. | true or false | False | True | | Correct Option | The correct option for the quiz description. | text | True | N/A | | Option 2 | An incorrect option to could choose from. | text | True | N/A | | Option 3 - 10 |

Another incorrect option

to choose from.

| text | False | undefined | # Balance File Format The format required to import currency balances ## Example Format Balance file format uses a comma separated value where you specify a discord username and a balance ``` discord_user_1,100 discord_user_2,0 discord_user_3,10 ``` In this example we set balances on 3 users: 1. A user with the username `discord_user_1` set to a balance of 100 coins. 2. A user with the username `discord_user_2` set to a balance of 0 coins. 3. A user with the username `discord_user_3` set to a balance of 10 coins. ## Balance CSV Specification User names can be specified as unique Discord names with or without a discriminator, or a Discord id as a number. When importing the file into balances, any names or ids not found will not be imported, and will generate a warning. Any names not specified in the file will not have their balances changed (if they already have balances in the realm). Balances must be specified as number without a comma ",". Including commas in your numbers like "1,000" will cause issues with final balances. | Column Name | Function | Column Type | Required | Default | | --------------- | ------------------------------------------- | ---------------------- | -------- | ------- | | Discord Account | The account whos balance you want to update | Discord username or ID | True | N/A | | New Balance | The balance you want to set to | Decimal number | True | N/A | # Treasury Learn about your realms treasury Every realm comes with a treasury. This is a place to hold coins from other realms and share it with citizens of your realm. Treasuries are an advanced reputational building tool that allows you to create connections between realms to incentivize work towards complex goals. Imagine you have a community that's grown to the point where you need several different branches or specializations, for instance: 1. A marketing branch 2. A sales branch 3. An engineering branch 4. A product branch 5. A strategy branch Create a new realm for each one of these branches. They can all now operate with their own governance strategies, governance coin, distribution scheme and leadership within those realms. Treasuries allow you as the founder, or owner of the community, to reward each realm with the main community coin. This can be done based on output of each realm, or some pre-agreed on split, or whatever you think makes sense. Rather than minting this to individual members of the realm, you can mint it to the realms treasury. You can imagine some kind of distribution like this: 1. Marketing gets 1000 coins plus more related to performance 2. Sales gets 1000 coins plus more related to performance 3. Engineering gets 5000 coins 4. Product gets 5000 coins 5. Strategy gets 1000 coins Within each of these specialized realms, citizens are effectively share holders of the treasury. Each citizen holds a claim of ownership over the treasury based on their relative coin holdings earned in each specialized realm. As the founder in the main community, you give your coins to each specialized realm, but you are effectively distributing shares to everyone in your community who participates in one of these realms! At any point, one of these specialized realms can issue a "dispersement" which disperses all coins held in the treasury to its citizens. This removes the coin from the treasury and splits them proportionally to all citizens of that realm. Now they hold coins from your founders realm, and can participate in founders governance, votes and other activities. Treasuries can be complicated to understand, but they are an advanced and powerful reputation building feature that gives you both control to weigh the importance of group contributions while allowing groups to organize independently of your influence. # All Treasury Commands All treasury commands
## treasury about Shows you whats in the treasury. Will only contain currencies from other realms.
## treasury disperse Disperse a select currency from an external realm to disperse from the treasury to your citizens. Currency will be split up proportional to citizens balances in the current realm. This will effectively remove all of that currency from the treasury and is not able to be undone.
## treasury disperse\_all Disperse every coin held in the treasury to your citizens, with the same strategy as disperse.
## mint treasury Mint coins from your realm to another realms treasury. See [All Mint Commands](/explore-features/currency-mint/all-mint-commands)
## burn treasury Burn coins from your realm out of another realms treasury. See [All Burn Commands](/explore-features/currency-burn/all-burn-commands)
# Withdrawals Manually manage conversions of a realms currency to something outside of Realms Realms gives you a way to track your realm currency in the case that you want to convert, compensate, sell or trade the currency for something else outside of realms through a basic withdrawal system. By default withdrawals are disabled, and an admin is required to enable it for every realm, as well as specify what citizens are able to withdraw to, and at what rate. Once enabled an admin must initiate withdrawals for everyone within the realm. The withdrawal system has the ability to escrow all users funds while in process, and gives control to the admin to cancel or fulfill each withdrawal. The withdrawal feature makes it a bit easier to manage many operations that need to interface with an external system, for example with a tip.cc bot in order to convert realm coins into some kind of crypto currency. # All Withdraw Commands See all commands for managing withdrawals
## withdraw enable Enable withdrawals for the realm. Once enabled, an admin can force everyone to withdraw and manage the process from there.
# Echelon Ascent Games Join our games built on Realms! {% embed url="" %} Join the Discord Server {% endembed %} # Understand Discord Understand Discord ## The Discord App Discord is a free and very popular real time chat application for building online communities. Anyone can start a community which discord calls a "Guild", and within guilds you can have many types of channels, which are rooms where many people can communicate and collaborate. {% embed url="" %} Discord Official Site {% endembed %} ## Realms and Discord Realms interfaces with Discord as a "bot", it joins your server like a user, and interacts with users through displaying information in your channel or through Discord "commands", which users can submit through the chat input. Our bot gives you full power over the realm, we recommend trying the demo to better understand the usage. {% content-ref url="/pages/cajrBqXL0Uv8nElYicWn" %} [Realm Tutorial](/explore-features/realm/realm-tutorial) {% endcontent-ref %} # About Discord Bots How Discord Bots work ## Discord Bots There are tons of bots in Discord, which do all kinds of things for automation common tasks in your community. Bots can do special things users cant, like show special interfaces, listen for events and respond to specific commands. Discord bots may require special permissions in order to work properly, which you authorize before you add them. ## Realms Bot In order to interact with realms, you need to add our bot to your server. The only permissions required are to allow the bot to send messages on channels and listen for user commands. Our bot does not collect any personal information on users or guilds, other than the publicly available information through the Discord API. {% content-ref url="/pages/ViUoUgoYgyIUfRLyA3Fd" %} [Install Realms](/overview/install-realms) {% endcontent-ref %} # Discord Command Tutorial Understand the basics of commands in Discord ### About Discord Commands Commands are a common way to interact with Discord bots. Realms relies on commands heavily to interact with the Realm Bot. Only you and the bot will see commands you type, they are totally private. Commands start by typing in the chat input box, the same as any message, but by starting the message with `/` (forward slash). This will allow you to start searching for commands, and selecting one through TAB, ARROW UP/DOWN and ENTER keys on the keyboard. You can also use the mouse to simply click a command to select it.

Discord has built in commands, heres an example of what pops up typing /

Commands can sometimes run without any other input, but some commands will need additional input from you. For example it may need to know a target user you are trying to apply the command to. These additional fields are usually called options, parameters or arguments of the command. Discord commands will let you know if you need additional arguments, and will provide a box in the chat to enter them. Some arguments may even allow to to search (for example for users in your guild).

Example Discord command with an option called "message"

Once you understand the basics, commands become a really fast and easy way to manage Realms. ### # Realms Command Overview Realms Commands Overview ### Finding Realm Commands There are a lot of commands to use Realms, but you can search through most if you start with a slash `/` and then start typing. Here is an example of commands available for managing your realm:

All realm commands, Realms is in beta and this list may differ from actual usage

# Limits Things to be aware of! {% hint style="warning" %} ## Realms is under active development! We are currently in beta, which means we are constantly testing and adding new features. Documentation may not be up to date with actual features and capabilities, and some things may not work as expected. Please bear with us while we improve the product and [give us feedback on our discord](https://discord.com/invite/KFhY3JgtPU)! {% endhint %} ## Privacy We use Discord channel names and usernames to help identify people when sending notifications, and our bot responds to commands directed to it. The Realms Bot does not look at or store any other data generated by the users in your Guild. ## Realm Limitations Realms currently has limits on how many citizens can be affected by a single command, like minting. If your community is particularly large (over 1000 users) and you want to mint coins to them all, Realms may come back with an error or it may take a while to complete the request. There are also no limits on how many coins a user can hold, but each realm is issued only a single currency, and if you need more currencies, you must create a new realm! ## Coin Limitations Coins are currently set to be divisible to 2 decimal places, which is usually fine for most operations, but there will be some small losses due to math at this precision. Coins currently are not transferrable between users, but can be fully controlled by admins of the realm. ## Discord Limitations Realms ultimately needs to use the Discord API, and this means we are subject to rate limits, and user interface constraints. We may need to throttle or adjust some of the experience based on load, such as notifications or rate of command usage in order to continue to operate with Discord. # Contact Join our community! ## Talk to us Have questions, ideas, run into problems, or want to learn more? Join our Discord: {% embed url="" %} Talk to us! {% endembed %} Or Email us: # Bugs Report bugs, issues or improvements {% embed url="" %} Bug report form {% endembed %}