Coder Social home page Coder Social logo

sapin's Introduction

Sapin

🌲 A simple crosshair overlay for PC games

install

Sapin is a portable executable, no installation is required.
Download the latest binary from releases and run it.

configuration

You can change things like the crosshair color, shape (crosshair or dot), transparency, size, thickness, gap etc…

Sapin ship with a tray icon, right click on it to access the settings.
Click Config to open the configuration file location and open config.toml with notepad (or any text editor) to modify it.
The crosshair overlay is hot reloaded when the config file is saved.

FAQ

Oses supported?

Windows (tested on Windows 10 and 11).

Is it a cheat?

No, Sapin is just an overlay, it doesn't interact with the game in any way.
It opens a window on top of all other windows, centered, and draws the crosshair on it.
Feel free to check the source code.

Which games are supported?

It should work with most games (in fullscreen and fullscreen windowed modes).

It doesn't work with my game

Some games block overlays, you can try to run the game in windowed mode.

Can I get banned for using Sapin?

-> Is it a cheat?
I can't guarantee that you won't get banned, use at your own risk.

Windows flags it as a virus

It's a false positive, Sapin is open source, feel free to check the source code.
Signing the executable would fix the issue, but it costs money, so I'm not planning to do it.
If Windows Defender is blocking the executable, you can add an exception for it.

development

prerequisites

Install the dependencies

bun i

dev

bun tauri dev

Custom log level can be set via the RUST_LOG env variable, for example: RUST_LOG=info,sapin=trace

build

bun tauri build

license

MPL-2.0


built using Rust, tauri, Svelte and HTML canvas

sapin's People

Contributors

doums avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.