anth64/stk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update documentation to have a posix/windows focus. I am big dumb, consoles do not have dlls...

Browse Source
This commit is contained in:
anth64
2025-11-02 09:38:12 +01:00
parent ed6325598c
commit 5ab3da22ae
2 changed files with 9 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -2,7 +2,7 @@
`stk` is a lightweight, modular toolkit for building games and game engines. It provides a **portable foundation** for dynamically loading modules, native or WASM, without enforcing any architecture or design choices. `stk` is a lightweight, modular toolkit for building games and game engines. It provides a **portable foundation** for dynamically loading modules, native or WASM, without enforcing any architecture or design choices.
It is designed to run on a wide range of systems, from retro consoles and embedded devices to modern PCs. It is designed to run on modern systems running POSIX and Windows.
--- ---
docs/design.md
+8 -9
View File
@@ -2,7 +2,7 @@
## Vision ## Vision
`stk` is a lightweight, unopinionated toolkit for building games and engines. It provides a **portable, flexible, and modular foundation** for dynamically loading modules, native or WASM, without imposing design choices. `stk` is a lightweight, unopinionated toolkit for building games and engines. It provides a **portable, flexible, and modular foundation** for dynamically loading modules, native or WASM, without imposing design choices.
`stk` is designed to run **anywhere a C89 compiler exists**. From retro consoles and embedded systems to modern PCs running POSIX or Windows. `stk` is designed to run on POSIX/Windows using C89.
--- ---
@@ -17,7 +17,7 @@
--- ---
## Key Principles ## Key Principles
1. **Portability:** Runs on hardware from retro consoles to modern PCs. 1. **Portability:** Runs on systems that have dynamically linked libraries.
2. **Simplicity:** Minimal API, easy to integrate into any engine or game. 2. **Simplicity:** Minimal API, easy to integrate into any engine or game.
3. **Flexibility:** Supports multiple languages via optional WASM modules. 3. **Flexibility:** Supports multiple languages via optional WASM modules.
4. **Performance:** Lean, predictable, small binaries; no unnecessary runtime. 4. **Performance:** Lean, predictable, small binaries; no unnecessary runtime.
@@ -41,7 +41,7 @@
- Resolve symbols dynamically. - Resolve symbols dynamically.
- Hot-swappable at runtime. - Hot-swappable at runtime.
- **Developer tools included:** metadata, logging/tracing, and dependency management. - **Developer tools included:** metadata, logging/tracing, and dependency management.
- Platform-agnostic (POSIX, Windows, retro/embedded targets with C89). - Platform-agnostic (POSIX, Windows).
### Phase 2: Optional WASM Support ### Phase 2: Optional WASM Support
- WASM modules as an alternative backend. - WASM modules as an alternative backend.
@@ -52,16 +52,15 @@
--- ---
## High-Level Roadmap Summary ## High-Level Roadmap Summary
| Phase | Focus | Core vs Optional | Target Hardware | | Phase | Focus | Core vs Optional |
|-------|-------|----------------|----------------| |-------|-------|----------------|
| 1 | Native modules + developer tools (metadata, logging, dependencies) | Core | Retro, embedded, POSIX, Windows | | 1 | Native modules + developer tools (metadata, logging, dependencies) | Core |
| 2 | WASM modules | Optional | Modern systems only | | 2 | WASM modules | Optional |
--- ---
## Strategic Benefits ## Strategic Benefits
- **Retro-ready:** Works on old consoles or embedded systems with minimal footprint.
- **Modern-friendly:** Developers can use modern languages without bloating the core. - **Modern-friendly:** Developers can use modern languages without bloating the core.
- **Modular foundation:** Build engines, games, or experimental projects on top. - **Modular foundation:** Build engines, games, or theoretically any type of project on top.
- **Scalable:** Hot-swappable modules, metadata, logging, and dependency tracking allow rapid iteration and predictable behavior. - **Scalable:** Hot-swappable modules, metadata, logging, and dependency tracking allow rapid iteration and predictable behavior.