The documents folder in the SAAI directory is where all server-related information is stored. This folder can contain multiple files in various formats with relevant information about your server.
It is recommended to use the Markdown (.md) format for your documents, as it allows for clickable links in both Minecraft and Discord when the AI assistant includes them in its responses. Additionally, using Markdown helps the Large Language Model (LLM) better understand the structure and formatting of your documents, leading to more accurate and context-aware responses.
Using Multiple Documents and Sub-Folders
Multiple documents can be used simultaneously, combining different file types as needed. This allows for more organized and structured information management. ServerAssistantAI also supports sub-folders within the documents/ directory, enabling categorization and grouping of files for better clarity and easier maintenance.
For example, the documents/ directory could have:
A main server rules document in Markdown
A FAQ in a text file
A detailed server guide in PDF format
Event schedules in an Excel spreadsheet
Sub-folders for different topics, such as:
rules/ for server rules and regulations
guides/ for various guides and tutorials
events/ for event-related documents
Content and Structure
The content of these documents is used by ServerAssistantAI to generate context-aware responses to player questions. The AI assistant searches through all files and sub-folders in the documents/ directory to find information relevant to the player's inquiry, based on the embedding results (chunks) specified in the config.yml file for both Minecraft and Discord, regardless of document size.
There is no specific format you need to follow when creating your documents. You can structure the information in a way that makes sense for your server and is easy for players to understand. However, we have found that the Markdown (.md) format works particularly well for helping the AI better understand the structure and context of the information, leading to more accurate and relevant responses.
The example.txt File
The example.txt file is included in the documents/ directory as a default option. You can use this file alone or in combination with other document types. If you choose to use only the example.txt file, simply replace its content with your server's information.
example.txt
REPLACE TEXT IN THIS FILE WITH YOUR OWN SERVER INFORMATION. YOU CAN USE MULTIPLE DOCUMENTS IN VARIOUS DIFFERENT FORMATS SIMULTANEOUSLY.
========================================================================================================================================
This is a sample text file for ServerAssistantAI.
You can use multiple documents and various file types including .txt, .md, .pdf, and Microsoft Office formats (Word, PowerPoint, Excel).
Place your server's information documents in the 'documents/' folder within the ServerAssistantAI plugin directory.
You can ask any questions related to the information within these documents and get an accurate context-aware response.
To edit this file, remove all the current text and replace it with your server's information, or use separate documents as needed.
For more details on how to set up and use multiple documents and supported file types, please refer to the wiki:
https://wiki.code-solutions.dev/serverassistantai/configuration/documents-folder
========================================================================================================================================
Welcome to Example Server!
Example Server is a Minecraft survival server that offers a variety of systems and commands to enhance your gameplay experience. Here are some of the key features:
The following are commands and systems on the server:
**SYSTEMS & COMMANDS**
Welcome To Example Server!
Below you can see the list of the systems and commands our server comes with:
**Wild/RTP System**
Explore various worlds with ease using our `/wild` or `/rtp` commands! This feature allows you to teleport to multiple worlds, each offering unique environments and resources. Access different worlds through a simple GUI menu. In-depth information like maximum border can be found in this GUI, as well as on our [Server Mechanics](https://example.com/wiki/server-mechanics) wiki page.
`/wild` or `/rtp` - Open GUI and select a destination to be teleported to immediately
**Economy System**
All Players start with $200.
`/balance` - Check how much money you have
`/pay [player] [amount]` - Transfer money to another player
`/baltop` - Richest players on the server
**Shop System**
Players are able to buy and sell a wide range of items through the in-game shop menu, which has a dynamic pricing system that adjusts rates based on supply and demand. With daily resets on stock limits and item availability, both server-wide and for individual players, our shop ensures a fair trading environment that reflects the activity of our economy. Along with this, each tier has its own buy and sell price modifier for the shop.
Available categories: Blocks, Food, Ores, Spawners, Tools, Armor, Farming, Mob Drops, Dyes, and Misc.
`/shop` - Opens the shop menu
`/shop search` - Brings up a search bar to search for shop items matching the name
`/sellgui` - Sell all items by dragging them into the chest at once
`/sell inventory` - Sell all items in your inventory
`/sell hand` - Sell any item you are holding
`/sellall <item> <amount>` - Sells all items in your inventory matching the given item name
**Job System**
All Players start with 2 job spots and the spots increase as your tier increases.
Available Jobs: Miner, Woodcutter, Fisherman, Builder, Crafter, Hunter, Weaponsmith, Enchanter, Brewer, Digger, Farmer, and Explorer
`/job` - Open the menu to join a job
`/jobs join [job]` - Join a job by typing the command in chat
`/jobs leave [job]` - Leave a job by typing the command in chat
`/jobs leaveall` - Leave all jobs
**Home Claim System**
To get land from claim blocks, you can use the golden shovel that you got from the claim Kit. If you did not receive one, you can type /kit claim claim. Click the first block that you would like to start with, and then click the second one across the first block, which will claim everything in-between that area. Every hour players will receive 100 claim blocks. To buy claim blocks for money, type `/buyclaimblocks (amount of blocks)`.
`/Claimdashboard` - Open the claim dashboard GUI for the claim you're standing in
`/ClaimList` - View all your current claims and easily teleport to any of them
`/Trust` - Gives another player permission to edit in your claim
`/UnTrust` - Revokes any permissions granted to a player in your claim
`/AccessTrust` - Gives a player permission to use your buttons, levers, and beds
`/ContainerTrust` - Gives a player permission to use your buttons, levers, beds, crafting gear, containers, and animals
`/TrustList` - Lists the permissions for the claim you're standing in
`/SubdivideClaims` - Switches your shovel to subdivision mode, so you can subdivide your claims. This allows you to grant others access only to those areas!
`/BasicClaims` - Puts your shovel back in basic claims mode
`/PermissionTrust` - Grants a player permission to share his permission level with others
`/Untrust All` - Removes all permissions for all players in your claim
`/Abandonclaim` - Delete the current claim you're standing in
`/AbandonAllClaims` - Deletes all of your claims
`/TransferClaim` - Transfer the current claim you're standing in to someone else
`/BuyClaimBlocks [Amount]` - Converts server money to claim blocks
`/SellClaimBlocks [Amount]` - Converts claim blocks to server money
`/ExpandClaim [Amount]` - Expands the claim # of amount on each side
Claim Flag Commands:
`/FlagsDashboard` - Opens claim flags dashboard
`/AvailableClaimFlags` - Shows a list of all flags you can use
`/ListClaimFlags` - Shows a list of all flags set in the claim
`/SetClaimFlag [Flag]` - Sets a flag in your claim
`/UnsetClaimFlag [Flag]` - Removes a flag from your claim
Available Claim Flags:
`BuySubclaim` - Allows players to buy the subclaim, which can only be bought by one player
`EnterMessage` - Sends a message to the player when they enter your claim
`NoEnter` - Prevents all players from entering your claim
`NoEnterPlayer` - Blocks specific players from entering in your claim
`ProtectNamedMobs` - Protects mobs that have a name
`NoMobSpawns` - Prevents ALL mobs from spawning in your claim area, good or bad!
`NoMonsters` - Prevents all bad mobs from spawning in this area, and will also prevent them from entering your claim
`AllowPVP` - Allows players to PVP within the claim
`NoPetDamage` - Prevents players from damaging pets in your claim
`NoItemPickup` - Prevents players from picking up items in your claim
`AllowBlockExplosions` - Enable damage caused by explosions (ie: creepers & tnt)
`NoSnowForm` - Prevents snow from forming in your claim
`NoFlight` - Prevents players from flying in your claim
`NoBlockForm` - Prevents blocks from forming or spreading based on world conditions
**Home System
**Provides players with the ability to create, manage, and navigate personal homes and warps within the server.
`/trust [player]` - Trust Player On Land.
`/sethome [home_name]` - Add a home
`/delhome [home_name]` - Delete a home
`/homelist` - Show all available home
`/home [home_name]` - Go home
`/renamehome [home_name] [new_home_name]` - Rename your home
`/warps` - See all the server warps
`/warpgui` - See all the server warps GUI
`/warp [warp_name]` - Warp to a location
`/playerwarp` or `/pwarp` - Create your own player warp for others to join
**Teleport System
**Enhances player interaction and mobility, allowing for quick and easy transportation between players and specific locations.
`/tpahere [player]` - Request players to teleport to you
`/tpask [player]` - Send a request to teleport to players
`/tpaccept` - Accept teleport request
`/tpconfirm` - Confirm teleport to a PVP warp
`/tpadeny` - Deny teleport request
`/tptoggle` - Toggle on/off teleport requests
`/back` - Teleport back to where you were before you died
**Player Warps System**
Players are able to create a player warp for others to join.
`/pwarp` - Displays Player Warp menu.
`/pwarp <warp>` - Teleports to the player warp
`/pwarp set <name> [player]` - Sets a warp to your location
`/pwarp remove <warp>` - Removes the warp
`/pwarp lock <warp>` - Locks the warp
`/pwarp password <set/remove> <warp>` - Adds a password to the warp
`/pwarp desc set/remove <warp> <desc>` - Manage warp descriptions
`/pwarp list [page] [player]` - Lists all the current player warps
`/pwarp amount [player]` - Check how much warps you have
`/pwarp icon <set/remove> <warp>` - Manage warp icons
`/pwarp category set/remove/list <warp> [category]` - Set a warp category
`/pwarp rate <warp> <description>` - Rate a warp
`/pwarp favourite <warp> [player]` - Add a warp to your favorites
**PVP System**
Enable or disable PVP on a per-player basis, default to PVP being disabled, with additional protections against various forms of player damage, such as TNT and potion effects. Also includes Newbie Protection and Anti Kill Abuse.
`/pvp [on/off]` - Toggle PVP
`/pvpstatus [player]` - Check yours or another player's PVP status
**Player Shop System**
Once you reach Coal Tier, you are able to buy and sell your items using player-made chest sign shops. To do this, simply left-click on a chest with the item you want to sell and type in chat how much you want to sell each item for, and then once the shop has been made, add the items in the chest.
`/chestshop create <price> <item>` - Command to create the shop with item in hand or specified
`/chestshop buy` - Change the shop to buying items
`/chestshop sell` - Change the shop to selling items
`/chestshop price <price>` - Change the buy/sell price of the item
`/chestshop suggestprice` - Suggests a recommended price for a shop item, based on other shops
`/finditem TO_BUY <item>` - Find a specific chest shop item to buy
`/finditem TO_SELL <item>` - Find a specific chest shop item to sell
`/finditem hideshop` - Hide your shop from being found using the `finditem` command
`/finditem revealshop` - Add your shop to be found using the `finditem` command
`/chestshop setowner [player]` - Change the Shop Owner
`/chestshop staff` - Shop staff management
`/chestshop size` - Change the bulk size
`/chestshop item` - Change the item of the shop
`/chestshop limit` - Set shop limits
`/chestshop benefit` - Divide benefits between shop owner and other players
`/chestshop discount` - Apply a discount code or manage your own discount codes
`/chestshop fetchmessage` - Show unread shop messages
`/chestshop name [name]` - Changes the name of the chestshop
`/chestshop permission` - Shop permission management
`/chestshop remove` - Removes the shop you’re looking at
`/chestshop transferownership [player]` - Transfer the shop you're looking at to another player
`/chestshop discord` - Manage your personal quickshop discord settings
**Kits System**
Allows players access to a variety of kits on a weekly basis.
`/kits` - View all available kits.
**Rewards System**
Allows players to claim daily and weekly rewards.
`/rewards` - View all available rewards.
**Crate System**
We have crates that you can get by playing and leveling up, redeeming weekly rewards, AFKing in `/warp AFK`, using Vote Points, participating in events, or buying crate keys on [our](http://example.com/store/category/4/) website.
`/crates` - View all crates available
`/crates open [crate name]` - Virtually open a crate while holding a crate key
`/warp crates` - Warp to the crates warp
**Quest System**
Players are able to start quests for specific things and get money for completing them.
Some available quest categories: Bake, Adventure, Armorsmith, Tamer, Farming, Brewing, Digger, Building, Crafter, Breeder, etc.
`/quest` - View all available quests
**Discord Sync System**
Synchronize your in-game ranks with our Discord Server roles!
`/discord link` - Link your Minecraft account to our Discord Server. After entering this command, you'll receive a unique code
Once you have the code, send it as a private message to the @PC. bot on our Discord server. After verifying the code, your game rank will be synced with the corresponding Discord role.
**Auction House System**
Allows players to list their items on the server auction market for others to buy!
`/auctionhouse` or `/ah` - Opens the Auction House GUI
`/ah sell <price> [amount]` - List an item on the auction house for a specific amount
`/ah history` - View your purchase and/or sale history
**Trade System**
Allows players to trade items, claim blocks, XP, and money with other players!
`/trade` - Get further information about trade commands
`/trade (player)` - Send a trade offer to a player
`/trade accept` - Accept to currently pending trade request
`/trade deny` - Refuse trade request
`/trade block (player)` - Blocks trade requests from player
`/trade toggle` - Toggles trade accepts
**Pets System**
Choose a pet companion to accompany you on your adventures!
`/pet gui` - Open the Pet Selection GUI
`/pet remove` - Remove a pet
`/pet rename` - Rename a pet
`/pet spawn` - Spawn a pet you have access to
**Plots System**
Allows players to claim their own plots in the Plot warp. The price to buy a plot is $500, merging with another plot is $1000, and selling a plot is $250.
`/plotgui` - Open Plot Dashboard
`/warp Plots` - Teleport to the Plots Warp
`/plot claim` or `/plot buy` - Claim the plot you are standing on
`/plot delete` - Delete your plot
`/plot home` - Teleport to your plot
`/plot list` - List all your plots
`/plot visit` - Visit another player's plot
`/plot add (player)` - Add a player to the whitelist of the plot
`/plot trust (player)` - Trust a player with more permissions on your plot
`/plot remove (player)` - Remove a player from a plot
`/plot deny (player)` - Deny a user from entering a plot
`/plot kick (player)` - Kick a player from your plot
`/plot merge` - Merge the plot you are standing on with another plot
`/plot like` - Like the plot you are standing on
`/plot dislike` - Dislike the plot you are standing on
`/plot rate` - Rate the plot you are standing on
**ProtectorGPT AI System**
Ask any Minecraft or server-related questions in chat and get help directly in-game from ProtectorGPT, our custom-made AI assistant! It has knowledge of almost every aspect of the server and can instantly help answer any question players may have. Normally, ProtectorGPT only responds when a question is asked related to the server, but it can be tagged using `ProtectorGPT` in the chat message to force the bot to respond to a specific question. These questions should not be inappropriate, or the ability to ask questions will be removed. Players can also privately ask questions to ProtectorGPT. Each player has a limit of 20 questions per day.
`/ai ask <question>` - Ask ProtectorGPT a question privately
`/ai toggle` - Toggle ProtectorGPT automatically answering your questions in chat
`/ai usage` - See the number of questions you have asked as well as the remaining amount you can ask for the day
**Friends System**
The friend system allows players to add each other as friends and to interact with them in various ways.
`/Friend list` - List all your friends
`/Friend Msg [Player] [Message]` - Send a message to a friend
`/Friend Add [Player]` - Add a friend
`/Friend Accept [Player]` - Accept a friend request
`/Friend Deny [Player]` - Deny a friend request
`/Friend Remove [Friend]` - Removes a friend
`/Friend Settings` - Change the settings
**Party System**
The party system allows players to play together and chat with each other privately within the party.
`/Party Join` - Join a party
`/Party Invite` - Invite a player into your party
`/Party Deny` - Deny a party invitation
`/Party Kick` - Kicks a player out of the party
`/Party List` - List all players who are in the party
`/Party Leave` - Leave the party
`/Party Chat` - Send all players in the party a message
`/Party Leader` - Makes another player the party leader
`/Party Toggle` - Toggles on/off party chat or normal chat
**Clan System**
Get the ultimate multiplayer experience by forming clans! Team up with friends or make new allies. You can join an existing clan, set up your own clan, invite members, and manage leadership. After starting or joining a clan you can type `/tags` and select the clan you're in to apply the tag to your name.
`/clan invite [player]` - Invites a player into your clan
`/clan leader [player]` - Makes a player the new leader of your clan
`/clan kick [player]` - Kicks a player from your clan
`/clan name [new clan name]` - Sets a new name for your clan
`/clan delete` - Deletes the clan
`/clan tag [new clan tag]` - Sets a new tag for your clan
`/clan sethome` - Set the home location for your clan
`/clan home` - Teleport to your clan's home
`/clan promote [player]` - Promotes a player to the next clan rank
`/clan demote [player]` - Demotes the player to the previous clan rank
`/clan rank [player]` - Show the player's current rank
`/clan ranks` - Shows all player ranks for your clan
`/clan public` - Makes the clan public, allowing anyone to join
`/clan private` - Makes the clan private; new members must be invited
`/clan party` - Invites all clan members to a party
`/clan chat [message]` - Sends a private message to all clan members
`/clan get [player]` - Retrieves the clan information of a specific player
`/clan list [clan name]` - Lists all the members within a specific clan
`/clan stats [clan name] [stat name]` - Views the statistics of a specific clan
`/clan settings` - Access the clan settings menu
`/clan setcolor [color]` - Sets a custom color for your clan tag. Make sure the `[color]` parameter includes only the Minecraft color format (e.g., 'b' for blue, 'd' for purple, etc)
`/clan rmcolor` - Removes the custom color from your clan tag
`/clan leave` - Leaves your current clan
**Parkour System**
Test your parkour skills with varying difficulty levels.
`/parkour` or `/warp parkour` - Takes you to the parkour area
**Mics. Commands**
`/spawn` - Go back to the main spawn
`/rules` - View server rules in-game
`/links` - Get links to the server's Discord, Website, etc.
`/msg` - Send private messages to other players in-game
`/playtime` - Check your total playtime
`/mail` - Send a message mail to an online or offline player
`/afk` - Toggle being AFK in-game
`/warns` - Check your warns (If any)
`/report (player) (reason)` - Reports a player along with a reason
`/xp` - Shows current XP and experience points information
`/ignore (player)` - Ignore other players or unignore other players
`/list` - Shows a list of all the players that are currently online
`/online` - Shows a list of all the players online (includes players' real names and nicknames)
`/ping` - Shows your current ping
`/discord` - Get the link to our Discord
`/links` - Get the links for our server
`/wiki` - Get the link to the wiki page on our website
`/apply` - Get the link to apply for a staff position
Check **/help** in-game for more commands.
Useful links:
- Status - Click the following link: https://status.example.com/
- Staff/Builder Application - Click the following link (must be logged in): http://example.com/apply/
- Report Player - Click the following link (must be logged in): https://example.com/report/
- Ban Appeal - http://example.com/appeal/
- All Commands - https://example.com/wiki/game-commands/commands
- Purchasable Commands (In-Game Money) - https://example.com/wiki/game-commands/purchasable-commands
- Player Tiers & Perms - http://example.com/wiki/ranks/tiers
- All Custom Enchantments - https://example.com/wiki/custom-enchantments
- Staff Info - https://example.com/wiki/staff-info
- Media Info - https://example.com/wiki/media-info
- Server Mechanics - https://example.com/wiki/server-mechanics
- Vote - http://example.com/vote
- Store - http://example.com/store
- Discord Features - https://example.com/wiki/discord
Discord:
http://example.com/discord
Main Website: http://example.com/
We hope you enjoy your time on Example Server! If you have any questions or need assistance, feel free to reach out to our friendly staff or consult our comprehensive wiki.
Keeping Information Up-to-Date
To ensure the AI provides accurate and helpful responses, it is essential to keep all documents in the documents/ directory up-to-date with the latest server information and format them in a clear and organized manner.
ServerAssistantAI Document Creator
The ServerAssistantAI Document Creator is a web-based tool that simplifies the creation of documents for your server by crawling and converting content from multiple websites. It currently uses FireCrawl's API but will soon not require it.
Features:
Crawl multiple websites simultaneously
Convert content to .txt and .md files
Customize crawling with includes, excludes, and limits
Export options: main content only, include HTML, raw HTML, separate pages
Enter your server website URLs and configure options
Select the needed options and click "Create Document"
Wait a few seconds for crawling to complete
Download the generated files and add them to your documents/ directory
StackEdit.io can be used to easily copy formatting and links from your server wiki website to be pasted into your documents as Markdown (.md) format. This online Markdown editor simplifies the process of transferring content from your server's wiki to your information documents while preserving the formatting and structure.
FireCrawl.dev is an advanced web crawling and data conversion tool that can transform your server's website into Markdown (.md) format, and comes with 300 free links/pages to convert, which is plenty for most users. With FireCrawl, you can automatically crawl and convert your server's wiki or documentation site into a format that can be easily added to your documents/ directory.
Remember to reload ServerAssistantAI after making changes to any files in the documents/ directory or its sub-folders for the changes to take effect.
