Skip to content

Latest commit

 

History

History
199 lines (145 loc) · 8.49 KB

README.md

File metadata and controls

199 lines (145 loc) · 8.49 KB
Raw

Prism

Latest version Date of last release Total downloads Discord server

Download for Windows Download for Mac Download for Linux

1 2 3

Examples

Queueing with Prism using AutoWho Using Prism with the autowho integration

Click here for more examples!

The overlay has a highly customizable stats table. In the settings you can configure

  • Which columns to show and their order
  • How to sort the table (by fkdr, by index, by stars, ...)
  • How many decimals you want (9 fkdr vs 9.95 fkdr)
  • If you want the stats colored by their rating (white for meh, yellow for decent, orange for good, red for scary)
  • The levels for the ratings (1 fkdr is meh, 3 fkdr is decent, 6 fkdr is good, ...)
Stars colored by star color with 0 decimals and fkdr, sorted by fkdr

Stars colored by star color with 0 decimals and fkdr, sorted by fkdr

Stars colored by star color, fkdr, kdr and winstreak, sorted by index (fkdr^2*stars)

Stars colored by star color, fkdr, kdr and winstreak, sorted by index (fkdr^2*stars)

Stars colored by star color, fkdr and winstreak, sorted by fkdr

Stars colored by star color, fkdr and winstreak, sorted by fkdr

Stars colored by rating with 0 decimals and fkdr with 1 decimal sorted by fkdr

Stars colored by rating with 0 decimals and fkdr with 1 decimal sorted by fkdr

Every available column, sorted by stars

Every available column, sorted by stars

Download

Click one of the direct download buttons above, or click here to go to the latest release. Your browser might tell you that the file is potentially dangerous, but you can safely ignore this warning. See the section on safety for more info.

NOTE (Mac users): The first time you run the overlay on Mac you may need to shift+right click the application and click run.

Support and feedback

If you need help setting up the overlay or have feedback you can join the discord server. Additionally, feel free to submit issues or pull requests on GitHub.

Description

Prism is an open source stats overlay for Hypixel Bedwars (not associated). Prism will detect the players in your lobby as they join and when you type /who, and automatically show you their stats. The overlay can be extended with the Antisniper API (not associated) to display estimated winstreaks.

Qualities

  • Automatic party and lobby detection
  • Customizable stats table
  • Good players sorted to the top and highlighted in red
  • Fast
  • Discord status integration with session stats
  • Winstreak estimates (with Antisniper API)

Tips

  • Click the "Fullscreen" button on Windows to use the overlay above fullscreen Minecraft
  • Follow the instructions in the settings page to add an Antisniper API key to get winstreak estimates
  • Click on the pencil next to a nicked teammate to set their username

Known issues

Show on tab doesn't work when holding shift

Some keys change when holding down shift (e.g. Shift+1 -> !). Using these keys as the show on tab keybind may cause the overlay to not show when holding shift. Letter keys (a, b, c, ...) and most special keys (Tab, Shift, Caps Lock, ...) should work regardless.

Show on tab doesn't work on Mac

There is an issue with the library used by prism to check when you are pressing tab on Mac. This is unlikely to be fixed in the near future. The overlay will still automatically appear when you join a queue and automatically close when the game starts. If you want to open the overlay mid game you can type /who.

Overlay window is invisible on Linux

This issue happens to me when I start the overlay and then fullscreen Minecraft. I am able to fix it by simply switching workspaces away from and then back to Minecraft. If this does not work there is a secret setting disable_overrideredirect that might help (see this PR). You can change this to true by editing the config file at ~/.config/prism_overlay/settings.toml.

Overlay takes focus when playing on Linux

This might be mitigated by the secret setting hide_with_alpha. You can change this to true by editing the config file at ~/.config/prism_overlay/settings.toml. See this PR.

Safety

Being open source, anyone can look at the source code for Prism to see that nothing nefarious is happening. The released binaries are created using pyinstaller in GitHub Actions from a clean clone of the repository. If you do not trust the released binary you can clone the project and run it from source by installing the dependencies and running python3 prism_overlay.py from the project root. See running the overlay from source for more info.

Running the overlay from source

Note: make sure you have a recent version of Python installed. The overlay currently depends on version >=3.12.

To run the project from source, perform the following steps:

Clone the repository

git clone https://github.com/Amund211/prism

Create and activate a virtual environment (optional)

Use a virtual environment to isolate this project from your system python install. You have to activate the virtual environment each time you want to run the overlay. Check the docs if you are having trouble activating the virtual environment.

python3 -m venv venv  # Create the virtual environment

# How to activate the venv depends on your OS and shell.
# Run one of the following
source venv/bin/activate      # linux/mac + posix sh

source venv\Scripts\activate  # windows + posix sh
venv\Scripts\activate.bat     # windows + cmd
venv\Scripts\activate.ps1     # windows + powershell

Install the dependencies

First, install the dependencies by running one of the following commands depending on your operating system

# You can omit the -dev requirements if you are not going to be doing development
pip3 install -r requirements/windows.txt -r requirements/windows-dev.txt

pip3 install -r requirements/mac.txt -r requirements/mac-dev.txt

pip3 install -r requirements/linux.txt -r requirements/linux-dev.txt

Then, install the overlay:

pip3 install -e .

Run the overlay

python3 prism_overlay.py

Run python3 prism_overlay.py --help to get info about the accepted command line arguments.

Creator info

IGN: Skydeath
UUID: a937646b-f115-44c3-8dbf-9ae4a65669a0

Footnotes

  1. Windows and the Windows logo are registered trademarks of the Microsoft Corporation. ↩

  2. macOs and the Apple logo are trademarks of Apple Inc., registered in the U.S. and other countries and regions. ↩

  3. Linux is the registered trademark of Linus Torvalds in the U.S. and other countries. Tux is the copyright of Larry Ewing <lewing@isc.tamu.edu>. ↩