Documentation Index - PIndustries/arkline-engine GitHub Wiki
Published Wiki page ยท Versioned source ยท Suggest a source edit
Arkline technical documentation
Read the official Wiki for the published documentation. These Markdown files are the reviewable sources; submit changes through pull requests, then synchronize the reviewed pages to the Wiki.
Play
- Player and developer guide
- Flight and cockpit controls, browser client, sound
- Station and quarters, station asset audit boundaries
- Resource gathering jobs, mining-loop acceptance, living-world design
Build and contribute
For contributor workflow, see the development coordination guide and editor workspace map.
Start with the component and deployment map, then the implemented API. The source protocol is the final field/type contract; these documents describe behavior and trust boundaries.
- Architecture and economic verification
- Shared-account investigation and implementation plan โ proposed, not a working login feature
- Deployment, self-hosted runners, release publication
- Public transport limits, licensing, security policy
Use the editor
- Overview
- Projects and play
- Rooms
- GLB assets
- Engineering and service paths
- Fleet finish
- Hull surface
- Cockpit panels
- Equipment and exterior
- Event flow
- Shared sessions
- Community
- Debug and physics lab
The versioned editor references retain implementation details and source contracts.
Create assets
Design history and test records
- Ship design archive โ seven ships, all concept revisions, interior and systems proposals
- Migration, validation record, preview readiness
A passing build, an implemented source feature, a deployed release and a completed player journey are different kinds of evidence. Release notes and deployment reports identify the exact build tested; source documentation may describe changes awaiting the next release.