Home - PIndustries/arkline-engine GitHub Wiki
Arkline documentation
Welcome to the official published documentation for the Arkline Rust engine.
Independent forks, local development and experiments are welcome. Share useful changes through issues and pull requests so the shared engine can improve. P.Industries focuses on the official Arkline network; that operational focus does not make independent worlds second-class projects or require them to use official account infrastructure. See Community and roadmap.
Arkline is an early developer alpha. The current world has one authoritative Rust process with durable SQLite state and independent economic replay. Distributed authority, permissionless node admission and node rewards are not implemented. A build, a deployed endpoint and a verified player journey are separate evidence.
Start here
- Player and developer guide โ complete preview, first-flight, local-build and command-client instructions
- Component and deployment map โ repository responsibilities, data flow and current authority boundary
- Community and roadmap โ independent forks, local experiments and the official network
- Documentation index โ versioned documentation overview
Play and understand the client
- Flight and cockpit controls โ flight, targeting, drones and surface tools
- Browser client โ connection, credentials and browser limits
- Station hangar and quarters โ walking, ship boarding and station spaces
- Ship computer and resource jobs โ confirmed jobs, worker delegation and manual control
- Sound and voice โ audio lifecycle and spoken-command boundaries
Build and extend the engine
-
Arkline Editor โ local play/inspect/material workflows, contributor tooling and implementation limits
-
Game API โ implemented JSON requests, snapshots and authentication
-
Architecture and economic verification โ transactions, conservation and replay limits
-
Models and community artwork โ current meshes and proposed creator format
-
Living-world design โ implemented scenery and planned interfaces
-
Identity integration plan โ configurable standards integration; game login remains separate
Operate and release
- Transport security โ verified TLS boundaries, certificates and renewal
- Web origin TLS โ operator configuration and scoped rollback
- Private world deployment โ one persistent authority and private validation
- Public relays and downloads โ WSS, hosting and release paths
- Public transport limits โ admission, payload and timeout boundaries
- Self-hosted CI and deployment โ runner trust and scoped operations
- Release publication โ verified artifacts, publication and recovery
Evidence, history and policies
- Developer alpha readiness โ publication boundaries and unresolved work
- Validation history โ dated test records, not blanket release guarantees
- Stability audit โ reviewed behavior and limitations
- Station assets audit โ storage permissions and verifier coverage
- Save and spatial migration โ earlier work and persisted-world transitions
- Legacy systems review โ historical source review
- Licensing โ software and asset obligations
- Security and reporting โ responsible reporting and support boundaries
Contribute documentation
The Wiki is the published reader location. The Markdown sources stay in the engine repository so code and documentation changes can be reviewed together. Follow each page's Versioned source link, submit a pull request, and have the reviewed source synchronized to the Wiki. Do not put credentials, private account details or player-world backups in either location.
Source repository ยท Contributing ยท Project website
Ship design archive โ all seven ships, concept history and proposed interiors. Onboard systems covers proposed power, RF/data, air, water and cooling.
- How ship subsystems work together โ power, control, life support, water, cooling, fire response and the mining loop; implemented behavior distinguished from proposals.