Skip to content

jacobr1227/balamod.github.io

 
 

Repository files navigation

Balamod Documentation

Welcome to the official documentation for Balamod, a mod-loader, decompiler, and code injector for the popular poker game, Balatro.

Documentation Site

Building the Documentation

To build the documentation, you need to have mdBook, mdbook-toc, mdbook-tera and mdbook-admonish installed on your system.

You can easily install the mdbook and mdbook-admonish with Cargo:

cargo install mdbook mdbook-admonish mdbook-toc mdbook-tera

Once you have it installed, you can run the following command to build the documentation:

make build

The documentation will be generated in the book directory.

Or you can run the following command to serve the documentation locally:

make serve

Contributing

If you want to contribute to the documentation, you can find the source files in the src directory. Feel free to make changes and submit a pull request.

About

Balamod Github Pages site

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 94.4%
  • Makefile 5.6%