> For the complete documentation index, see [llms.txt](https://augu0107.gitbook.io/auguplugin-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://augu0107.gitbook.io/auguplugin-docs/plugins/sumoplugin/setup.md). # Setup {% tabs %} {% tab title="Configuration" %} In the file: plugins/SumoPlugin/config.yml you will find the setup The file will look like this: ``` # IP shown in the sidebar scoreboard server-ip: basicalityisland.playmc.be # GUI display mode: "all" shows all arenas together, "category" shows 1v1/2v2 selection first gui-type: category # Check for updates on startup and notify OPs on join check-updates: true ``` | Option | Usage | | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | server-ip | The server ip that will be show in scoreboard | | gui-type | It change the gui of /sumo gui if you set it to all it will shows all arenas if you set category it will show if you want to play in a 1vs1 arena or in a 2vs2 arenas | | check-updates | Notify OP players if there is a new version of the plugin | {% endtab %} {% tab title="Messages" %} In the file: plugins/SumoPlugin/messages.yml you will find the messages The file will look like this: ``` # ───────────────────────────────────────────────────────────── # SumoPlugin - messages.yml # Supports & color codes. Use {0}, {1}... for placeholders. # ───────────────────────────────────────────────────────────── # ── General ────────────────────────────────────────────────── prefix: "&8[&6Sumo&8] &r" no-permission: "&cYou don't have permission." only-players: "&cOnly players can use this command." # ── Join / Leave ───────────────────────────────────────────── player-joined: "&e{0} &7joined! &f({1})" player-left-waiting: "&c{0} &7left. Waiting for players..." already-in-game: "&cYou are already in a game!" arena-busy: "&cThat arena is currently busy!" arena-full: "&cThat arena is full!" left-arena: "&eYou left the arena." cant-leave-running: "&cYou can't leave during an active game!" # ── Titles ─────────────────────────────────────────────────── title-start: "&aSTART!" title-start-subtitle: "" title-win: "&6YOU WIN!" title-win-subtitle: "&eYou knocked them off!" title-win-disconnect: "&6YOU WIN!" title-win-disconnect-sub: "&eOpponent disconnected!" title-lose: "&cYOU LOSE!" title-lose-subtitle: "&7You fell off!" title-draw: "&eDrawRAW!" title-draw-subtitle: "&7Time ran out!" # ── Items ───────────────────────────────────────────────────── item-leave-name: "&cReturn to Lobby" item-stick-name: "&6Knockback Stick" # ── Stats command ───────────────────────────────────────────── stats-header: "&6&l» Sumo Stats" stats-wins: "&a Wins: &f{0}" stats-losses: "&c Losses: &f{0}" # ── Admin feedback ──────────────────────────────────────────── arena-created: "&aArena '&f{0}&a' created! Set spawns and lobby." arena-already-exists: "&cArena '&f{0}&c' already exists!" arena-not-found: "&cArena not found!" spawn-set: "&aSpawn &f{0}&a set!" arena-lobby-set: "&aWaiting lobby set for '&f{0}&a'!'" arena-deleted: "&aArena '&f{0}&a' deleted!" arena-type-set: "&aArena '&f{0}&a' type set to &f{1}&a!" general-lobby-set: "&aGeneral lobby set!" server-ip-set: "&aServer IP set to: &f{0}" reload-done: "&aConfig and messages reloaded successfully!" world-mobs-cleared: "&bWorld '&f{0}&b': mob spawning disabled, &f{1}&b mob(s) removed." # ── GUI ─────────────────────────────────────────────────────── gui-title: "&3&lSumo &8- &3Select Arena" gui-no-arenas-name: "&cNo arenas available!" gui-no-arenas-lore: "&7Ask an admin to set one up." gui-arena-status-waiting: "&aWaiting" gui-arena-status-starting: "&eStarting" gui-arena-status-running: "&cIn Game" gui-arena-status-ending: "&7Ending" gui-arena-lore-status: "&7Status: {0}" gui-arena-lore-players: "&7Players: &f{0}" gui-arena-lore-join: "&a▶ Click to join!" gui-arena-lore-busy: "&c✗ Arena is busy" # ───────────────────────────────────────────────────────────── # SCOREBOARD # ───────────────────────────────────────────────────────────── scoreboard: # Sidebar title (always visible at the top) title: "&6&lSUMO" waiting: line3: "&eWaiting for players.." # top line line2: "&f{0}" # {0} = "current/max" passed from code line1: " " line0: "&8{ip}" # {ip} = server-ip from config.yml starting: line3: "&eStarting..." line2: "&f{0}" # {0} = countdown number line1: " " line0: "&8{ip}" running: line3: "&aGame started" line2: "&fTime {0}" # {0} = mm:ss line1: " " line0: "&8{ip}" ``` | Category | Usage | | -------------- | -------------------------------------- | | General | General Sumo texts | | Join/Leave | When a player join/leave an arena | | Titles | Titles used while in game | | Items | Names of items | | Stats command | Texts for /sumo stats command | | Admin feedback | Feedback when running an admin command | | GUI | Texts of the /sumo gui command | | SCOREBOARD | Scoreboard texts | | {% endtab %} | | | {% endtabs %} | | After configuring the plugin go in the lobby of Sumo and do /sumo general setlobby for setting the lobby that player will get teleported when a game finish --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://augu0107.gitbook.io/auguplugin-docs/plugins/sumoplugin/setup.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.