Welcome to the main page of the documentation. (SUPPORT.md)

This guide contains installation, configuration, and support informations.

Please note that ShizuCallRecorder is a free, FOSS, project. It may work, but it may also not (you should look at existing issues and make a detailed issue if none exists!)

## Installation / Configuration
If you are new to ShizuCallRecorder, please check the [configuration documentation](./configuration.md).

>[!TIP]
> This application only saves recording files. If you would like a visual interface to browse the files and see your contact names, you can use an application like [bcr-gui](https://github.com/nicorac/bcr-gui) (unrelated to this project). I made ShizuCallRecorder in a way that it replicates the [BCR](https://github.com/chenxiaolong/BCR) file name format. **I will not add a visual interface, I want to keep the app relatively simple**.

## Issues, bugs and support

If you have issues with ShizuCallRecorder getting killed in background or not starting when you receive a call, please check [dontkillmyapp](https://dontkillmyapp.com/) for specific instructions for you phone OEM.
Also ensure that the application is excluded from battery saving.

If you need help installing, testing, using, or configuring Shizuku and/or ShizuCallRecorder. Please use the correct community support forum. [Shizuku](https://github.com/thedjchi/Shizuku/discussions/categories/q-a) or [ShizuCallRecorder](https://github.com/kitsumed/ShizuCallRecorder/discussions).

If you have a issue **(a bug)** where ShizuCallRecorder does not behave the right way, crash, or has any other unexpected error, please create a new [issue](https://github.com/kitsumed/ShizuCallRecorder/issues).