Managing Players

Everything here uses /index <player> (optimalindex.others) and /indexadmin (optimalindex.admin).

Viewing another player’s index

/index Notch

Opens the main menu for that player’s index. Everything in it, the profile head, counts, rank and the categories you open from it, shows their progress. The one exception is the {self} line in the leaderboard item, which always shows your own position.

• Online players open straight away. If they only just joined and their data is still loading, you get TARGET-LOADING; try again a moment later.
• Offline players are looked up by the last name they joined with (case does not matter). A name that has never joined since OptimalIndex was installed gets UNKNOWN-PLAYER.

Both permissions default to everyone. To keep indexes private, negate optimalindex.others in your permissions plugin.

Granting discoveries

/indexadmin discover <player> <item|all>

• <item> is an entry key: oak_log, diamond_sword, splash_potion:long_swiftness. Tab completion lists every key in the index.
• all discovers every entry in the index at once.
• The target must be online. Grants ignore Ignored-Game-Modes and Disabled-Worlds.

The player is told exactly as if they had found the items themselves: DISCOVERED or DISCOVERED-MULTIPLE, any CATEGORY-COMPLETED, and INDEX-COMPLETED (plus the server broadcast) if the grant finishes their index. You get ADMIN-DISCOVERED with the number of entries that were actually new. Entries they already had are skipped and keep their original discovery time.

Granting is also how you test

/indexadmin discover <you> all followed by /indexadmin reset <you> is the quickest way to see every discovered state, the completion title and the broadcast, and put yourself back afterwards.

Removing discoveries

/indexadmin reset <player>              # everything
/indexadmin reset <player> all          # everything
/indexadmin reset <player> <item>       # one entry

The target must be online. The removal is silent for the player; you get ADMIN-RESET with the number of discoveries removed. Removed entries can be discovered again normally, with a fresh timestamp.

The leaderboard

The leaderboard lists the top Leaderboard.Size players (default 5) by discovered entries. Only players with at least one discovery are ranked.

• Ties go to whoever reached that count first.
• {rank} is the player’s position in the list when they are in it, otherwise one more than the number of players with a higher count.
• It refreshes in the background every Leaderboard.Refresh-Interval seconds (default 60), and only when something changed. The rank, the {completed} count and the “Found by” count on each entry ({found}) all come from that refresh, so they can lag behind by up to one interval.
• Before the first refresh after a start, {rank} shows Leaderboard.Unranked (?).

How each line looks is set in config.yml.

Changing the catalog under players

Counts are always “discovered entries that still exist in the index”. When you remove entries or a category, online players are recounted on /indexadmin reload and offline players when they next join. The removed discoveries stay in the database, so restoring the entries restores them too. See Creating Categories.