Ascribe

Getting Started

Simple Install

If you just want to download the Ascribe installer, simply download the latest version from the Ascribe Website, us it to install the program, and off you go!

NOTE: Currently, there is no updater and save files may contain breaking changes when upgrading to versions, so if you are updating the project, you need to uninstall the old version, and install the new one, while deleting the save.txt file. However, this should change as a updater is planned in the future

NOTE: As of version 0.4.2, there is a migration system in place for save files, however if you are migrating from version 0.4.1 to 0.4.2, you need to rename your save.txt to save.json. Also, version 0.4.1 is the lowest supported save version, any earlier save version may crash when loaded

Compiling from Source

In order to compile and run the project from source, use the following steps:

1. Download and install the rustc compiler
2. Run the command cargo install tauri-cli --version "^2.0.0 --locked", which will install the Tauri CLI utilities library. see this example
3. Download Node.js
4. Run the command npm install -g typescript, which will install typescript globally on your machine. See this example
5. Install LLVM using Chocolatey, or whatever install method you prefer. NOTE: This project uses LLVM to compile Piper, which is the text to speech engine.
6. Clone the project on your machine from its GitHub repository
7. Finally:
   • To run in debug mode: call cargo tauri dev in the project's root folder.
   • To run in release mode: call cargo tauri dev --release in the project's root folder
   • To build the projects installer:
     1. Call cargo tauri build in the project's root folder
     2. Go to src-tauri/target/release/bundle where you will see a list of installation folders, where you can select either msi or nsis installers.
     3. When executed, it will be the same as installing the project from the provided installers on this website.