Skip to content

The support library for Tesla overlays

License

Notifications You must be signed in to change notification settings

Pugemon/libnikola

 
 

Repository files navigation

libnikola

libnikola is the interface between the Tesla overlay loader and user-made Overlays. It handles all layer creation, UI creation, drawing and input management. It's main goal is to make sure all overlays look and feel similar and don't differenciate themselves from the switch's native overlays.

Screenshots

Overlays do NOT show up on Screenshots. These pictures were taken using a capture card

Example

An example for how to use libnikola can be found here: https://github.com/WerWolv/libtesla/tree/master/example To create your own Overlay, please consider creating a new repository using the official Tesla overlay template: https://github.com/WerWolv/Tesla-Template

Please Note: While it is possible to create overlays without libnikola, it's highly recommended to not do so. libnikola handles showing and hiding of overlays, button combo detection, layer creation and a lot more. Not using it will lead to an inconsistent user experience when using multiple different overlays ultimately making it worse for the end user. If something's missing, please consider opening a PR here.

Building and installing

See the BUILDING document.

Contributing

See the CONTRIBUTING document.

License

See the LICENSE document

Credits

  • switchbrew for nx-hbloader which is used as basis for overlay loading
  • kardch for the amazing icon
  • All the devs on AtlasNX, RetroNX and Switchbrew for their feedback
  • All overlay devs for making something awesome out of this :)

About

The support library for Tesla overlays

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • C 59.1%
  • C++ 36.9%
  • CMake 4.0%