arcane-sdk
Native SDK for integrating Arcane Powered — ownership, achievements, cloud saves, friends. Rust core, multi-engine bindings.
use ArcaneClient;
// Once, at launch. Building the client is the ownership check.
let client = init?;
client.user_id; // signed-in Arcane account
client.game_id; // canonical title id
client.is_owned; // ownership as of the last check
Native engines get the same client as a C ABI singleton — see include/arcane_sdk.h.
The desktop-app side of the wire (endpoints, session.json, error bodies) is specified in DESKTOP_CONTRACT.md.
Docs live in documentation/. Preview with bunx mint dev from that folder. Contributor workflow (PRs, SemVer, merge queue, releases): documentation/contributing.mdx.
Production Ready Documentation can be accessed here Arcane Powered SDK Documentation
License
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Contribute
- Open a PR against
main(merge queue only — no direct pushes). - Use a Conventional Commits PR title.
- If the title is
feat/fix/perf/ breaking, bumpCargo.tomlin the PR (helper below). Otherwise leave the version alone. - Keep the branch up to date with
main. After another releasing PR merges, rebase and bump again so SemVer stays correct. - On merge of a releasing PR, CI tags
vX.Y.Z, publishes to crates.io, and creates a GitHub Release. CI never pushes commits tomain.
| PR title | SemVer in the PR |
|---|---|
feat: ... / feat(scope): ... |
minor |
fix: ... / perf: ... |
patch |
feat!: ... / fix(api)!: ... |
major — but while on 0.x, breaking bumps the minor (0.3.2 → 0.4.0), per SemVer §4 |
chore: / docs: / ci: / test: / refactor: / build: / revert: |
unchanged |
C header
Maintainer repo settings (once)
- Ruleset on
main: PR + merge queue, require branch up to date, optional signed commits. Required checks:PR title / Validate conventional title,PR title / Validate version bump,CI / Check + C header. - Tags: allow Actions (or
RELEASE_TOKEN) to createv*tags — do not allow bot commits ontomain. - Secrets:
CARGO_REGISTRY_TOKEN(crates.io); optionalRELEASE_TOKENfor tags/releases if needed.