anima-codex Svelte Themes

Anima Codex

Open-source desktop character sheet for Anima: Beyond Fantasy. Built with Tauri + Svelte + TypeScript.

Anima Codex

An open-source desktop character sheet for Anima: Beyond Fantasy.
Built with Tauri + SvelteKit + TypeScript.


Prerequisites

Before running the project, ensure you have the following installed:

Tool Version Link
Rust & Cargo 1.70+ https://rustup.rs
Node.js 20+ https://nodejs.org
npm 9+ Included with Node.js

On Windows, also ensure you have:


Getting Started

1. Clone the repository

git clone https://github.com/CFernan/anima-codex.git
cd anima-codex

2. Install dependencies

npm install

3. Run in development mode

npm run tauri dev

The first build will take several minutes as Cargo downloads and compiles Rust dependencies. Subsequent builds will be significantly faster.


Building for Production

To produce a release executable for your current platform:

npm run tauri build

The output artifacts will be located in src-tauri/target/release/bundle/:

Platform Artifact
Windows (MSI) msi/anima-codex_0.1.0_x64_en-US.msi
Windows (NSIS) nsis/anima-codex_0.1.0_x64-setup.exe

Note: Linux and macOS builds will be added when the CI/CD pipeline is configured (US-32).


Project Structure

anima-codex/
├── docs/                   # Project documentation
│   ├── requirements.md
│   ├── architecture.md
│   └── tasking.md
├── examples/               # .acx example files
├── src/                    # Frontend (SvelteKit + TypeScript)
│   ├── lib/                # (pending — US-03 onwards)
│   │   ├── engine/         # Rules engine — no UI dependencies
│   │   ├── schema/         # Zod schemas and inferred types
│   │   ├── stores/         # Svelte reactive stores
│   │   └── i18n/           # Localisation files
│   ├── components/         # (pending — US-16 onwards)
│   │   ├── sheet/          # Character sheet sections
│   │   ├── shared/         # Reusable UI primitives
│   │   └── layout/         # App layout components
│   ├── routes/             # SvelteKit file-based routing
│   └── app.html            # HTML root template
├── src-tauri/              # Desktop wrapper (Rust)
│   ├── src/
│   │   ├── main.rs
│   │   └── lib.rs
│   ├── capabilities/       # Tauri permission declarations
│   ├── icons/              # Application icons
│   └── tauri.conf.json
├── data/                   # (pending — US-05) Base game content catalogs
│   └── rules/              # Computation rules and lookup tables
├── tools/                  # (pending — backlog) Standalone utilities
│   └── xlsx-migrator/
├── tests/                  # (pending — US-03) Unit tests
│   ├── engine/
│   └── schema/
└── static/                 # Static assets

Documentation


License

This project is open-source. License TBD.

Top categories

Loading Svelte Themes