Contribution guide

There are many ways to contribute to this project. Thanks to everyone who has contributed! If you have any questions, please contact me at contact@linwood.dev.

There is a matrix server for this project here and a discord server here.

Please follow the Code of Conduct.

Give feedback

The best way to give feedback is to open an issue on GitHub. Please report any bug you find here.

If you have a feature that you would like to see added, please open an issue here.

Test nightly builds

Nightly builds are not production ready and need to be tested. Please report any bugs in the github issues section.

Write documentation

Documentation is important for users to understand the program and its features. The documentation is written in markdown, a simple markup language. It can be found in the docs folder.

To start, please install pnpm.

Get started by running:

cd docs
pnpm install
pnpm start

Feature guides live in docs/src/content/docs/docs/v1/. Register new pages in the sidebar in docs/astro.config.mjs, link related guides, and run pnpm build from docs before submitting changes. See docs/README.md for the documentation workflow.

Fork the project and create a pull request to add your documentation to the develop branch.

Translate

Crowdin is a service that allows you to translate the documentation and the app. Ask in the Setonix community about current translation work. If you have a new language to add, please contact me.

Code

This project is written in Dart and was built with Flutter. The app source code can be found in the app folder.

Please install the dependencies first:

libsecret-1-dev
libjsoncpp-dev

On windows, please install visual studio build tools (or visual studio) and all flutter dependencies. Additionally install the atl library.

To get started, run:

cd app
flutter pub get
flutter run

The repository contains five Dart packages: app (Flutter client), api (shared models and protocol), plugin (Dart/Rust bridge), server (game server), and tools (generation and release scripts). docs and servers are separate Astro projects, each with its own pnpm manifest and lockfile.

Use the Flutter version in app/pubspec.yaml, the Rust toolchain pinned at the repository root, and each website’s pinned packageManager version. Generate the core pack from the repository root before running the client:

dart pub get -C tools
dart run tools/generate.dart

CI checks formatting, strict analysis, generated files, Flutter tests in app, Dart tests in api and server, and the Rust plugin. When changing models, run dart run build_runner build in each affected package and format its generated files before committing.

The package overview above describes the repository layout. User-facing feature guides are in docs/src/content/docs/docs/v1/.

Fork the project and create a pull request to add your code to the develop branch.

Build and release checks

The existing build workflow uses shared helpers from dart_pkgs/packages/generate_leap. From the repository root, prepare inputs once, then build without network access or compare two clean builds:

dart pub get -C tools --enforce-lockfile
dart tools/build_offline.dart prepare --platform windows --flavor production --unsigned
dart tools/build_offline.dart build --platform windows
dart tools/build_offline.dart verify --platform windows

The same commands support android, linux, macos, ios, web and server on their required hosts. Reports are written under .offline-build//reproducibility. Comparisons cover raw artifacts and portable archives; signing and store installers need separate validation. Android APK comparison with F-Droid also requires a published release built from the same inputs. The packaging recipe belongs in the fdroiddata GitLab merge request, linked to the existing request.

Windows development

This repository contains symbolic links, including the Rust toolchain file used by the Setonix plugin. On Windows, Git may check out symbolic links as plain text files when symbolic link support is disabled. This can cause the Flutter Windows build to fail because plugin/rust/rust-toolchain.toml is read as link text instead of as a real symbolic link.

Before cloning the repository on Windows, enable symbolic link support in Git:

git config --global core.symlinks true

Then clone the repository again:

git clone <repository-url>

If the repository was already cloned, enable symbolic links locally and restore the symlink:

git config core.symlinks true
git restore --source=HEAD --staged --worktree plugin/rust/rust-toolchain.toml

If the file is still restored as plain text, remove it and check it out again:

Remove-Item plugin\rust\rust-toolchain.toml
git checkout -f HEAD -- plugin/rust/rust-toolchain.toml

You can verify that Git created a real symbolic link with:

Get-Item plugin\rust\rust-toolchain.toml | Format-List LinkType,Target,FullName

The LinkType should be SymbolicLink.

If Windows does not allow creating symbolic links, enable Developer Mode in Windows settings or run the terminal as Administrator.