Beetleball Match Rules

=====================================================================
  BEETLEBALL MATCH RULES  v0.1.0
  Custom match rules for Beetleball custom rooms
=====================================================================

Change the rules of your CUSTOM ROOM: dung spawning, indestructible
dung, kickoff balls, match time, goals to win, glass arena walls,
physics, and a ready-made COMPETITIVE preset.

 * Custom rooms only. Matchmaking / ranked games are never changed.
 * The HOST sets the rules. Players with the mod can view them.
 * Most rules only need the mod on the host. "Physics & Arena" rules
   (including the walls) need the mod on EVERY player.

Built for Beetleball on Steam (build 25250887, Unity 6000.3) with
MelonLoader 0.7.3.


---------------------------------------------------------------------
 INSTALLATION
---------------------------------------------------------------------

 WITH A MOD MANAGER (recommended)
  1. Install r2modman or the Thunderstore Mod Manager, pick Beetleball.
  2. Install "Beetleball Match Rules". MelonLoader is installed
     automatically.
  3. Click "Start modded". The first modded launch takes a few
     minutes while MelonLoader prepares the game.

 MANUAL
  1. Find the game folder: in Steam, right-click Beetleball >
     Manage > Browse local files (the folder with Beetleball.exe).
  2. Install MelonLoader 0.7.3 from
       https://github.com/LavaGang/MelonLoader/releases/tag/v0.7.3
     - Installer: run MelonLoader.Installer.exe, pick Beetleball.exe,
       choose version 0.7.3, click Install.  OR
     - Manual: extract MelonLoader.x64.zip into the game folder, so
       "version.dll" and the "MelonLoader" folder sit next to
       Beetleball.exe.
  3. Launch the game once and wait for the main menu (the first
     launch takes a few minutes), then close it.
  4. Copy "Mods\BeetleballMatchRules.dll" from this package into the
     game's "Mods" folder.
  5. Launch the game.


---------------------------------------------------------------------
 HOW TO USE
---------------------------------------------------------------------

  1. Host a custom room.
  2. In "Lobby Config", click "match rules" (under advanced settings).
  3. Click "Preset" to cycle through presets (Vanilla, Competitive,
     ...), or set each rule with the sliders and checkboxes.
     Values in YELLOW are changed from normal. Moving a slider back
     to the normal value resets that rule.
  4. Close the screen and start the match.

  Every launch starts on VANILLA: rules are not remembered between
  launches. To keep a setup, click "save as preset".


---------------------------------------------------------------------
 COMPETITIVE PRESET
---------------------------------------------------------------------

  * One FULL GROWN kickoff ball.
      - First kickoff at the map's neutral spot (no team advantage).
      - After a goal, the ball starts on the side of the team that
        conceded.
      - The ball STAYS STILL until a player touches it.
  * INDESTRUCTIBLE dung and NO BUNNIES: always exactly one ball.
  * GLASS WALLS on the arena sides that CAN'T BE CLIMBED.
    (Walls need the mod on every player.)


---------------------------------------------------------------------
 SETTINGS                                              (normal value)
---------------------------------------------------------------------

 DUNG BALLS
  Bunnies bring new dung ................................ On
  Time between bunnies .................................. 15s
  Time between bunnies in sudden death .................. 12s
  Balls per bunny poop .................................. 1
  Size of bunny poop balls .............................. 1
  Extra merges until a max-size ball explodes ........... 3
  Indestructible dung (balls never explode) ............. Off

 KICKOFF (match start and after every goal)
  Kickoff balls per team ................................ 1
  Only one kickoff ball (first one at center) ........... Off
      Off             = one ball per team
      Alternate sides = sides take turns each round
      Scored-on team  = the team that conceded gets the ball
  Kickoff ball size ..................................... 1
  Kickoff balls start full grown ........................ Off
  Extra ball at center (size) ........................... None
  Kickoff balls stay still until a player touches them .. Off

 MATCH
  Match time ............................................ 10:00
  Goals to win .......................................... 3
  Points per goal ....................................... 1
  Pause after a goal .................................... 5s

 PHYSICS & ARENA (every player needs the mod)
  Glass walls on the arena sides ........................ Off
  Walls can't be walked or climbed on ................... Off
  Max dung size (full grown) ............................ 5
  Dung weight ........................................... x1
  Dung gravity .......................................... x1
  Beetle move speed ..................................... x1
  Beetle jump power ..................................... x1
  Headbutt cooldown (lower = more often) ................ x1
  Ball shot power ....................................... x1

  Glass walls are infinite (up and down) and included for:
  Beach, Crater, Egypt and Snow. The other maps already have their
  own walls or don't need them.


---------------------------------------------------------------------
 WHO NEEDS THE MOD?
---------------------------------------------------------------------

  Dung Balls, Kickoff, Match ...... only the host
  Physics & Arena ................. every player

  Each player's game runs the physics for their own beetle and the
  balls they touch. Players without the mod would go through walls
  or play with normal values. While Physics & Arena rules are on,
  the Match Rules screen turns ORANGE and names anyone missing the
  mod.


---------------------------------------------------------------------
 PRESETS
---------------------------------------------------------------------

  Vanilla ............ normal game
  Competitive ........ see above
  Center Showdown .... no team balls, one full-grown ball in the center
  Dung Frenzy ........ bunnies every 5s, 3 balls per poop,
                       3 kickoff balls per team
  Full Grown Kickoff . each team starts with a full-grown ball
  Indestructible ..... dung never explodes
  Marathon ........... 30:00, first to 10
  Mega Merge ......... bigger bunny drops and kickoff balls,
                       10 extra merges before exploding
  No Bunnies ......... no bunny dung, 3 kickoff balls per team
  Quick Match ........ 3:00, first to 2, short pause after goals
  Tanky Dung ......... 8 extra merges before exploding

  Presets are plain text files in UserData\MatchRules\
  (manual install: game folder / mod manager: your profile folder,
  Settings > Browse profile folder).
  "save as preset" creates "My Rules 1.json", "My Rules 2.json", ...
  Rename them as you like and share them: friends just drop the
  .json file into the same folder.


---------------------------------------------------------------------
 GOOD TO KNOW
---------------------------------------------------------------------

 * If the host leaves mid-match and the game moves hosting to a
   player without the mod, the rest of that match uses normal rules.
 * "Indestructible" stops the over-max-size explosion. A ball knocked
   off the map is still removed. With bunnies off, a new ball comes
   after the next goal.
 * Players without the mod may see "first to 3" on their HUD even if
   the host set a different number of goals. The host's rule decides
   the winner.
 * Please only use custom rules in rooms where everyone agrees.


---------------------------------------------------------------------
 GAME UPDATES / TROUBLESHOOTING
---------------------------------------------------------------------

 * After a Beetleball update, MelonLoader rebuilds its files on the
   next launch (a few minutes again).
 * If an update breaks part of the mod, the affected rules switch
   themselves off and the rest keeps working. If the game
   misbehaves, disable the mod and wait for an update.
 * Log file: MelonLoader\Latest.log (game folder or mod manager
   profile). Lines tagged [Beetleball_Match_Rules] come from this
   mod. Include this file when reporting a problem.


---------------------------------------------------------------------
 UNINSTALL
---------------------------------------------------------------------

  Mod manager: disable/uninstall the mod in your profile, or start
  the game from Steam (vanilla).

  Manual: delete Mods\BeetleballMatchRules.dll
  To remove MelonLoader too, delete version.dll and the folders
  MelonLoader, Mods, Plugins, UserLibs and UserData from the game
  folder.