Skip to content

Latest commit

 

History

History
75 lines (54 loc) · 2.11 KB

README.md

File metadata and controls

75 lines (54 loc) · 2.11 KB

Scum Map Overlay

Scum Map Overlay by [CTsys]

This project is an interactive overlay for the game SCUM, allowing players to display various map overlays while playing.

🚀 Features

  • Select and toggle different map overlays.
  • Transparent overlay that stacks selected images.
  • Always-on-top floating menu for easy access.
  • Draggable interface for convenience.
  • ReadMe / Instructions dialog for guidance.

📌 Requirements

  • Operating System: Windows (Mac/Linux support is limited)
  • Python Version: 3.x
  • Dependencies:
    • tkinter
    • PIL (Pillow)

Install dependencies using:

pip install pillow

⚠️ Important

  • This overlay ONLY works when SCUM is in Borderless Fullscreen mode!
    • Navigate to Esc-menu > Options > Video > Display Mode > Borderless Fullscreen
  • If no overlays are selected, nothing will be displayed.

📥 Installation & Usage

  1. Clone the repository 
    git clone https://github.com/tahembre/scum-map-overlay.git
cd scum-map-overlay
  2. Run the script 
    python overlay.py
  3. How to use:
    • Click the Menu button to open the overlay selection.
    • Choose your desired map layers and click Apply.
    • The overlay will appear on top of the game screen.
    • Click anywhere on the overlay to close it.
    • The ReadMe / Instructions button provides in-app guidance.

🎮 Controls

  • Menu Button: Opens overlay selection.
  • Apply Button: Displays selected overlays.
  • Drag to Move: Click and drag the buttons to reposition.
  • Click Overlay: Closes the overlay.

📢 Reporting Issues

If you find any errors or flaws, feel free to report them on Discord or create an issue on GitHub.

📡 Community & Support

Join our Discord to stay updated on our Open Source software:

🔗 Discord: Join Here

🔗 GitHub:

[𝐂𝐓ˢʸˢ]𝐓𝐡𝐞𝐁𝐥𝐮𝐞𝐎𝐧𝐞 & [𝐂𝐓ˢʸˢ]𝐭𝐢𝐤𝐫𝐞𝟗𝟏